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

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

import { getObjMember } from '@terrazzo/json-schema-tools';
import { TRANSITION_REQUIRED_PROPERTIES } from '@terrazzo/token-tools';
import { docsLink } from '../lib/docs.js';
export const VALID_TRANSITION = 'core/valid-transition';
const ERROR = 'ERROR';
const ERROR_INVALID_PROP = 'ERROR_INVALID_PROP';
const rule = {
    meta: {
        messages: {
            [ERROR]: `Missing required properties: ${new Intl.ListFormat('en-us', { type: 'conjunction' }).format(TRANSITION_REQUIRED_PROPERTIES)}.`,
            [ERROR_INVALID_PROP]: 'Unknown property: {{ key }}.',
        },
        docs: {
            description: 'Require transition tokens to follow the format.',
            url: docsLink(VALID_TRANSITION),
        },
    },
    defaultOptions: {},
    create({ tokens, report }) {
        for (const token of Object.values(tokens)) {
            if (token.aliasOf || !token.originalValue || token.$type !== 'transition') {
                continue;
            }
            validateTransition(token.originalValue.$value, {
                filename: token.source.filename,
                node: getObjMember(token.source.node, '$value'),
                report,
            });
        }
    },
};
// Note: we validate sub-properties using other checks like valid-dimension, valid-font-family, etc.
// The only thing remaining is to check that all properties exist (since missing properties won’t appear as invalid)
function validateTransition(value, { node, filename, report, }) {
    if (!value ||
        typeof value !== 'object' ||
        !TRANSITION_REQUIRED_PROPERTIES.every((property) => property in value)) {
        report({ filename, messageId: ERROR, node });
    }
    else {
        for (const key of Object.keys(value)) {
            if (!TRANSITION_REQUIRED_PROPERTIES.includes(key)) {
                report({
                    data: { key: JSON.stringify(key) },
                    filename,
                    messageId: ERROR_INVALID_PROP,
                    node: getObjMember(node, key),
                });
            }
        }
    }
}
export default rule;
//# sourceMappingURL=valid-transition.js.map