babel/babel-eslint


tokyo_tower A wrapper for Babel's parser used for ESLint

https://github.com/babel/babel-eslint/issues/88

License: MIT

Language: JavaScript

Keywords: babel, babel-eslint, eslint, javascript


babel-eslint npm travis npm-downloads

babel-eslint allows you to lint ALL valid Babel code with the fantastic ESLint.

Breaking change in v11.x.x

As of the v11.x.x release, babel-eslint now requires Babel as a peer dependency and expects a valid Babel configuration file to exist. This ensures that the same Babel configuration is used during both linting and compilation.

When should I use babel-eslint?

ESLint's default parser and core rules only support the latest final ECMAScript standard and do not support experimental (such as new features) and non-standard (such as Flow or TypeScript types) syntax provided by Babel. babel-eslint is a parser that allows ESLint to run on source code that is transformed by Babel.

Note: You only need to use babel-eslint if you are using Babel to transform your code. If this is not the case, please use the relevant parser for your chosen flavor of ECMAScript (note that the default parser supports all non-experimental syntax as well as JSX).

How does it work?

ESLint allows for the use of custom parsers. When using this plugin, your code is parsed by Babel's parser (using the configuration specified in your Babel configuration file) and the resulting AST is transformed into an ESTree-compliant structure that ESLint can understand. All location info such as line numbers, columns is also retained so you can track down errors with ease.

Note: ESLint's core rules do not support experimental syntax and may therefore not work as expected when using babel-eslint. Please use the companion eslint-plugin-babel plugin for core rules that you have issues with.

Usage

Installation

$ npm install eslint babel-eslint --save-dev
# or
$ yarn add eslint babel-eslint -D

Note: babel-eslint requires babel/core@>=7.2.0 and a valid Babel configuration file to run. If you do not have this already set up, please see the Babel Usage Guide.

Setup

To use babel-eslint, "babel-eslint" must be specified as the parser in your ESLint configuration file (see here for more detailed information).

.eslintrc.js

module.exports = {
  parser: "babel-eslint",
};

With the parser set, your configuration can be configured as described in the Configuring ESLint documentation.

Note: The parserOptions described in the official documentation are for the default parser and are not necessarily supported by babel-eslint. Please see the section directly below for supported parserOptions.

Additional parser configuration

Additional configuration options can be set in your ESLint configuration under the parserOptions key. Please note that the ecmaFeatures config property may still be required for ESLint to work properly with features not in ECMAScript 5 by default.

  • requireConfigFile (default true) can be set to false to allow babel-eslint to run on files that do not have a Babel configuration associated with them. This can be useful for linting files that are not transformed by Babel (such as tooling configuration files), though we recommend using the default parser via glob-based configuration. Note: babel-eslint will not parse any experimental syntax when no configuration file is found.
  • sourceType can be set to "module"(default) or "script" if your code isn't using ECMAScript modules.
  • allowImportExportEverywhere (default false) can be set to true to allow import and export declarations to appear anywhere a statement is allowed if your build environment supports that. Otherwise import and export declarations can only appear at a program's top level.
  • ecmaFeatures.globalReturn (default false) allow return statements in the global scope when used with sourceType: "script".
  • babelOptions passes through Babel's configuration loading and merging options (for instance, in case of a monorepo). When not defined, babel-eslint will use Babel's default configuration file resolution logic.

.eslintrc.js

module.exports = {
  parser: "babel-eslint",
  parserOptions: {
    sourceType: "module",
    allowImportExportEverywhere: false,
    ecmaFeatures: {
      globalReturn: false,
    },
    babelOptions: {
      configFile: "path/to/config.js",
    },
  },
};

.eslintrc.js using glob-based configuration

This configuration would use the default parser for all files except for those found by the "files/transformed/by/babel/*.js" glob.

module.exports = {
  rules: {
    indent: "error"
  },
  overrides: [
    {
      files: ["files/transformed/by/babel/*.js"],
      parser: "babel-eslint",
    }
  ]
};

Run

$ ./node_modules/.bin/eslint yourfile.js

Known issues

Flow:

Check out eslint-plugin-flowtype: An eslint plugin that makes flow type annotations global variables and marks declarations as used. Solves the problem of false positives with no-undef and no-unused-vars.

  • no-undef for global flow types: ReactElement, ReactClass #130
    • Workaround: define types as globals in .eslintrc or define types and import them import type ReactElement from './types'
  • no-unused-vars/no-undef with Flow declarations (declare module A {}) #132

Modules/strict mode

  • no-unused-vars: ["error", { vars: local }] #136

Please check out eslint-plugin-react for React/JSX issues.

  • no-unused-vars with jsx

Please check out eslint-plugin-babel for other issues.

Questions and support

If you have an issue, please first check if it can be reproduced with the default parser and with the latest versions of eslint and babel-eslint. If it is not reproducible with the default parser, it is most likely an issue with babel-eslint.

For questions and support please visit the #discussion Babel Slack channel (sign up here) or the ESLint Gitter.

Project Statistics

Sourcerank 23
Repository Size 945 KB
Stars 2,742
Forks 200
Watchers 55
Open issues 99
Dependencies 538
Contributors 63
Tags 114
Created
Last updated
Last pushed

Top Contributors See all

Henry Zhu Sebastian Andres Suarez Kai Cataldo Brian Ng Toru Nagashima Benoît Zugmeyer greenkeeper[bot] Rubén Norte Greenkeeper Rafał Ruciński Joshua Peek dependabot[bot] Logan Smyth Kir Belevich Reyad Attiyat Teddy Katz Brian Donovan Luís Couto Jordan Gensler

Packages Referencing this Repo

@alexjeffburke/babel-eslint
Custom parser for ESLint
Latest release 7.2.2-patch1 - Published - 2.74K stars
babel-to-estree
Translate a Babel AST to an ESTree-compliant AST. A "fork" of babel-eslint/babylon-to-espree.
Latest release 0.0.3 - Updated - 2.74K stars
babel-eslint
Custom parser for ESLint
Latest release 11.0.0-beta.0 - Updated - 2.74K stars
@gerhobbelt/babel-eslint
Custom parser for ESLint
Latest release 9.0.0-3 - Updated - 2.74K stars
babel-eslint-fork
Custom parser for ESLint
Latest release 11.0.0-beta.2 - Updated - 2.74K stars
org.webjars.npm:babel-eslint
WebJar for babel-eslint
Latest release 7.2.3 - Updated - 2.74K stars
@airdwing/babel-eslint
Custom parser for ESLint
Latest release 8.0.0-alpha.17 - Published - 2.74K stars

Recent Tags See all

v10.0.3 August 25, 2019
v10.0.2 June 17, 2019
v11.0.0-beta.0 January 21, 2019
v10.0.1 September 27, 2018
v10.0.0 September 25, 2018
v9.0.0 August 27, 2018
v8.2.6 July 12, 2018
v9.0.0-beta.3 July 12, 2018
v9.0.0-beta.2 July 06, 2018
v9.0.0-beta.1 June 29, 2018
v8.2.5 June 23, 2018
v8.2.4 June 22, 2018
v8.2.3 April 13, 2018
v8.2.2 February 20, 2018
v8.2.1 January 09, 2018

Interesting Forks See all

niilante/babel-eslint
tokyo_tower ESLint using Babel as the parser.
JavaScript - Updated - 1 stars
tmcw/babel-eslint
ESLint using Babel as the parser.
JavaScript - Updated - 1 stars

Something wrong with this page? Make a suggestion

Last synced: 2019-09-10 08:06:59 UTC

Login to resync this repository