Do not use module.parent for resolving rule name (#188)

sudo-suhas · sindresorhus · commit c5903fd52a0f · 2018-02-15T22:27:33.000+07:00
`module.parent` is cached after the first `require` and this results in nearly
all rules having the URL to `assertion-arguments`.
diff --git a/rules/assertion-arguments.js b/rules/assertion-arguments.js
@@ -150,7 +150,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl()
+			url: util.getDocsUrl(__filename)
 		},
 		schema
 	}
diff --git a/rules/assertion-message.js b/rules/assertion-message.js
@@ -68,7 +68,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl('assertion-message', '4211212daf1bfcfff3ebc5d4efdc4ba1a87acbf1')
+			url: util.getDocsUrl(__filename, '4211212daf1bfcfff3ebc5d4efdc4ba1a87acbf1')
 		},
 		schema,
 		deprecated: true
diff --git a/rules/max-asserts.js b/rules/max-asserts.js
@@ -62,7 +62,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl()
+			url: util.getDocsUrl(__filename)
 		},
 		schema
 	}
diff --git a/rules/no-async-fn-without-await.js b/rules/no-async-fn-without-await.js
@@ -51,7 +51,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl()
+			url: util.getDocsUrl(__filename)
 		}
 	}
 };
diff --git a/rules/no-cb-test.js b/rules/no-cb-test.js
@@ -25,7 +25,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl()
+			url: util.getDocsUrl(__filename)
 		}
 	}
 };
diff --git a/rules/no-duplicate-modifiers.js b/rules/no-duplicate-modifiers.js
@@ -46,7 +46,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl()
+			url: util.getDocsUrl(__filename)
 		}
 	}
 };
diff --git a/rules/no-identical-title.js b/rules/no-identical-title.js
@@ -63,7 +63,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl()
+			url: util.getDocsUrl(__filename)
 		}
 	}
 };
diff --git a/rules/no-ignored-test-files.js b/rules/no-ignored-test-files.js
@@ -103,7 +103,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl()
+			url: util.getDocsUrl(__filename)
 		},
 		schema
 	}
diff --git a/rules/no-invalid-end.js b/rules/no-invalid-end.js
@@ -27,7 +27,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl()
+			url: util.getDocsUrl(__filename)
 		}
 	}
 };
diff --git a/rules/no-nested-tests.js b/rules/no-nested-tests.js
@@ -34,7 +34,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl()
+			url: util.getDocsUrl(__filename)
 		}
 	}
 };
diff --git a/rules/no-only-test.js b/rules/no-only-test.js
@@ -33,7 +33,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl()
+			url: util.getDocsUrl(__filename)
 		},
 		fixable: 'code'
 	}
diff --git a/rules/no-skip-assert.js b/rules/no-skip-assert.js
@@ -26,7 +26,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl()
+			url: util.getDocsUrl(__filename)
 		}
 	}
 };
diff --git a/rules/no-skip-test.js b/rules/no-skip-test.js
@@ -33,7 +33,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl()
+			url: util.getDocsUrl(__filename)
 		},
 		fixable: 'code'
 	}
diff --git a/rules/no-statement-after-end.js b/rules/no-statement-after-end.js
@@ -94,7 +94,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl()
+			url: util.getDocsUrl(__filename)
 		}
 	}
 };
diff --git a/rules/no-todo-implementation.js b/rules/no-todo-implementation.js
@@ -25,7 +25,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl()
+			url: util.getDocsUrl(__filename)
 		}
 	}
 };
diff --git a/rules/no-todo-test.js b/rules/no-todo-test.js
@@ -25,7 +25,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl()
+			url: util.getDocsUrl(__filename)
 		}
 	}
 };
diff --git a/rules/no-unknown-modifiers.js b/rules/no-unknown-modifiers.js
@@ -44,7 +44,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl()
+			url: util.getDocsUrl(__filename)
 		}
 	}
 };
diff --git a/rules/prefer-async-await.js b/rules/prefer-async-await.js
@@ -52,7 +52,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl()
+			url: util.getDocsUrl(__filename)
 		}
 	}
 };
diff --git a/rules/prefer-power-assert.js b/rules/prefer-power-assert.js
@@ -82,7 +82,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl()
+			url: util.getDocsUrl(__filename)
 		}
 	}
 };
diff --git a/rules/test-ended.js b/rules/test-ended.js
@@ -44,7 +44,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl()
+			url: util.getDocsUrl(__filename)
 		}
 	}
 };
diff --git a/rules/test-title.js b/rules/test-title.js
@@ -44,7 +44,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl()
+			url: util.getDocsUrl(__filename)
 		},
 		schema
 	}
diff --git a/rules/use-t-well.js b/rules/use-t-well.js
@@ -106,7 +106,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl()
+			url: util.getDocsUrl(__filename)
 		}
 	}
 };
diff --git a/rules/use-t.js b/rules/use-t.js
@@ -36,7 +36,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl()
+			url: util.getDocsUrl(__filename)
 		}
 	}
 };
diff --git a/rules/use-test.js b/rules/use-test.js
@@ -41,7 +41,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl()
+			url: util.getDocsUrl(__filename)
 		}
 	}
 };
diff --git a/rules/use-true-false.js b/rules/use-true-false.js
@@ -88,7 +88,7 @@ module.exports = {
 	create,
 	meta: {
 		docs: {
-			url: util.getDocsUrl()
+			url: util.getDocsUrl(__filename)
 		}
 	}
 };
diff --git a/test/util.js b/test/util.js
@@ -4,15 +4,15 @@ import pkg from '../package';
 
 test('returns the URL of the a named rule\'s documentation', t => {
 	const url = `https://github.com/avajs/eslint-plugin-ava/blob/v${pkg.version}/docs/rules/foo.md`;
-	t.is(util.getDocsUrl('foo'), url);
+	t.is(util.getDocsUrl('foo.js'), url);
 });
 
 test('returns the URL of the a named rule\'s documentation at a commit hash', t => {
 	const url = 'https://github.com/avajs/eslint-plugin-ava/blob/bar/docs/rules/foo.md';
-	t.is(util.getDocsUrl('foo', 'bar'), url);
+	t.is(util.getDocsUrl('foo.js', 'bar'), url);
 });
 
 test('determines the rule name from the file', t => {
 	const url = `https://github.com/avajs/eslint-plugin-ava/blob/v${pkg.version}/docs/rules/util.md`;
-	t.is(util.getDocsUrl(), url);
+	t.is(util.getDocsUrl(__filename), url);
 });
diff --git a/util.js b/util.js
@@ -104,8 +104,8 @@ const repoUrl = 'https://github.com/avajs/eslint-plugin-ava';
  * @param  {String} ruleName The name of the rule to generate a URL for.
  * @return {String}          The URL of the rule's documentation.
  */
-const getDocsUrl = (ruleName, commitHash) => {
-	ruleName = ruleName || path.basename(module.parent.filename, '.js');
+const getDocsUrl = (filename, commitHash) => {
+	const ruleName = path.basename(filename, '.js');
 	commitHash = commitHash || `v${pkg.version}`;
 	return `${repoUrl}/blob/${commitHash}/docs/rules/${ruleName}.md`;
 };

Original file line number	Diff line number	Diff line change
`@@ -150,7 +150,7 @@ module.exports = {`
`150`	`150`	`create,`
`151`	`151`	`meta: {`
`152`	`152`	`docs: {`
`153`		`- url: util.getDocsUrl()`
	`153`	`+ url: util.getDocsUrl(__filename)`
`154`	`154`	`},`
`155`	`155`	`schema`
`156`	`156`	`}`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ module.exports = {`
`62`	`62`	`create,`
`63`	`63`	`meta: {`
`64`	`64`	`docs: {`
`65`		`- url: util.getDocsUrl()`
	`65`	`+ url: util.getDocsUrl(__filename)`
`66`	`66`	`},`
`67`	`67`	`schema`
`68`	`68`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ module.exports = {`
`51`	`51`	`create,`
`52`	`52`	`meta: {`
`53`	`53`	`docs: {`
`54`		`- url: util.getDocsUrl()`
	`54`	`+ url: util.getDocsUrl(__filename)`
`55`	`55`	`}`
`56`	`56`	`}`
`57`	`57`	`};`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ module.exports = {`
`25`	`25`	`create,`
`26`	`26`	`meta: {`
`27`	`27`	`docs: {`
`28`		`- url: util.getDocsUrl()`
	`28`	`+ url: util.getDocsUrl(__filename)`
`29`	`29`	`}`
`30`	`30`	`}`
`31`	`31`	`};`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ module.exports = {`
`46`	`46`	`create,`
`47`	`47`	`meta: {`
`48`	`48`	`docs: {`
`49`		`- url: util.getDocsUrl()`
	`49`	`+ url: util.getDocsUrl(__filename)`
`50`	`50`	`}`
`51`	`51`	`}`
`52`	`52`	`};`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ module.exports = {`
`63`	`63`	`create,`
`64`	`64`	`meta: {`
`65`	`65`	`docs: {`
`66`		`- url: util.getDocsUrl()`
	`66`	`+ url: util.getDocsUrl(__filename)`
`67`	`67`	`}`
`68`	`68`	`}`
`69`	`69`	`};`
Original file line number	Diff line number	Diff line change
`@@ -103,7 +103,7 @@ module.exports = {`
`103`	`103`	`create,`
`104`	`104`	`meta: {`
`105`	`105`	`docs: {`
`106`		`- url: util.getDocsUrl()`
	`106`	`+ url: util.getDocsUrl(__filename)`
`107`	`107`	`},`
`108`	`108`	`schema`
`109`	`109`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ module.exports = {`
`27`	`27`	`create,`
`28`	`28`	`meta: {`
`29`	`29`	`docs: {`
`30`		`- url: util.getDocsUrl()`
	`30`	`+ url: util.getDocsUrl(__filename)`
`31`	`31`	`}`
`32`	`32`	`}`
`33`	`33`	`};`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ module.exports = {`
`34`	`34`	`create,`
`35`	`35`	`meta: {`
`36`	`36`	`docs: {`
`37`		`- url: util.getDocsUrl()`
	`37`	`+ url: util.getDocsUrl(__filename)`
`38`	`38`	`}`
`39`	`39`	`}`
`40`	`40`	`};`