Add support for meta.url to enable links in terminal (#5845)

docs/developer-guide/plugins.md

@@ -9,6 +9,7 @@ We recommend your plugin adheres to [Stylelint's conventions](rules.md) for:
 - messages
 - tests
 - docs
+- metadata
 
 ## The anatomy of a plugin
 
@@ -20,6 +21,10 @@ const ruleName = "plugin/foo-bar";
 const messages = stylelint.utils.ruleMessages(ruleName, {
   expected: "Expected ..."
 });
+const meta = {
+  url: "https://github.com/foo-org/stylelint-foo/blob/main/src/rules/foo-bar/README.md"
+  // deprecated: true,
+};
 
 module.exports = stylelint.createPlugin(
   ruleName,
@@ -47,6 +52,7 @@ module.exports = stylelint.createPlugin(
 
 module.exports.ruleName = ruleName;
 module.exports.messages = messages;
+module.exports.meta = meta;
 ```
 
 Your plugin's rule name must be namespaced, e.g. `your-namespace/your-rule-name`, to ensure it never clashes with the built-in rules. If your plugin provides only a single rule or you can't think of a good namespace, you can use `plugin/my-rule`. _You should document your plugin's rule name (and namespace) because users need to use them in their config._
@@ -79,6 +85,9 @@ const ruleName = "plugin/foo-bar-async";
 const messages = stylelint.utils.ruleMessages(ruleName, {
   expected: "Expected ..."
 });
+const meta = {
+  /* .. */
+};
 
 module.exports = stylelint.createPlugin(
   ruleName,
@@ -112,6 +121,7 @@ module.exports = stylelint.createPlugin(
 
 module.exports.ruleName = ruleName;
 module.exports.messages = messages;
+module.exports.meta = meta;
 ```
 
 ## Testing

docs/developer-guide/rules.md

@@ -195,7 +195,7 @@ You should:
 Deprecating rules doesn't happen very often. When you do, you must:
 
 1. Point the `stylelintReference` link to the specific version of the rule README on the GitHub website, so that it is always accessible.
-2. Add the appropriate meta data to mark the rule as deprecated.
+2. Add the appropriate metadata to mark the rule as deprecated like `rule.meta = { deprecated: true }`.
 
 ## Improve the performance of a rule
 

lib/rules/__tests__/index.test.js

@@ -0,0 +1,12 @@
+'use strict';
+
+const rules = require('..');
+
+describe('rules', () => {
+	for (const [ruleName, rule] of Object.entries(rules)) {
+		test(`the "${ruleName}" rule has metadata`, () => {
+			expect(rule.meta).toBeTruthy();
+			expect(rule.meta.url).toMatch(/^https:\/\/stylelint\.io\/.+/);
+		});
+	}
+});

lib/rules/alpha-value-notation/index.js

@@ -18,6 +18,10 @@ const messages = ruleMessages(ruleName, {
 	expected: (unfixed, fixed) => `Expected "${unfixed}" to be "${fixed}"`,
 });
 
+const meta = {
+	url: 'https://stylelint.io/user-guide/rules/list/alpha-value-notation',
+};
+
 const ALPHA_PROPS = new Set(['opacity', 'shape-image-threshold']);
 const ALPHA_FUNCS = new Set(['hsl', 'hsla', 'hwb', 'lab', 'lch', 'rgb', 'rgba']);
 
@@ -193,4 +197,5 @@ function isNumber(value) {
 
 rule.ruleName = ruleName;
 rule.messages = messages;
+rule.meta = meta;
 module.exports = rule;

lib/rules/at-rule-allowed-list/index.js

@@ -13,6 +13,10 @@ const messages = ruleMessages(ruleName, {
 	rejected: (name) => `Unexpected at-rule "${name}"`,
 });
 
+const meta = {
+	url: 'https://stylelint.io/user-guide/rules/list/at-rule-allowed-list',
+};
+
 /** @type {import('stylelint').Rule} */
 const rule = (primary) => {
 	// To allow for just a string as a parameter (not only arrays of strings)
@@ -56,4 +60,5 @@ rule.primaryOptionArray = true;
 
 rule.ruleName = ruleName;
 rule.messages = messages;
+rule.meta = meta;
 module.exports = rule;

lib/rules/at-rule-disallowed-list/index.js

@@ -13,6 +13,10 @@ const messages = ruleMessages(ruleName, {
 	rejected: (name) => `Unexpected at-rule "${name}"`,
 });
 
+const meta = {
+	url: 'https://stylelint.io/user-guide/rules/list/at-rule-disallowed-list',
+};
+
 /** @type {import('stylelint').Rule} */
 const rule = (primary) => {
 	// To allow for just a string as a parameter (not only arrays of strings)
@@ -56,4 +60,5 @@ rule.primaryOptionArray = true;
 
 rule.ruleName = ruleName;
 rule.messages = messages;
+rule.meta = meta;
 module.exports = rule;

lib/rules/at-rule-empty-line-before/index.js

@@ -23,6 +23,10 @@ const messages = ruleMessages(ruleName, {
 	rejected: 'Unexpected empty line before at-rule',
 });
 
+const meta = {
+	url: 'https://stylelint.io/user-guide/rules/list/at-rule-empty-line-before',
+};
+
 /** @type {import('stylelint').Rule} */
 const rule = (primary, secondaryOptions, context) => {
 	return (root, result) => {
@@ -164,4 +168,5 @@ function isAtRuleAfterSameNameAtRule(atRule) {
 
 rule.ruleName = ruleName;
 rule.messages = messages;
+rule.meta = meta;
 module.exports = rule;

lib/rules/at-rule-name-case/index.js

@@ -11,6 +11,10 @@ const messages = ruleMessages(ruleName, {
 	expected: (actual, expected) => `Expected "${actual}" to be "${expected}"`,
 });
 
+const meta = {
+	url: 'https://stylelint.io/user-guide/rules/list/at-rule-name-case',
+};
+
 /** @type {import('stylelint').Rule} */
 const rule = (primary, _secondary, context) => {
 	return (root, result) => {
@@ -57,4 +61,5 @@ const rule = (primary, _secondary, context) => {
 
 rule.ruleName = ruleName;
 rule.messages = messages;
+rule.meta = meta;
 module.exports = rule;

lib/rules/at-rule-name-newline-after/index.js

@@ -11,6 +11,10 @@ const messages = ruleMessages(ruleName, {
 	expectedAfter: (name) => `Expected newline after at-rule name "${name}"`,
 });
 
+const meta = {
+	url: 'https://stylelint.io/user-guide/rules/list/at-rule-name-newline-after',
+};
+
 /** @type {import('stylelint').Rule} */
 const rule = (primary) => {
 	const checker = whitespaceChecker('newline', primary, messages);
@@ -36,4 +40,5 @@ const rule = (primary) => {
 
 rule.ruleName = ruleName;
 rule.messages = messages;
+rule.meta = meta;
 module.exports = rule;

lib/rules/at-rule-name-space-after/index.js

@@ -11,6 +11,10 @@ const messages = ruleMessages(ruleName, {
 	expectedAfter: (name) => `Expected single space after at-rule name "${name}"`,
 });
 
+const meta = {
+	url: 'https://stylelint.io/user-guide/rules/list/at-rule-name-space-after',
+};
+
 /** @type {import('stylelint').Rule} */
 const rule = (primary, _secondary, context) => {
 	const checker = whitespaceChecker('space', primary, messages);
@@ -43,4 +47,5 @@ const rule = (primary, _secondary, context) => {
 
 rule.ruleName = ruleName;
 rule.messages = messages;
+rule.meta = meta;
 module.exports = rule;

lib/rules/at-rule-no-unknown/index.js

@@ -15,6 +15,10 @@ const messages = ruleMessages(ruleName, {
 	rejected: (atRule) => `Unexpected unknown at-rule "${atRule}"`,
 });
 
+const meta = {
+	url: 'https://stylelint.io/user-guide/rules/list/at-rule-no-unknown',
+};
+
 /** @type {import('stylelint').Rule} */
 const rule = (primary, secondaryOptions) => {
 	return (root, result) => {
@@ -63,4 +67,5 @@ const rule = (primary, secondaryOptions) => {
 
 rule.ruleName = ruleName;
 rule.messages = messages;
+rule.meta = meta;
 module.exports = rule;

lib/rules/at-rule-no-vendor-prefix/index.js

@@ -12,6 +12,10 @@ const messages = ruleMessages(ruleName, {
 	rejected: (p) => `Unexpected vendor-prefixed at-rule "@${p}"`,
 });
 
+const meta = {
+	url: 'https://stylelint.io/user-guide/rules/list/at-rule-no-vendor-prefix',
+};
+
 /** @type {import('stylelint').Rule} */
 const rule = (primary, _secondary, context) => {
 	return (root, result) => {
@@ -54,4 +58,5 @@ const rule = (primary, _secondary, context) => {
 
 rule.ruleName = ruleName;
 rule.messages = messages;
+rule.meta = meta;
 module.exports = rule;

lib/rules/at-rule-property-required-list/index.js

@@ -12,6 +12,10 @@ const messages = ruleMessages(ruleName, {
 	expected: (property, atRule) => `Expected property "${property}" for at-rule "${atRule}"`,
 });
 
+const meta = {
+	url: 'https://stylelint.io/user-guide/rules/list/at-rule-property-required-list',
+};
+
 /** @type {import('stylelint').Rule} */
 const rule = (primary) => {
 	return (root, result) => {
@@ -64,5 +68,5 @@ const rule = (primary) => {
 
 rule.ruleName = ruleName;
 rule.messages = messages;
-
+rule.meta = meta;
 module.exports = rule;

lib/rules/at-rule-semicolon-newline-after/index.js

@@ -15,6 +15,10 @@ const messages = ruleMessages(ruleName, {
 	expectedAfter: () => 'Expected newline after ";"',
 });
 
+const meta = {
+	url: 'https://stylelint.io/user-guide/rules/list/at-rule-semicolon-newline-after',
+};
+
 /** @type {import('stylelint').Rule} */
 const rule = (primary, _secondary, context) => {
 	const checker = whitespaceChecker('newline', primary, messages);
@@ -74,4 +78,5 @@ const rule = (primary, _secondary, context) => {
 
 rule.ruleName = ruleName;
 rule.messages = messages;
+rule.meta = meta;
 module.exports = rule;

lib/rules/at-rule-semicolon-space-before/index.js

@@ -15,6 +15,10 @@ const messages = ruleMessages(ruleName, {
 	rejectedBefore: () => 'Unexpected whitespace before ";"',
 });
 
+const meta = {
+	url: 'https://stylelint.io/user-guide/rules/list/at-rule-semicolon-space-before',
+};
+
 /** @type {import('stylelint').Rule} */
 const rule = (primary) => {
 	const checker = whitespaceChecker('space', primary, messages);
@@ -59,4 +63,5 @@ const rule = (primary) => {
 
 rule.ruleName = ruleName;
 rule.messages = messages;
+rule.meta = meta;
 module.exports = rule;

lib/rules/block-closing-brace-empty-line-before/index.js

@@ -19,6 +19,10 @@ const messages = ruleMessages(ruleName, {
 	rejected: 'Unexpected empty line before closing brace',
 });
 
+const meta = {
+	url: 'https://stylelint.io/user-guide/rules/list/block-closing-brace-empty-line-before',
+};
+
 /** @type {import('stylelint').Rule} */
 const rule = (primary, secondaryOptions, context) => {
 	return (root, result) => {
@@ -119,4 +123,5 @@ const rule = (primary, secondaryOptions, context) => {
 
 rule.ruleName = ruleName;
 rule.messages = messages;
+rule.meta = meta;
 module.exports = rule;

lib/rules/block-closing-brace-newline-after/index.js

@@ -20,6 +20,10 @@ const messages = ruleMessages(ruleName, {
 	rejectedAfterMultiLine: () => 'Unexpected whitespace after "}" of a multi-line block',
 });
 
+const meta = {
+	url: 'https://stylelint.io/user-guide/rules/list/block-closing-brace-newline-after',
+};
+
 /** @type {import('stylelint').Rule} */
 const rule = (primary, secondaryOptions, context) => {
 	const checker = whitespaceChecker('newline', primary, messages);
@@ -142,4 +146,5 @@ const rule = (primary, secondaryOptions, context) => {
 
 rule.ruleName = ruleName;
 rule.messages = messages;
+rule.meta = meta;
 module.exports = rule;

lib/rules/block-closing-brace-newline-before/index.js

@@ -16,6 +16,10 @@ const messages = ruleMessages(ruleName, {
 	rejectedBeforeMultiLine: 'Unexpected whitespace before "}" of a multi-line block',
 });
 
+const meta = {
+	url: 'https://stylelint.io/user-guide/rules/list/block-closing-brace-newline-before',
+};
+
 /** @type {import('stylelint').Rule} */
 const rule = (primary, _secondaryOptions, context) => {
 	return (root, result) => {
@@ -122,4 +126,5 @@ const rule = (primary, _secondaryOptions, context) => {
 
 rule.ruleName = ruleName;
 rule.messages = messages;
+rule.meta = meta;
 module.exports = rule;

lib/rules/block-closing-brace-space-after/index.js

@@ -19,6 +19,10 @@ const messages = ruleMessages(ruleName, {
 	rejectedAfterMultiLine: () => 'Unexpected whitespace after "}" of a multi-line block',
 });
 
+const meta = {
+	url: 'https://stylelint.io/user-guide/rules/list/block-closing-brace-space-after',
+};
+
 /** @type {import('stylelint').Rule} */
 const rule = (primary) => {
 	const checker = whitespaceChecker('space', primary, messages);
@@ -87,4 +91,5 @@ const rule = (primary) => {
 
 rule.ruleName = ruleName;
 rule.messages = messages;
+rule.meta = meta;
 module.exports = rule;

lib/rules/block-closing-brace-space-before/index.js

@@ -19,6 +19,10 @@ const messages = ruleMessages(ruleName, {
 	rejectedBeforeMultiLine: () => 'Unexpected whitespace before "}" of a multi-line block',
 });
 
+const meta = {
+	url: 'https://stylelint.io/user-guide/rules/list/block-closing-brace-space-before',
+};
+
 /** @type {import('stylelint').Rule} */
 const rule = (primary, _secondaryOptions, context) => {
 	const checker = whitespaceChecker('space', primary, messages);
@@ -99,4 +103,5 @@ const rule = (primary, _secondaryOptions, context) => {
 
 rule.ruleName = ruleName;
 rule.messages = messages;
+rule.meta = meta;
 module.exports = rule;

lib/rules/block-no-empty/index.js

@@ -15,6 +15,10 @@ const messages = ruleMessages(ruleName, {
 	rejected: 'Unexpected empty block',
 });
 
+const meta = {
+	url: 'https://stylelint.io/user-guide/rules/list/block-no-empty',
+};
+
 /** @type {import('stylelint').Rule} */
 const rule = (primary, secondaryOptions) => {
 	return (root, result) => {
@@ -82,4 +86,5 @@ const rule = (primary, secondaryOptions) => {
 
 rule.ruleName = ruleName;
 rule.messages = messages;
+rule.meta = meta;
 module.exports = rule;

lib/rules/block-opening-brace-newline-after/index.js

@@ -19,6 +19,10 @@ const messages = ruleMessages(ruleName, {
 	rejectedAfterMultiLine: () => 'Unexpected whitespace after "{" of a multi-line block',
 });
 
+const meta = {
+	url: 'https://stylelint.io/user-guide/rules/list/block-opening-brace-newline-after',
+};
+
 /** @type {import('stylelint').Rule} */
 const rule = (primary, secondaryOptions, context) => {
 	const checker = whitespaceChecker('newline', primary, messages);
@@ -172,4 +176,5 @@ const rule = (primary, secondaryOptions, context) => {
 
 rule.ruleName = ruleName;
 rule.messages = messages;
+rule.meta = meta;
 module.exports = rule;