Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add URL to rule documentation to the metadata #208

Merged
merged 1 commit into from
May 14, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion lib/rules/alias-model-in-controller.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ module.exports = {
docs: {
description: 'Enforces aliasing model in controller',
category: 'Best Practices',
recommended: false
recommended: false,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/alias-model-in-controller.md'
},
fixable: null, // or "code" or "whitespace"
},
Expand Down
1 change: 1 addition & 0 deletions lib/rules/avoid-leaking-state-in-components.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ module.exports = {
category: 'Possible Errors',
recommended: false,
replacedBy: ['avoid-leaking-state-in-ember-objects'],
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/avoid-leaking-state-in-components.md'
},
fixable: null, // or "code" or "whitespace"
deprecated: true,
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/avoid-leaking-state-in-ember-objects.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ module.exports = {
docs: {
description: 'Avoids state leakage',
category: 'Ember Object',
recommended: true
recommended: true,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/avoid-leaking-state-in-ember-objects.md'
},
fixable: null, // or "code" or "whitespace"
schema: [{
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/closure-actions.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ module.exports = {
docs: {
description: 'Enforces usage of closure actions',
category: 'Best Practices',
recommended: true
recommended: true,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/closure-actions.md'
},
fixable: null, // or "code" or "whitespace"
},
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/jquery-ember-run.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ module.exports = {
docs: {
description: 'Prevents usage of jQuery without Ember Run Loop',
category: 'Possible Errors',
recommended: true
recommended: true,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/jquery-ember-run.md'
},
fixable: null, // or "code" or "whitespace"
},
Expand Down
1 change: 1 addition & 0 deletions lib/rules/local-modules.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ module.exports = {
category: 'Best Practices',
recommended: false,
replacedBy: ['new-module-imports'],
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/local-modules.md'
},
deprecated: true,
fixable: null, // or "code" or "whitespace"
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/named-functions-in-promises.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ module.exports = {
docs: {
description: 'Enforces usage of named functions in promises',
category: 'Best Practices',
recommended: false
recommended: false,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/named-functions-in-promises.md'
},
fixable: null, // or "code" or "whitespace"
},
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/new-module-imports.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ module.exports = {
docs: {
description: ' Use "New Module Imports" from Ember RFC #176',
category: 'Best Practices',
recommended: true
recommended: true,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/new-module-imports.md'
},
},

Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-attrs-in-components.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ module.exports = {
docs: {
description: 'Disallow usage of this.attrs in components',
category: 'Possible Errors',
recommended: true
recommended: true,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/no-attrs-in-components.md'
},
fixable: null,
},
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-attrs-snapshot.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ module.exports = {
docs: {
description: 'Disallow use of attrs snapshot in `didReceiveAttrs` and `didUpdateAttrs`',
category: 'Possible Errors',
recommended: true
recommended: true,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/no-attrs-snapshot.md'
},
fixable: null, // or "code" or "whitespace"
message
Expand Down
1 change: 1 addition & 0 deletions lib/rules/no-capital-letters-in-routes.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ module.exports = {
description: 'Raise an error when there is a route with uppercased letters in router.js',
category: 'Possible Errors',
recommended: true,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/no-capital-letters-in-routes.md'
},
fixable: null, // or "code" or "whitespace"
schema: [],
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-duplicate-dependent-keys.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ module.exports = {
docs: {
description: 'Disallow repeating dependent keys',
category: 'Possible Errors',
recommended: true
recommended: true,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/no-duplicate-dependent-keys.md'
},
fixable: null,
message: MESSAGE,
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-empty-attrs.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ module.exports = {
docs: {
description: 'Prevents usage of empty attributes in ember data models',
category: 'Best Practices',
recommended: false
recommended: false,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/no-empty-attrs.md'
},
fixable: null, // or "code" or "whitespace"
},
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-function-prototype-extensions.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ module.exports = {
docs: {
description: 'Prevents usage of Ember\'s `function` prototype extensions',
category: 'Best Practices',
recommended: true
recommended: true,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/no-function-prototype-extensions.md'
},
fixable: null, // or "code" or "whitespace"
},
Expand Down
1 change: 1 addition & 0 deletions lib/rules/no-global-jquery.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ module.exports = {
description: 'Prevents usage of global jQuery object',
category: 'Best Practices',
recommended: true,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/no-global-jquery.md'
},
fixable: null, // or "code" or "whitespace"
message: MESSAGE,
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-jquery.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ module.exports = {
docs: {
description: 'Disallow any usage of jQuery',
category: 'Best Practices',
recommended: false
recommended: false,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/no-jquery.md'
},
fixable: null, // or "code" or "whitespace"
message
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-observers.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ module.exports = {
docs: {
description: 'Prevents usage of observers',
category: 'Best Practices',
recommended: false
recommended: false,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/no-observers.md'
},
fixable: null, // or "code" or "whitespace"
},
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-old-shims.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ module.exports = {
docs: {
description: 'Prevents usage of old shims for modules',
category: 'Best Practices',
recommended: true
recommended: true,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/no-old-shims.md'
},
fixable: 'code',
},
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-on-calls-in-components.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ module.exports = {
docs: {
description: 'Prevents usage of `on` calls in components',
category: 'Best Practices',
recommended: true
recommended: true,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/no-on-calls-in-components.md'
},
fixable: null, // or "code" or "whitespace"
},
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-side-effects.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ module.exports = {
docs: {
description: 'Warns about unexpected side effects in computed properties',
category: 'Possible Errors',
recommended: true
recommended: true,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/no-side-effects.md'
},
fixable: null, // or "code" or "whitespace"
},
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/order-in-components.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ module.exports = {
docs: {
description: 'Enforces proper order of properties in components',
category: 'Stylistic Issues',
recommended: false
recommended: false,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/order-in-components.md'
},
fixable: null // or "code" or "whitespace"
},
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/order-in-controllers.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ module.exports = {
docs: {
description: 'Enforces proper order of properties in controllers',
category: 'Stylistic Issues',
recommended: false
recommended: false,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/order-in-controllers.md'
},
fixable: null, // or "code" or "whitespace"
},
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/order-in-models.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ module.exports = {
docs: {
description: 'Enforces proper order of properties in models',
category: 'Stylistic Issues',
recommended: false
recommended: false,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/order-in-models.md'
},
fixable: null, // or "code" or "whitespace"
},
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/order-in-routes.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ module.exports = {
docs: {
description: 'Enforces proper order of properties in routes',
category: 'Stylistic Issues',
recommended: false
recommended: false,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/order-in-routes.md'
},
fixable: null // or "code" or "whitespace"
},
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/require-super-in-init.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ module.exports = {
docs: {
description: 'Enforces super calls in init hooks',
category: 'Possible Errors',
recommended: true
recommended: true,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/require-super-in-init.md'
},
fixable: null, // or "code" or "whitespace"
},
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/routes-segments-snake-case.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ module.exports = {
docs: {
description: 'Enforces usage of snake_cased dynamic segments in routes',
category: 'Possible Errors',
recommended: true
recommended: true,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/routes-segments-snake-case.md'
},
fixable: null, // or "code" or "whitespace"
},
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/use-brace-expansion.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ module.exports = {
docs: {
description: 'Enforces usage of brace expansion',
category: 'Stylistic Issues',
recommended: true
recommended: true,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/use-brace-expansion.md'
},
fixable: null, // or "code" or "whitespace"
},
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/use-ember-get-and-set.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ module.exports = {
docs: {
description: 'Enforces usage of Ember.get and Ember.set',
category: 'Best Practices',
recommended: false
recommended: false,
url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/use-ember-get-and-set.md'
},
fixable: 'code',
},
Expand Down