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

Automatic documentation generator for ESLint plugins and rules.

import traverse from 'json-schema-traverse';
import { capitalizeOnlyFirstLetter } from './string.js';
function typeToString(type) {
    return Array.isArray(type)
        ? type.map((item) => capitalizeOnlyFirstLetter(item)).join(', ')
        : capitalizeOnlyFirstLetter(type);
}
/**
 * Gather a list of named options from a rule schema.
 * @param jsonSchema - the JSON schema to check
 * @returns - list of named options we could detect from the schema
 */
export function getAllNamedOptions(jsonSchema) {
    if (!jsonSchema) {
        return [];
    }
    if (Array.isArray(jsonSchema)) {
        return jsonSchema.flatMap((js) => getAllNamedOptions(js));
    }
    const options = [];
    // Cast needed because json-schema-traverse types don't account for exactOptionalPropertyTypes
    traverse(jsonSchema, (js) => {
        if (js.properties) {
            for (const [key, value] of Object.entries(js.properties)) {
                const type = value.type === 'array' &&
                    !Array.isArray(value.items) &&
                    value.items?.type
                    ? `${Array.isArray(value.items.type) && value.items.type.length > 1
                        ? `(${typeToString(value.items.type)})`
                        : typeToString(value.items.type)}[]`
                    : value.type
                        ? typeToString(value.type)
                        : undefined;
                const required = typeof value.required === 'boolean'
                    ? value.required
                    : Array.isArray(js.required) && js.required.includes(key);
                // Property exists on future JSONSchema version but we can let it be used anyway.
                const deprecated = 'deprecated' in value ? Boolean(value['deprecated']) : false;
                const option = {
                    name: key,
                    ...(type !== undefined && { type }),
                    ...(value.description !== undefined && {
                        description: value.description,
                    }),
                    ...(value.default !== undefined && { default: value.default }),
                    ...(value.enum !== undefined && { enum: value.enum }),
                    ...(required && { required }),
                    ...(deprecated && { deprecated }),
                };
                options.push(option);
            }
        }
    });
    return options;
}
/**
 * Check if a rule schema is non-blank/empty and thus has actual options.
 * @param jsonSchema - the JSON schema to check
 * @returns - whether the schema has options
 */
export function hasOptions(jsonSchema) {
    return ((Array.isArray(jsonSchema) && jsonSchema.length > 0) ||
        (typeof jsonSchema === 'object' && Object.keys(jsonSchema).length > 0));
}