Skip to content
This repository has been archived by the owner on Jun 6, 2019. It is now read-only.

Commit

Permalink
Add URL to rule documentation to the metadata
Browse files Browse the repository at this point in the history
ESLint v4.15.0 added an official location for rules to store a URL to
their documentation in the rule metadata in eslint/eslint#9788. This
adds the URL to all the existing rules so anything consuming them can
know where their documentation is without having to resort to external
packages to guess.
  • Loading branch information
Arcanemagus committed Feb 12, 2018
1 parent 13fd496 commit 8757d3c
Show file tree
Hide file tree
Showing 17 changed files with 34 additions and 17 deletions.
3 changes: 2 additions & 1 deletion rules/no-arguments.js
Expand Up @@ -36,7 +36,8 @@ module.exports = {
meta: {
docs: {
description: 'Forbid the use of `arguments`.',
recommended: 'error'
recommended: 'error',
url: 'https://github.com/jfmengels/eslint-plugin-fp/tree/master/docs/rules/no-arguments.md'
}
}
};
3 changes: 2 additions & 1 deletion rules/no-class.js
Expand Up @@ -16,7 +16,8 @@ module.exports = {
meta: {
docs: {
description: 'Forbid the use of `class`.',
recommended: 'error'
recommended: 'error',
url: 'https://github.com/jfmengels/eslint-plugin-fp/tree/master/docs/rules/no-class.md'
}
}
};
3 changes: 2 additions & 1 deletion rules/no-delete.js
Expand Up @@ -18,7 +18,8 @@ module.exports = {
meta: {
docs: {
description: 'Forbid the use of `delete`.',
recommended: 'error'
recommended: 'error',
url: 'https://github.com/jfmengels/eslint-plugin-fp/tree/master/docs/rules/no-delete.md'
}
}
};
3 changes: 2 additions & 1 deletion rules/no-events.js
Expand Up @@ -29,7 +29,8 @@ module.exports = {
meta: {
docs: {
description: 'Forbid the use of the `events` module.',
recommended: 'error'
recommended: 'error',
url: 'https://github.com/jfmengels/eslint-plugin-fp/tree/master/docs/rules/no-events.md'
}
}
};
3 changes: 2 additions & 1 deletion rules/no-get-set.js
Expand Up @@ -50,7 +50,8 @@ module.exports = {
meta: {
docs: {
description: 'Forbid the use of getters and setters.',
recommended: 'error'
recommended: 'error',
url: 'https://github.com/jfmengels/eslint-plugin-fp/tree/master/docs/rules/no-get-set.md'
}
}
};
3 changes: 2 additions & 1 deletion rules/no-let.js
Expand Up @@ -18,7 +18,8 @@ module.exports = {
meta: {
docs: {
description: 'Forbid the use of `let`.',
recommended: 'error'
recommended: 'error',
url: 'https://github.com/jfmengels/eslint-plugin-fp/tree/master/docs/rules/no-let.md'
}
}
};
3 changes: 2 additions & 1 deletion rules/no-loops.js
Expand Up @@ -30,7 +30,8 @@ module.exports = {
meta: {
docs: {
description: 'Forbid the use of loops.',
recommended: 'error'
recommended: 'error',
url: 'https://github.com/jfmengels/eslint-plugin-fp/tree/master/docs/rules/no-loops.md'
}
}
};
3 changes: 2 additions & 1 deletion rules/no-mutating-assign.js
Expand Up @@ -46,7 +46,8 @@ module.exports = {
meta: {
docs: {
description: 'Forbid the use of [`Object.assign()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign) with a variable as first argument.',
recommended: 'error'
recommended: 'error',
url: 'https://github.com/jfmengels/eslint-plugin-fp/tree/master/docs/rules/no-mutating-assign.md'
}
}
};
3 changes: 2 additions & 1 deletion rules/no-mutating-methods.js
Expand Up @@ -85,7 +85,8 @@ module.exports = {
meta: {
docs: {
description: 'Forbid the use of mutating methods.',
recommended: 'error'
recommended: 'error',
url: 'https://github.com/jfmengels/eslint-plugin-fp/tree/master/docs/rules/no-mutating-methods.md'
}
}
};
3 changes: 2 additions & 1 deletion rules/no-mutation.js
Expand Up @@ -124,7 +124,8 @@ module.exports = {
schema,
docs: {
description: 'Forbid the use of mutating operators.',
recommended: 'error'
recommended: 'error',
url: 'https://github.com/jfmengels/eslint-plugin-fp/tree/master/docs/rules/no-mutation.md'
}
}
};
3 changes: 2 additions & 1 deletion rules/no-nil.js
Expand Up @@ -73,7 +73,8 @@ module.exports = {
meta: {
docs: {
description: 'Forbid the use of `null` and `undefined`.',
recommended: 'error'
recommended: 'error',
url: 'https://github.com/jfmengels/eslint-plugin-fp/tree/master/docs/rules/no-nil.md'
}
}
};
3 changes: 2 additions & 1 deletion rules/no-proxy.js
Expand Up @@ -18,7 +18,8 @@ module.exports = {
meta: {
docs: {
description: 'Forbid the use of `Proxy`.',
recommended: 'error'
recommended: 'error',
url: 'https://github.com/jfmengels/eslint-plugin-fp/tree/master/docs/rules/no-proxy.md'
}
}
};
3 changes: 2 additions & 1 deletion rules/no-rest-parameters.js
Expand Up @@ -16,7 +16,8 @@ module.exports = {
meta: {
docs: {
description: 'Forbid the use of rest parameters.',
recommended: 'error'
recommended: 'error',
url: 'https://github.com/jfmengels/eslint-plugin-fp/tree/master/docs/rules/no-rest-parameters.md'
}
}
};
3 changes: 2 additions & 1 deletion rules/no-this.js
Expand Up @@ -16,7 +16,8 @@ module.exports = {
meta: {
docs: {
description: 'Forbid the use of `this`.',
recommended: 'error'
recommended: 'error',
url: 'https://github.com/jfmengels/eslint-plugin-fp/tree/master/docs/rules/no-this.md'
}
}
};
3 changes: 2 additions & 1 deletion rules/no-throw.js
Expand Up @@ -16,7 +16,8 @@ module.exports = {
meta: {
docs: {
description: 'Forbid the use of `throw`.',
recommended: 'error'
recommended: 'error',
url: 'https://github.com/jfmengels/eslint-plugin-fp/tree/master/docs/rules/no-throw.md'
}
}
};
3 changes: 2 additions & 1 deletion rules/no-unused-expression.js
Expand Up @@ -55,7 +55,8 @@ module.exports = {
meta: {
docs: {
description: 'Enforce that an expression gets used.',
recommended: 'error'
recommended: 'error',
url: 'https://github.com/jfmengels/eslint-plugin-fp/tree/master/docs/rules/no-unused-expression.md'
}
}
};
3 changes: 2 additions & 1 deletion rules/no-valueof-field.js
Expand Up @@ -35,7 +35,8 @@ module.exports = {
meta: {
docs: {
description: 'Forbid the creation of `valueOf` fields.',
recommended: 'error'
recommended: 'error',
url: 'https://github.com/jfmengels/eslint-plugin-fp/tree/master/docs/rules/no-valueof-field.md'
}
}
};

0 comments on commit 8757d3c

Please sign in to comment.