Add support for meta.url to enable links in terminal

[ybiquitous]

Which issue, if any, is this issue related to?

Closes #5842
Related to #5835 (comment)

Is there anything in the PR that needs further explanation?

This pull request adds the meta.url property to all built-in rules. For automation, I use a temporary script as below:

Run:

$ cd stylelint
$ node add-meta-to-stylelint-rules.js
...
$ npm run format

Script:

// add-meta-to-stylelint-rules.js
const fs = require('fs');
const globby = require('globby');

const files = globby.sync('lib/rules/*/index.js');

for (const file of files) {
	const content = fs.readFileSync(file).toString();

	const rule = file.replace(/lib\/rules\/([^/]+)\/index.js/, '$1');

	let newContent = content.replace(
		'module.exports = rule;',
		'rule.meta = meta;\nmodule.exports = rule;',
	);

	newContent = newContent.replace(
		/(const messages = ruleMessages\(.+?\);)/s,
		`$1

const meta = {
	url: 'https://stylelint.io/user-guide/rules/list/${rule}',
};`,
	);

	fs.writeFileSync(file, newContent);

	console.log(`${file} (${rule}) updated`); // eslint-disable-line no-console
}

[jeddy3]

LGTM, thanks.

(Nice script to automate it!)

[jeddy3]

@ybiquitous When you have a mo, can you resolve the conflicts and then we'll merge this and #5845.

[ybiquitous]

@jeddy3 Conflicts fixed!

[jeddy3]

LGTM, thanks!

[ybiquitous]

@jeddy3 Don't we need to add this change to CHANGELOG.md?

(EDIT: Please ignore this comment if no problems. I don't want to block any release progress 😃 )

[Reda011]

Hello, does Plugins support meta.url ?

I developed as Document(https://stylelint.io/developer-guide/plugins) said, but it doesn't work. Such as:

eg: I changed something from 'stylelint-z-index-value-constraint'(https://github.com/kristerkari/stylelint-z-index-value-constraint)

`
const stylelint = require("stylelint");

const ruleName = "plugin/z-index-value-constraint";

const messages = stylelint.utils.ruleMessages(ruleName, {
largerThanMax: expected =>
Expected z-index to have maximum value of ${expected}.,
smallerThanMin: expected =>
Expected z-index to have minimum value of ${expected}.
});

const meta = {
url: 'https://www.google.com/', // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Here it is !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
};

function isNumber(value) {
return typeof value === "number";
}

function isNegative(value) {
return value < 0;
}

const _isNaN =
Number.isNaN ||
function (value) {
return value !== value;
};

function possibleValueTest(value) {
return isNumber(value) && !isNegative(value);
}

module.exports = stylelint.createPlugin(
ruleName,
function (options, secondary) {
return function (cssRoot, result) {
const validOptions = stylelint.utils.validateOptions(
result,
ruleName,
{
actual: options,
possible: {
min: possibleValueTest,
max: possibleValueTest
}
},
{
actual: secondary,
possible: {
ignoreValues: [isNumber]
},
optional: true
}
);

  if (!validOptions) {
    return;
  }

  cssRoot.walkDecls("z-index", function (decl) {
    const value = Number(decl.value);

    if (
      _isNaN(value) ||
      (secondary &&
        Array.isArray(secondary.ignoreValues) &&
        secondary.ignoreValues.indexOf(value) > -1)
    ) {
      return;
    }

    if (options.max && Math.abs(value) > options.max) {
      stylelint.utils.report({
        ruleName,
        result,
        node: decl,
        message: messages.largerThanMax(
          isNegative(value) ? options.max * -1 : options.max
        )
      });
    }

    if (options.min && Math.abs(value) < options.min) {
      stylelint.utils.report({
        ruleName,
        result,
        node: decl,
        message: messages.smallerThanMin(
          isNegative(value) ? options.min * -1 : options.min
        )
      });
    }
  });
};

}
);

module.exports.ruleName = ruleName;
module.exports.messages = messages;
module.exports.meta = meta;

`

[ybiquitous]

@Reda011 Thanks for the comment. Maybe, it's a bug. I'll fix it soon, but I appreciate it if you would open an issue.

[Reda011]

@ybiquitous Ok, I have opened an issue：#6245