eslint-doc-generator
Version:
Automatic documentation generator for ESLint plugins and rules.
26 lines (25 loc) • 1.24 kB
JavaScript
/**
* Enum version of this union type: TSESLint.RuleMetaData<''>['type'];
*/
export var RULE_TYPE;
(function (RULE_TYPE) {
RULE_TYPE["problem"] = "problem";
RULE_TYPE["suggestion"] = "suggestion";
RULE_TYPE["layout"] = "layout";
})(RULE_TYPE || (RULE_TYPE = {}));
export const RULE_TYPES = ['problem', 'suggestion', 'layout'];
export const EMOJIS_TYPE = {
[RULE_TYPE.problem]: '❗',
[RULE_TYPE.suggestion]: '📖',
[RULE_TYPE.layout]: '📏',
};
export const RULE_TYPE_MESSAGES_LEGEND = {
[RULE_TYPE.problem]: `${EMOJIS_TYPE[RULE_TYPE.problem]} Identifies problems that could cause errors or unexpected behavior.`,
[RULE_TYPE.suggestion]: `${EMOJIS_TYPE[RULE_TYPE.suggestion]} Identifies potential improvements.`,
[RULE_TYPE.layout]: `${EMOJIS_TYPE[RULE_TYPE.layout]} Focuses on code formatting.`,
};
export const RULE_TYPE_MESSAGES_NOTICES = {
[RULE_TYPE.problem]: `${EMOJIS_TYPE[RULE_TYPE.problem]} This rule identifies problems that could cause errors or unexpected behavior.`,
[RULE_TYPE.suggestion]: `${EMOJIS_TYPE[RULE_TYPE.suggestion]} This rule identifies potential improvements.`,
[RULE_TYPE.layout]: `${EMOJIS_TYPE[RULE_TYPE.layout]} This rule focuses on code formatting.`,
};