eslint-plugin-requirejs

Enforce code conventions for RequireJS modules with ESLint.

This plugin is under active development, and is updated frequently. Take a look at the CHANGELOG to see what's recently been added or fixed.

Installation

Install ESLint either locally or globally, and then install the plugin (see below). It is important to note that a global instance of ESLint can only use plugins that are also installed globally. A local instance of ESLint, however, can make use of both local and global ESLint plugins.

Global Installation

$ npm install -g eslint
$ npm install -g eslint-plugin-requirejs

Local Installation

$ npm install --save-dev eslint
$ npm install --save-dev 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

Possible Errors

• no-invalid-define: Disallow invalid module definitions
• no-invalid-require: Disallow invalid require or requirejs calls
• no-multiple-define: Disallow multiple module definitions in one file
• no-assign-exports: Disallow assignment to exports when using Simplified CommonJS Wrapper
• no-js-extension: Disallow .js extension in dependency paths

Stylistic Choices

• 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)
• no-commonjs-return: Disallow use of return statement in a module definition when using Simplified CommonJS Wrapper (off by default)
• no-commonjs-exports: Disallow use of exports in a module definition when using Simplified CommonJS Wrapper (off by default)
• no-commonjs-module-exports: Disallow use of module.exports in a module definition when using Simplified CommonJS Wrapper (off by default)
• no-dynamic-require: Disallow use of dynamically generated paths in a require call (off by default)
• no-conditional-require: Disallow use of conditional require calls (off by default)
• no-assign-require: Disallow assignment to require or window.require (off by default)
• no-require-tourl: Disallow use of require.toUrl and require.nameToUrl (off by default)
• enforce-define: Require that all files be wrapped in a define call (off by default)
• one-dependency-per-line: Enforce line-break rules for AMD dependencies (off by default)
• amd-function-arity: Ensure AMD callbacks have correct number of parameters (off by default)
• sort-amd-paths: Ensure that required paths are in alphabetical order (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.