eslint-plugin-requirejs

Enforce code conventions for RequireJS modules with ESLint

Installation

Install ESLint either locally or globally.

$ npm install eslint

If you installed ESLint globally, you have to install the RequireJS plugin globally too. Otherwise, install it locally.

$ npm install eslint-plugin-requirejs

Configuration

Add the plugins section to your config file if not already present and specify eslint-plugin-requirejs as a plugin. The eslint-plugin- prefix may be omitted:

{
  "plugins": [
    "requirejs"
  ]
}

Enable the rules that you would like to use, for example:

{
  "rules": {
    "requirejs/no-invalid-define": 2,
    "requirejs/no-multiple-define": 2,
    "requirejs/no-named-define": 2,
    "requirejs/no-commonjs-wrapper": 2,
    "requirejs/no-object-define": 1
  }
}

List of supported rules

• no-invalid-define: Disallow invalid module definitions
• no-multiple-define: Disallow multiple module definitions in one file
• no-object-define: Disallow Simple Name/Value Pairs form of define (off by default)
• no-function-define: Disallow Simple Function form of define (off by default)
• no-amd-define: Disallow AMD (dependency array) form of define (off by default)
• no-named-define: Disallow named module form of define (off by default)
• no-commonjs-wrapper: Disallow use of Simplified CommonJS Wrapper (off by default)

Don't see the rule you're looking for?

Take a look at what's in progress for the next milestone, or suggest a new rule by filing an issue.

Contributing

Contributions are encouraged. There are a few ways you can help:

• Filing issues - if you find a bug or would like to request a new rule or enhancement, file an issue
• Submitting pull requests - pick one of the open issues to work on and submit a pull request

License

eslint-plugin-requirejs is licensed under the MIT License.