eslint-doc-generator/dist/lib/options.js

Automatic documentation generator for ESLint plugins and rules.

import { join } from 'node:path';
import { COLUMN_TYPE, NOTICE_TYPE, OPTION_TYPE } from './types.js';
export const COLUMN_TYPE_DEFAULT_PRESENCE_AND_ORDERING = {
    // Object keys ordered in display order.
    // Object values indicate whether the column is displayed by default.
    [COLUMN_TYPE.NAME]: true,
    [COLUMN_TYPE.DESCRIPTION]: true,
    [COLUMN_TYPE.CONFIGS_ERROR]: true,
    [COLUMN_TYPE.CONFIGS_WARN]: true,
    [COLUMN_TYPE.CONFIGS_OFF]: true,
    [COLUMN_TYPE.FIXABLE]: true,
    [COLUMN_TYPE.FIXABLE_AND_HAS_SUGGESTIONS]: false, // Optional, consolidated column.
    [COLUMN_TYPE.HAS_SUGGESTIONS]: true,
    [COLUMN_TYPE.OPTIONS]: false,
    [COLUMN_TYPE.REQUIRES_TYPE_CHECKING]: true,
    [COLUMN_TYPE.TYPE]: false,
    [COLUMN_TYPE.DEPRECATED]: true,
};
export const NOTICE_TYPE_DEFAULT_PRESENCE_AND_ORDERING = {
    // Object keys ordered in display order.
    // Object values indicate whether the column is displayed by default.
    [NOTICE_TYPE.DEPRECATED]: true, // Most important.
    [NOTICE_TYPE.CONFIGS]: true,
    [NOTICE_TYPE.FIXABLE]: false,
    [NOTICE_TYPE.FIXABLE_AND_HAS_SUGGESTIONS]: true, // Default, consolidated notice.
    [NOTICE_TYPE.HAS_SUGGESTIONS]: false,
    [NOTICE_TYPE.OPTIONS]: false,
    [NOTICE_TYPE.REQUIRES_TYPE_CHECKING]: true,
    [NOTICE_TYPE.TYPE]: false,
    [NOTICE_TYPE.DESCRIPTION]: false,
};
// Using these variables ensures they have the correct type (not just a plain string).
const DEFAULT_RULE_DOC_TITLE_FORMAT = 'desc-parens-prefix-name';
const DEFAULT_CONFIG_FORMAT = 'name';
export const OPTION_DEFAULTS = {
    [OPTION_TYPE.CHECK]: false,
    [OPTION_TYPE.CONFIG_EMOJI]: [],
    [OPTION_TYPE.CONFIG_FORMAT]: DEFAULT_CONFIG_FORMAT,
    [OPTION_TYPE.IGNORE_CONFIG]: [],
    [OPTION_TYPE.IGNORE_DEPRECATED_RULES]: false,
    [OPTION_TYPE.INIT_RULE_DOCS]: false,
    [OPTION_TYPE.PATH_RULE_DOC]: join('docs', 'rules', '{name}.md'),
    [OPTION_TYPE.PATH_RULE_LIST]: ['README.md'],
    [OPTION_TYPE.POSTPROCESS]: (content) => content,
    [OPTION_TYPE.RULE_DOC_NOTICES]: Object.entries(NOTICE_TYPE_DEFAULT_PRESENCE_AND_ORDERING)
        .filter(([_col, enabled]) => enabled)
        .map(([col]) => col),
    [OPTION_TYPE.RULE_DOC_SECTION_EXCLUDE]: [],
    [OPTION_TYPE.RULE_DOC_SECTION_INCLUDE]: [],
    [OPTION_TYPE.RULE_DOC_SECTION_OPTIONS]: true,
    [OPTION_TYPE.RULE_DOC_TITLE_FORMAT]: DEFAULT_RULE_DOC_TITLE_FORMAT,
    [OPTION_TYPE.RULE_LIST_COLUMNS]: Object.entries(COLUMN_TYPE_DEFAULT_PRESENCE_AND_ORDERING)
        .filter(([_col, enabled]) => enabled)
        .map(([col]) => col),
    [OPTION_TYPE.RULE_LIST_SPLIT]: [],
    [OPTION_TYPE.URL_CONFIGS]: undefined,
    [OPTION_TYPE.URL_RULE_DOC]: undefined,
}; // Satisfies is used to ensure all options are included, but without losing type information.