Skip to content
This repository has been archived by the owner on May 3, 2018. 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 Jan 8, 2018
1 parent f09706a commit b6d058c
Show file tree
Hide file tree
Showing 21 changed files with 42 additions and 21 deletions.
3 changes: 2 additions & 1 deletion lib/rules/amd-function-arity.js
Expand Up @@ -22,7 +22,8 @@ const isRequireCall = rjs.isRequireCall;
const docs = {
description: "Ensure AMD-style callbacks contain correct number of arguments",
category: "Stylistic Choices",
recommended: false
recommended: false,
url: "https://github.com/cvisco/eslint-plugin-requirejs/blob/master/docs/rules/amd-function-arity.md"
};

const schema = [
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/enforce-define.js
Expand Up @@ -20,7 +20,8 @@ const basename = path.basename;
const docs = {
description: "Disallow files that are not wrapped in a call to `define`",
category: "Stylistic Choices",
recommended: false
recommended: false,
url: "https://github.com/cvisco/eslint-plugin-requirejs/blob/master/docs/rules/enforce-define.md"
};

const schema = [
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-amd-define.js
Expand Up @@ -16,7 +16,8 @@ const isAmdDefine = rjs.isAmdDefine;
const docs = {
description: "Disallow use of AMD (dependency array) form of `define`",
category: "Stylistic Choices",
recommended: false
recommended: false,
url: "https://github.com/cvisco/eslint-plugin-requirejs/blob/master/docs/rules/no-amd-define.md"
};

const schema = [];
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-assign-exports.js
Expand Up @@ -19,7 +19,8 @@ const isCommonJsWrapper = rjs.isCommonJsWrapper;
const docs = {
description: "Disallow assignment to `exports` when using Simplified CommonJS Wrapper",
category: "Possible Errors",
recommended: true
recommended: true,
url: "https://github.com/cvisco/eslint-plugin-requirejs/blob/master/docs/rules/no-assign-exports.md"
};

const schema = [];
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-assign-require.js
Expand Up @@ -17,7 +17,8 @@ const isMemberExpr = ast.isMemberExpr;
const docs = {
description: "Disallow assignment to `require` or `window.require`",
category: "Stylistic Choices",
recommended: false
recommended: false,
url: "https://github.com/cvisco/eslint-plugin-requirejs/blob/master/docs/rules/no-assign-require.md"
};

const schema = [];
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-commonjs-exports.js
Expand Up @@ -20,7 +20,8 @@ const isCommonJsWrapper = rjs.isCommonJsWrapper;
const docs = {
description: "Disallow use of `exports` in a module definition when using Simplified CommonJS Wrapper",
category: "Stylistic Choices",
recommended: true
recommended: true,
url: "https://github.com/cvisco/eslint-plugin-requirejs/blob/master/docs/rules/no-commonjs-exports.md"
};

const schema = [];
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-commonjs-module-exports.js
Expand Up @@ -20,7 +20,8 @@ const isCommonJsWrapper = rjs.isCommonJsWrapper;
const docs = {
description: "Disallow use of `module.exports` in a module definition when using Simplified CommonJS Wrapper",
category: "Stylistic Choices",
recommended: true
recommended: true,
url: "https://github.com/cvisco/eslint-plugin-requirejs/blob/master/docs/rules/no-commonjs-module-exports.md"
};

const schema = [];
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-commonjs-return.js
Expand Up @@ -19,7 +19,8 @@ const isCommonJsWrapper = rjs.isCommonJsWrapper;
const docs = {
description: "Disallow use of `return` statement in a module definition when",
category: "Stylistic Choices",
recommended: true
recommended: true,
url: "https://github.com/cvisco/eslint-plugin-requirejs/blob/master/docs/rules/no-commonjs-return.md"
};

const schema = [];
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-commonjs-wrapper.js
Expand Up @@ -16,7 +16,8 @@ const isCommonJsWrapper = rjs.isCommonJsWrapper;
const docs = {
description: "Disallow use of Simplified CommonJS Wrapper form of `define`",
category: "Stylistic Choices",
recommended: true
recommended: true,
url: "https://github.com/cvisco/eslint-plugin-requirejs/blob/master/docs/rules/no-commonjs-wrapper.md"
};

const schema = [];
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-conditional-require.js
Expand Up @@ -18,7 +18,8 @@ const isRequireCall = rjs.isRequireCall;
const docs = {
description: "Disallow use of conditional `require` calls",
category: "Stylistic Choices",
recommended: true
recommended: true,
url: "https://github.com/cvisco/eslint-plugin-requirejs/blob/master/docs/rules/no-conditional-require.md"
};

const schema = [];
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-dynamic-require.js
Expand Up @@ -19,7 +19,8 @@ const isStringLiteralArray = ast.isStringLiteralArray;
const docs = {
description: "Disallow use of dynamically generated paths in a require call",
category: "Stylistic Choices",
recommended: false
recommended: false,
url: "https://github.com/cvisco/eslint-plugin-requirejs/blob/master/docs/rules/no-dynamic-require.md"
};

const schema = [];
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-function-define.js
Expand Up @@ -16,7 +16,8 @@ const isFunctionDefine = rjs.isFunctionDefine;
const docs = {
description: "Disallow use of simple function form of `define`",
category: "Stylistic Choices",
recommended: false
recommended: false,
url: "https://github.com/cvisco/eslint-plugin-requirejs/blob/master/docs/rules/no-function-define.md"
};

const schema = [];
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-invalid-define.js
Expand Up @@ -17,7 +17,8 @@ const isValidDefine = rjs.isValidDefine;
const docs = {
description: "Disallow invalid or undesired forms of `define`",
category: "Possible Errors",
recommended: true
recommended: true,
url: "https://github.com/cvisco/eslint-plugin-requirejs/blob/master/docs/rules/no-invalid-define.md"
};

const schema = [];
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-invalid-require.js
Expand Up @@ -17,7 +17,8 @@ const isValidRequire = rjs.isValidRequire;
const docs = {
description: "Disallow invalid or undesired forms of `require`",
category: "Possible Errors",
recommended: true
recommended: true,
url: "https://github.com/cvisco/eslint-plugin-requirejs/blob/master/docs/rules/no-invalid-require.md"
};

const schema = [];
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-js-extension.js
Expand Up @@ -17,7 +17,8 @@ const getDependencyStringNodes = rjs.getDependencyStringNodes;
const docs = {
description: "Disallow `.js` extension in dependency paths",
category: "Possible Errors",
recommended: true
recommended: true,
url: "https://github.com/cvisco/eslint-plugin-requirejs/blob/master/docs/rules/no-js-extension.md"
};

const schema = [
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-multiple-define.js
Expand Up @@ -16,7 +16,8 @@ const isDefineCall = rjs.isDefineCall;
const docs = {
description: "Disallow multiple `define` calls in a single file",
category: "Stylistic Choices",
recommended: false
recommended: false,
url: "https://github.com/cvisco/eslint-plugin-requirejs/blob/master/docs/rules/no-multiple-define.md"
};

const schema = [];
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-named-define.js
Expand Up @@ -16,7 +16,8 @@ const isNamedDefine = rjs.isNamedDefine;
const docs = {
description: "Disallow use of named module form of `define`",
category: "Stylistic Choices",
recommended: false
recommended: false,
url: "https://github.com/cvisco/eslint-plugin-requirejs/blob/master/docs/rules/no-named-define.md"
};

const schema = [];
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-object-define.js
Expand Up @@ -16,7 +16,8 @@ const isObjectDefine = rjs.isObjectDefine;
const docs = {
description: "Disallow use of Simple Name/Value Pairs form of `define`",
category: "Stylistic Choices",
recommended: false
recommended: false,
url: "https://github.com/cvisco/eslint-plugin-requirejs/blob/master/docs/rules/no-object-define.md"
};

const schema = [];
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/no-require-tourl.js
Expand Up @@ -19,7 +19,8 @@ const isRequireIdentifier = rjs.isRequireIdentifier;
const docs = {
description: "Disallow use of `require.toUrl` and `require.nameToUrl`",
category: "Stylistic Choices",
recommended: false
recommended: false,
url: "https://github.com/cvisco/eslint-plugin-requirejs/blob/master/docs/rules/no-require-tourl.md"
};

const schema = [];
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/one-dependency-per-line.js
Expand Up @@ -20,7 +20,8 @@ const isFunctionExpr = ast.isFunctionExpr;
const docs = {
description: "Require or disallow one dependency per line",
category: "Stylistic Choices",
recommended: false
recommended: false,
url: "https://github.com/cvisco/eslint-plugin-requirejs/blob/master/docs/rules/one-dependency-per-line.md"
};

const schema = [
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/sort-amd-paths.js
Expand Up @@ -20,7 +20,8 @@ const getDependencyStringNodes = rjs.getDependencyStringNodes;
const docs = {
description: "Ensure that required paths are ordered alphabetically",
category: "Stylistic Choices",
recommended: false
recommended: false,
url: "https://github.com/cvisco/eslint-plugin-requirejs/blob/master/docs/rules/sort-amd-paths.md"
};

const schema = [
Expand Down

0 comments on commit b6d058c

Please sign in to comment.