Skip to content

Commit 3c3290a

Browse files
author
Casey Visco
authored
Docs: Add indicator for fixable rules
1 parent df166ed commit 3c3290a

File tree

1 file changed

+35
-25
lines changed

1 file changed

+35
-25
lines changed

‎README.md‎

Lines changed: 35 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -65,36 +65,46 @@ This plugin provides the `plugin:requirejs/recommended` preset config. Which doe
6565

6666
## List of supported rules
6767

68+
No rules are enabled by default. The `"extends": "plugin:requirejs/recommended"` property in a configuration file enables the marked with a :star:.
69+
70+
The `--fix` option on the command line automatically fixes problems reported by rules marked by a :wrench:.
71+
72+
73+
6874
### Possible Errors
6975

70-
| | Rule | Description |
71-
| :----: | :--- | :---------- |
72-
| :star: | [no-invalid-define](docs/rules/no-invalid-define.md) | Disallow invalid module definitions |
73-
| :star: | [no-invalid-require](docs/rules/no-invalid-require.md) | Disallow invalid `require` or `requirejs` calls |
74-
| :star: | [no-multiple-define](docs/rules/no-multiple-define.md) | Disallow multiple module definitions in one file |
75-
| :star: | [no-assign-exports](docs/rules/no-assign-exports.md) | Disallow assignment to `exports` when using Simplified CommonJS Wrapper |
76-
| :star: | [no-js-extension](docs/rules/no-js-extension.md) | Disallow `.js` extension in dependency paths |
76+
These rules relate to possible syntax or logic errors in your module definition:
77+
78+
| | | Rule | Description |
79+
| :----: | :------: | :--- | :---------- |
80+
| :star: | | [no-invalid-define](docs/rules/no-invalid-define.md) | Disallow invalid module definitions |
81+
| :star: | | [no-invalid-require](docs/rules/no-invalid-require.md) | Disallow invalid `require` or `requirejs` calls |
82+
| :star: | | [no-multiple-define](docs/rules/no-multiple-define.md) | Disallow multiple module definitions in one file |
83+
| :star: | | [no-assign-exports](docs/rules/no-assign-exports.md) | Disallow assignment to `exports` when using Simplified CommonJS Wrapper |
84+
| :star: | | [no-js-extension](docs/rules/no-js-extension.md) | Disallow `.js` extension in dependency paths |
7785

7886
### Stylistic Choices
7987

80-
| | Rule | Description |
81-
| :----: | :--- | :---------- |
82-
| | [no-object-define](docs/rules/no-object-define.md) | Disallow Simple Name/Value Pairs form of `define` |
83-
| | [no-function-define](docs/rules/no-function-define.md) | Disallow Simple Function form of `define` |
84-
| | [no-amd-define](docs/rules/no-amd-define.md) | Disallow AMD (dependency array) form of `define` |
85-
| | [no-named-define](docs/rules/no-named-define.md) | Disallow named module form of `define` |
86-
| | [no-commonjs-wrapper](docs/rules/no-commonjs-wrapper.md) | Disallow use of Simplified CommonJS Wrapper |
87-
| | [no-commonjs-return](docs/rules/no-commonjs-return.md) | Disallow use of `return` statement in a module definition when using Simplified CommonJS Wrapper |
88-
| | [no-commonjs-exports](docs/rules/no-commonjs-exports.md) | Disallow use of `exports` in a module definition when using Simplified CommonJS Wrapper |
89-
| | [no-commonjs-module-exports](docs/rules/no-commonjs-module-exports.md) | Disallow use of `module.exports` in a module definition when using Simplified CommonJS Wrapper |
90-
| | [no-dynamic-require](docs/rules/no-dynamic-require.md) | Disallow use of dynamically generated paths in a `require` call |
91-
| | [no-conditional-require](docs/rules/no-conditional-require.md) | Disallow use of conditional `require` calls |
92-
| | [no-assign-require](docs/rules/no-assign-require.md) | Disallow assignment to `require` or `window.require` |
93-
| | [no-require-tourl](docs/rules/no-require-tourl.md) | Disallow use of `require.toUrl` and `require.nameToUrl` |
94-
| | [enforce-define](docs/rules/enforce-define.md) | Require that all files be wrapped in a `define` call |
95-
| | [one-dependency-per-line](docs/rules/one-dependency-per-line.md) | Enforce line-break rules for AMD dependencies |
96-
| | [amd-function-arity](docs/rules/amd-function-arity.md) | Ensure AMD callbacks have correct number of parameters |
97-
| | [sort-amd-paths](docs/rules/sort-amd-paths.md) | Ensure that required paths are in alphabetical order |
88+
These rules relate to style guidelines, and are therefore quite subjective:
89+
90+
| | | Rule | Description |
91+
| :----: | :------: | :--- | :---------- |
92+
| | | [no-object-define](docs/rules/no-object-define.md) | Disallow Simple Name/Value Pairs form of `define` |
93+
| | | [no-function-define](docs/rules/no-function-define.md) | Disallow Simple Function form of `define` |
94+
| | | [no-amd-define](docs/rules/no-amd-define.md) | Disallow AMD (dependency array) form of `define` |
95+
| | | [no-named-define](docs/rules/no-named-define.md) | Disallow named module form of `define` |
96+
| | | [no-commonjs-wrapper](docs/rules/no-commonjs-wrapper.md) | Disallow use of Simplified CommonJS Wrapper |
97+
| | | [no-commonjs-return](docs/rules/no-commonjs-return.md) | Disallow use of `return` statement in a module definition when using Simplified CommonJS Wrapper |
98+
| | | [no-commonjs-exports](docs/rules/no-commonjs-exports.md) | Disallow use of `exports` in a module definition when using Simplified CommonJS Wrapper |
99+
| | | [no-commonjs-module-exports](docs/rules/no-commonjs-module-exports.md) | Disallow use of `module.exports` in a module definition when using Simplified CommonJS Wrapper |
100+
| | | [no-dynamic-require](docs/rules/no-dynamic-require.md) | Disallow use of dynamically generated paths in a `require` call |
101+
| | | [no-conditional-require](docs/rules/no-conditional-require.md) | Disallow use of conditional `require` calls |
102+
| | | [no-assign-require](docs/rules/no-assign-require.md) | Disallow assignment to `require` or `window.require` |
103+
| | | [no-require-tourl](docs/rules/no-require-tourl.md) | Disallow use of `require.toUrl` and `require.nameToUrl` |
104+
| | | [enforce-define](docs/rules/enforce-define.md) | Require that all files be wrapped in a `define` call |
105+
| | :wrench: | [one-dependency-per-line](docs/rules/one-dependency-per-line.md) | Enforce line-break rules for AMD dependencies |
106+
| | | [amd-function-arity](docs/rules/amd-function-arity.md) | Ensure AMD callbacks have correct number of parameters |
107+
| | | [sort-amd-paths](docs/rules/sort-amd-paths.md) | Ensure that required paths are in alphabetical order |
98108

99109
### Don't see the rule you're looking for?
100110

0 commit comments

Comments
 (0)