Add URL to rule documentation to the metadata

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.
Arcanemagus · Jan 8, 2018 · 2b54364 · 2b54364
1 parent 6ac1598
commit 2b54364
Show file tree

Hide file tree

Showing 25 changed files with 111 additions and 18 deletions.
diff --git a/rules/assertion-arguments.js b/rules/assertion-arguments.js
@@ -149,6 +149,9 @@ const schema = [{
 module.exports = {
 	create,
 	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/assertion-arguments.md'
+		},
 		schema
 	}
 };
diff --git a/rules/assertion-message.js b/rules/assertion-message.js
@@ -67,6 +67,9 @@ const schema = [{
 module.exports = {
 	create,
 	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/assertion-message.md'
+		},
 		schema,
 		deprecated: true
 	}

diff --git a/rules/max-asserts.js b/rules/max-asserts.js
@@ -61,6 +61,9 @@ const schema = [{
 module.exports = {
 	create,
 	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/max-asserts.md'
+		},
 		schema
 	}
 };
diff --git a/rules/no-async-fn-without-await.js b/rules/no-async-fn-without-await.js
@@ -48,5 +48,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/no-async-fn-without-await.md'
+		}
+	}
 };
diff --git a/rules/no-cb-test.js b/rules/no-cb-test.js
@@ -23,5 +23,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/no-cb-test.md'
+		}
+	}
 };
diff --git a/rules/no-duplicate-modifiers.js b/rules/no-duplicate-modifiers.js
@@ -44,5 +44,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/no-duplicate-modifiers.md'
+		}
+	}
 };
diff --git a/rules/no-identical-title.js b/rules/no-identical-title.js
@@ -61,5 +61,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/no-identical-title.md'
+		}
+	}
 };
diff --git a/rules/no-ignored-test-files.js b/rules/no-ignored-test-files.js
@@ -102,6 +102,9 @@ const schema = [{
 module.exports = {
 	create,
 	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/no-ignored-test-files.md'
+		},
 		schema
 	}
 };
diff --git a/rules/no-invalid-end.js b/rules/no-invalid-end.js
@@ -25,5 +25,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/no-invalid-end.md'
+		}
+	}
 };
diff --git a/rules/no-nested-tests.js b/rules/no-nested-tests.js
@@ -31,5 +31,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/no-nested-tests.md'
+		}
+	}
 };
diff --git a/rules/no-only-test.js b/rules/no-only-test.js
@@ -32,6 +32,9 @@ const create = context => {
 module.exports = {
 	create,
 	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/no-only-test.md'
+		},
 		fixable: 'code'
 	}
 };
diff --git a/rules/no-skip-assert.js b/rules/no-skip-assert.js
@@ -24,5 +24,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/no-skip-assert.md'
+		}
+	}
 };
diff --git a/rules/no-skip-test.js b/rules/no-skip-test.js
@@ -32,6 +32,9 @@ const create = context => {
 module.exports = {
 	create,
 	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/no-skip-test.md'
+		},
 		fixable: 'code'
 	}
 };
diff --git a/rules/no-statement-after-end.js b/rules/no-statement-after-end.js
@@ -91,5 +91,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/no-statement-after-end.md'
+		}
+	}
 };
diff --git a/rules/no-todo-implementation.js b/rules/no-todo-implementation.js
@@ -23,5 +23,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/no-todo-implementation.md'
+		}
+	}
 };
diff --git a/rules/no-todo-test.js b/rules/no-todo-test.js
@@ -22,5 +22,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/no-todo-test.md'
+		}
+	}
 };
diff --git a/rules/no-unknown-modifiers.js b/rules/no-unknown-modifiers.js
@@ -42,5 +42,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/no-unknown-modifiers.md'
+		}
+	}
 };
diff --git a/rules/prefer-async-await.js b/rules/prefer-async-await.js
@@ -49,5 +49,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/prefer-async-await.md'
+		}
+	}
 };
diff --git a/rules/prefer-power-assert.js b/rules/prefer-power-assert.js
@@ -79,5 +79,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/prefer-power-assert.md'
+		}
+	}
 };
diff --git a/rules/test-ended.js b/rules/test-ended.js
@@ -41,5 +41,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/test-ended.md'
+		}
+	}
 };
diff --git a/rules/test-title.js b/rules/test-title.js
@@ -42,6 +42,9 @@ const schema = [{
 module.exports = {
 	create,
 	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/test-title.md'
+		},
 		schema
 	}
 };
diff --git a/rules/use-t-well.js b/rules/use-t-well.js
@@ -104,5 +104,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/use-t-well.md'
+		}
+	}
 };
diff --git a/rules/use-t.js b/rules/use-t.js
@@ -33,5 +33,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/use-t.md'
+		}
+	}
 };
diff --git a/rules/use-test.js b/rules/use-test.js
@@ -38,5 +38,9 @@ const create = context => ({
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/use-test.md'
+		}
+	}
 };
diff --git a/rules/use-true-false.js b/rules/use-true-false.js
@@ -86,5 +86,9 @@ const create = context => {
 
 module.exports = {
 	create,
-	meta: {}
+	meta: {
+		docs: {
+			url: 'https://github.com/avajs/eslint-plugin-ava/tree/master/docs/rules/use-true-false.md'
+		}
+	}
 };