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

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

import { getObjMember } from '@terrazzo/json-schema-tools';
import { SHADOW_REQUIRED_PROPERTIES } from '@terrazzo/token-tools';
import { docsLink } from '../lib/docs.js';
export const VALID_SHADOW = 'core/valid-shadow';
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(SHADOW_REQUIRED_PROPERTIES)}.`,
            [ERROR_INVALID_PROP]: 'Unknown property {{ key }}.',
        },
        docs: {
            description: 'Require shadow tokens to follow the format.',
            url: docsLink(VALID_SHADOW),
        },
    },
    defaultOptions: {},
    create({ tokens, report }) {
        for (const t of Object.values(tokens)) {
            if (t.aliasOf || !t.originalValue || t.$type !== 'shadow') {
                continue;
            }
            validateShadow(t.originalValue.$value, {
                filename: t.source.filename,
                node: getObjMember(t.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 validateShadow(value, { node, filename, report, }) {
    const wrappedValue = Array.isArray(value) ? value : [value];
    for (let i = 0; i < wrappedValue.length; i++) {
        if (!wrappedValue[i] ||
            typeof wrappedValue[i] !== 'object' ||
            !SHADOW_REQUIRED_PROPERTIES.every((property) => property in wrappedValue[i])) {
            report({ filename, messageId: ERROR, node });
        }
        else {
            for (const key of Object.keys(wrappedValue[i])) {
                if (![...SHADOW_REQUIRED_PROPERTIES, 'inset'].includes(key)) {
                    report({
                        data: { key: JSON.stringify(key) },
                        filename,
                        messageId: ERROR_INVALID_PROP,
                        node: getObjMember(node.type === 'Array' ? node.elements[i].value : node, key),
                    });
                }
            }
        }
    }
}
export default rule;
//# sourceMappingURL=valid-shadow.js.map