web 3d图形渲染器
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

103 lines
4.2 KiB

  1. # babel-eslint [![npm](https://img.shields.io/npm/v/babel-eslint.svg)](https://www.npmjs.com/package/babel-eslint) [![travis](https://img.shields.io/travis/babel/babel-eslint/master.svg)](https://travis-ci.org/babel/babel-eslint) [![npm-downloads](https://img.shields.io/npm/dm/babel-eslint.svg)](https://www.npmjs.com/package/babel-eslint)
  2. **babel-eslint** allows you to lint **ALL** valid Babel code with the fantastic
  3. [ESLint](https://github.com/eslint/eslint).
  4. ### Why Use babel-eslint
  5. You only need to use babel-eslint if you are using types (Flow) or experimental features not supported in ESLint itself yet. Otherwise try the default parser (you don't have to use it just because you are using Babel).
  6. ---
  7. > If there is an issue, first check if it can be reproduced with the regular parser or with the latest versions of `eslint` and `babel-eslint`!
  8. For questions and support please visit the [`#discussion`](https://babeljs.slack.com/messages/discussion/) babel slack channel (sign up [here](https://github.com/babel/notes/issues/38)) or eslint [gitter](https://gitter.im/eslint/eslint)!
  9. > Note that the `ecmaFeatures` config property may still be required for ESLint to work properly with features not in ECMAScript 5 by default. Examples are `globalReturn` and `modules`).
  10. ## Known Issues
  11. Flow:
  12. > Check out [eslint-plugin-flowtype](https://github.com/gajus/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`.
  13. - `no-undef` for global flow types: `ReactElement`, `ReactClass` [#130](https://github.com/babel/babel-eslint/issues/130#issuecomment-111215076)
  14. - Workaround: define types as globals in `.eslintrc` or define types and import them `import type ReactElement from './types'`
  15. - `no-unused-vars/no-undef` with Flow declarations (`declare module A {}`) [#132](https://github.com/babel/babel-eslint/issues/132#issuecomment-112815926)
  16. Modules/strict mode
  17. - `no-unused-vars: [2, {vars: local}]` [#136](https://github.com/babel/babel-eslint/issues/136)
  18. Please check out [eslint-plugin-react](https://github.com/yannickcr/eslint-plugin-react) for React/JSX issues
  19. - `no-unused-vars` with jsx
  20. Please check out [eslint-plugin-babel](https://github.com/babel/eslint-plugin-babel) for other issues
  21. ## How does it work?
  22. ESLint allows custom parsers. This is great but some of the syntax nodes that Babel supports
  23. aren't supported by ESLint. When using this plugin, ESLint is monkeypatched and your code is
  24. transformed into code that ESLint can understand. All location info such as line numbers,
  25. columns is also retained so you can track down errors with ease.
  26. Basically `babel-eslint` exports an [`index.js`](/index.js) that a linter can use.
  27. It just needs to export a `parse` method that takes in a string of code and outputs an AST.
  28. ## Usage
  29. ### Supported ESLint versions
  30. ESLint | babel-eslint
  31. ------------ | -------------
  32. 4.x | >= 6.x
  33. 3.x | >= 6.x
  34. 2.x | >= 6.x
  35. 1.x | >= 5.x
  36. ### Install
  37. Ensure that you have substituted the correct version lock for `eslint` and `babel-eslint` into this command:
  38. ```sh
  39. $ npm install eslint@4.x babel-eslint@8 --save-dev
  40. # or
  41. $ yarn add eslint@4.x babel-eslint@8 -D
  42. ```
  43. ### Setup
  44. **.eslintrc**
  45. ```json
  46. {
  47. "parser": "babel-eslint",
  48. "rules": {
  49. "strict": 0
  50. }
  51. }
  52. ```
  53. Check out the [ESLint docs](http://eslint.org/docs/rules/) for all possible rules.
  54. ### Configuration
  55. - `sourceType` can be set to `'module'`(default) or `'script'` if your code isn't using ECMAScript modules.
  56. - `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.
  57. - `codeFrame` (default `true`) can be set to `false` to disable the code frame in the reporter. This is useful since some eslint formatters don't play well with it.
  58. **.eslintrc**
  59. ```json
  60. {
  61. "parser": "babel-eslint",
  62. "parserOptions": {
  63. "sourceType": "module",
  64. "allowImportExportEverywhere": false,
  65. "codeFrame": true
  66. }
  67. }
  68. ```
  69. ### Run
  70. ```sh
  71. $ eslint your-files-here
  72. ```