@terrazzo/parser/dist/lint/plugin-core/rules/descriptions.js

Parser/validator for the Design Tokens Community Group (DTCG) standard.

import { isTokenMatch } from '@terrazzo/token-tools';
import { docsLink } from '../lib/docs.js';
export const DESCRIPTIONS = 'core/descriptions';
const ERROR_MISSING_DESCRIPTION = 'MISSING_DESCRIPTION';
const rule = {
    meta: {
        messages: {
            [ERROR_MISSING_DESCRIPTION]: '{{ id }} missing description',
        },
        docs: {
            description: 'Enforce tokens have descriptions.',
            url: docsLink(DESCRIPTIONS),
        },
    },
    defaultOptions: {},
    create({ tokens, options, report }) {
        for (const t of Object.values(tokens)) {
            if (options.ignore && isTokenMatch(t.id, options.ignore)) {
                continue;
            }
            if (!t.$description) {
                report({
                    messageId: ERROR_MISSING_DESCRIPTION,
                    data: { id: t.id },
                    node: t.source.node,
                });
            }
        }
    },
};
export default rule;
//# sourceMappingURL=descriptions.js.map