@terrazzo/parser 2.0.0-alpha.4 → 2.0.0-alpha.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@terrazzo/parser",
-  "version": "2.0.0-alpha.4",
+  "version": "2.0.0-alpha.5",
   "description": "Parser/validator for the Design Tokens Community Group (DTCG) standard.",
   "license": "MIT",
   "type": "module",
@@ -44,7 +44,15 @@
     "scule": "^1.3.0",
     "wildcard-match": "^5.1.4",
     "@terrazzo/json-schema-tools": "^0.1.0-alpha.0",
-    "@terrazzo/token-tools": "^2.0.0-alpha.4"
+    "@terrazzo/token-tools": "^2.0.0-alpha.5"
+  },
+  "peerDependencies": {
+    "yaml-to-momoa": "0.0.8"
+  },
+  "peerDependenciesMeta": {
+    "yaml-to-momoa": {
+      "optional": true
+    }
   },
   "devDependencies": {
     "yaml-to-momoa": "0.0.8"
@@ -52,6 +60,7 @@
   "scripts": {
     "build": "rolldown -c && attw --profile esm-only --pack .",
     "dev": "rolldown -w -c",
+    "format": "biome check --fix --unsafe .",
     "lint": "pnpm --filter @terrazzo/parser run \"/^lint:(js|ts)/\"",
     "lint:js": "biome check .",
     "lint:ts": "tsc --noEmit",

package/src/build/index.ts

@@ -2,11 +2,12 @@ import type { InputSourceWithDocument } from '@terrazzo/json-schema-tools';
 import type { TokenNormalized } from '@terrazzo/token-tools';
 import wcmatch from 'wildcard-match';
 import Logger, { type LogEntry } from '../logger.js';
-import type { BuildRunnerResult, ConfigInit, TokenTransformed, TransformParams } from '../types.js';
+import type { BuildRunnerResult, ConfigInit, Resolver, TokenTransformed, TransformParams } from '../types.js';
 
 export interface BuildRunnerOptions {
   sources: InputSourceWithDocument[];
   config: ConfigInit;
+  resolver: Resolver;
   logger?: Logger;
 }
 export const SINGLE_VALUE = 'SINGLE_VALUE';
@@ -48,7 +49,7 @@ function validateTransformParams({
 /** Run build stage */
 export default async function build(
   tokens: Record<string, TokenNormalized>,
-  { sources, logger = new Logger(), config }: BuildRunnerOptions,
+  { resolver, sources, logger = new Logger(), config }: BuildRunnerOptions,
 ): Promise<BuildRunnerResult> {
   const formats: Record<string, TokenTransformed[]> = {};
   const result: BuildRunnerResult = { outputFiles: [] };
@@ -133,6 +134,7 @@ export default async function build(
             formats[params.format]![foundTokenI]!.type = typeof cleanValue === 'string' ? SINGLE_VALUE : MULTI_VALUE;
           }
         },
+        resolver,
       });
     }
   }
@@ -155,6 +157,7 @@ export default async function build(
           tokens,
           sources,
           getTransforms,
+          resolver,
           outputFile(filename, contents) {
             const resolved = new URL(filename, config.outDir);
             if (result.outputFiles.some((f) => new URL(f.filename, config.outDir).href === resolved.href)) {

package/src/config.ts

@@ -29,7 +29,7 @@ export default function defineConfig(
 
   // 2. Start build by calling config()
   for (const plugin of config.plugins) {
-    plugin.config?.({ ...config });
+    plugin.config?.({ ...config }, { logger });
   }
 
   // 3. finish
@@ -267,13 +267,6 @@ function normalizeLint({ config, logger }: { config: ConfigInit; logger: Logger
           });
         }
       }
-
-      // Apply recommended config in places user hasn’t explicitly opted-out
-      for (const [id, severity] of Object.entries(RECOMMENDED_CONFIG)) {
-        if (!(id in config.lint.rules)) {
-          config.lint.rules[id] = severity;
-        }
-      }
     }
   } else {
     config.lint = {

package/src/logger.ts

@@ -26,6 +26,8 @@ export interface LogEntry {
   node?: momoa.AnyNode;
   /** To show a code frame, provide the original source code */
   src?: string;
+  /** Display performance timing */
+  timing?: number;
 }
 
 export interface DebugEntry {
@@ -61,6 +63,9 @@ export function formatMessage(entry: LogEntry, severity: LogSeverity) {
   if (severity in MESSAGE_COLOR) {
     message = MESSAGE_COLOR[severity]!(message);
   }
+  if (typeof entry.timing === 'number') {
+    message = `${message} ${formatTiming(entry.timing)}`;
+  }
   if (entry.node) {
     const start = entry.node?.loc?.start ?? { line: 0, column: 0 };
     //  strip "file://" protocol, but not href
@@ -139,6 +144,7 @@ export default class Logger {
         return;
       }
       const message = formatMessage(entry, 'warn');
+
       // biome-ignore lint/suspicious/noConsole: this is a logger
       console.warn(message);
     }
@@ -168,13 +174,7 @@ export default class Logger {
 
       message = `${pc.dim(timeFormatter.format(performance.now()))} ${message}`;
       if (typeof entry.timing === 'number') {
-        let timing = '';
-        if (entry.timing < 1_000) {
-          timing = `${Math.round(entry.timing * 100) / 100}ms`;
-        } else if (entry.timing < 60_000) {
-          timing = `${Math.round(entry.timing * 100) / 100_000}s`;
-        }
-        message = `${message}${timing ? pc.dim(` [${timing}]`) : ''}`;
+        message = `${message} ${formatTiming(entry.timing)}`;
       }
 
       // biome-ignore lint/suspicious/noConsole: this is a logger
@@ -193,6 +193,18 @@ export default class Logger {
   }
 }
 
+function formatTiming(timing: number): string {
+  let output = '';
+  if (timing < 1_000) {
+    output = `${Math.round(timing * 100) / 100}ms`;
+  } else if (timing < 60_000) {
+    output = `${Math.round(timing) / 1_000}s`;
+  } else {
+    output = `${Math.round(timing / 1_000) / 60}m`;
+  }
+  return pc.dim(`[${output}]`);
+}
+
 export class TokensJSONError extends Error {
   constructor(message: string) {
     super(message);

package/src/parse/index.ts

@@ -73,6 +73,15 @@ export default async function parse(
     });
   }
 
+  const resolverTiming = performance.now();
+  const finalResolver = resolver || (await createSyntheticResolver(tokens, { config, logger, req, sources }));
+  logger.debug({
+    message: 'Resolver finalized',
+    group: 'parser',
+    label: 'core',
+    timing: performance.now() - resolverTiming,
+  });
+
   logger.debug({
     message: 'Finish all parser tasks',
     group: 'parser',
@@ -93,7 +102,7 @@ export default async function parse(
   return {
     tokens,
     sources,
-    resolver: resolver || (await createSyntheticResolver(tokens, { config, logger, req, sources })),
+    resolver: finalResolver,
   };
 }
 

package/src/parse/process.ts

@@ -44,12 +44,11 @@ export function processTokens(
       if (node.type !== 'Object') {
         return;
       }
-      const path = isResolver ? filterResolverPaths(rawPath) : rawPath;
-      groupFromNode(node, { path, groups });
+      groupFromNode(node, { path: isResolver ? filterResolverPaths(rawPath) : rawPath, groups });
       const token = tokenFromNode(node, {
         groups,
         ignore: config.ignore,
-        path,
+        path: isResolver ? filterResolverPaths(rawPath) : rawPath,
         source: rootSource,
       });
       if (token) {

package/src/parse/token.ts

@@ -35,7 +35,7 @@ export function tokenFromNode(
   node: momoa.AnyNode,
   { groups, path, source, ignore }: TokenFromNodeOptions,
 ): TokenNormalized | undefined {
-  const isToken = node.type === 'Object' && getObjMember(node, '$value') && !path.includes('$extensions');
+  const isToken = node.type === 'Object' && !!getObjMember(node, '$value') && !path.includes('$extensions');
   if (!isToken) {
     return undefined;
   }
@@ -59,6 +59,7 @@ export function tokenFromNode(
     $deprecated: originalToken.$deprecated ?? group.$deprecated ?? undefined, // ⚠️ MUST use ?? here to inherit false correctly
     $value: originalToken.$value,
     $extensions: originalToken.$extensions || undefined,
+    $extends: originalToken.$extends || undefined,
     aliasChain: undefined,
     aliasedBy: undefined,
     aliasOf: undefined,
@@ -94,7 +95,7 @@ export function tokenFromNode(
   const $extensions = getObjMember(node, '$extensions');
   if ($extensions) {
     const modeNode = getObjMember($extensions as momoa.ObjectNode, 'mode') as momoa.ObjectNode;
-    for (const mode of Object.keys((token.$extensions as any).mode)) {
+    for (const mode of Object.keys((token.$extensions as any).mode ?? {})) {
       const modeValue = (token.$extensions as any).mode[mode];
       token.mode[mode] = {
         $value: modeValue,

package/src/resolver/load.ts

@@ -1,4 +1,4 @@
-import * as momoa from '@humanwhocodes/momoa';
+import type * as momoa from '@humanwhocodes/momoa';
 import { type InputSource, type InputSourceWithDocument, maybeRawJSON } from '@terrazzo/json-schema-tools';
 import type { TokenNormalizedSet } from '@terrazzo/token-tools';
 import { merge } from 'merge-anything';
@@ -160,7 +160,7 @@ export function createResolver(
       const tokens = processTokens(rootSource, {
         config,
         logger,
-        sourceByFilename: {},
+        sourceByFilename: { [resolverSource._source.filename!.href]: rootSource },
         refMap: {},
         sources,
       });

package/src/resolver/validate.ts

@@ -1,4 +1,4 @@
-import type * as momoa from '@humanwhocodes/momoa';
+import * as momoa from '@humanwhocodes/momoa';
 import { getObjMember, getObjMembers } from '@terrazzo/json-schema-tools';
 import type { LogEntry, default as Logger } from '../logger.js';
 
@@ -24,7 +24,7 @@ export function isLikelyResolver(doc: momoa.DocumentNode): boolean {
       case 'description':
       case 'version': {
         // 1. name, description, or version are a string
-        if (member.name.type === 'String') {
+        if (member.value.type === 'String') {
           return true;
         }
         break;
@@ -176,6 +176,7 @@ export function validateResolver(node: momoa.DocumentNode, { logger, src }: Vali
           errors.push({ ...entry, message: `Expected object`, node: member.value });
         }
         break;
+      case '$schema':
       case '$ref': {
         if (member.value.type !== 'String') {
           errors.push({ ...entry, message: `Expected string`, node: member.value });
@@ -329,6 +330,17 @@ export function validateModifier(
         }
         break;
       }
+      case 'default': {
+        if (member.value.type !== 'String') {
+          errors.push({ ...entry, message: `Expected string`, node: member.value });
+        } else {
+          const contexts = getObjMember(node, 'contexts') as momoa.ObjectNode | undefined;
+          if (!contexts || !getObjMember(contexts, member.value.value)) {
+            errors.push({ ...entry, message: 'Invalid default context', node: member.value });
+          }
+        }
+        break;
+      }
       case '$defs':
       case '$extensions':
         if (member.value.type !== 'Object') {

package/src/types.ts

@@ -32,6 +32,8 @@ export interface BuildHookOptions {
   getTransforms(params: TransformParams): TokenTransformed[];
   /** Momoa documents */
   sources: InputSourceWithDocument[];
+  /** Resolver */
+  resolver: Resolver;
   outputFile: (
     /** Filename to output (relative to outDir) */
     filename: string,
@@ -311,7 +313,7 @@ export interface Plugin {
   name: string;
   /** Read config, and optionally modify */
   // biome-ignore lint/suspicious/noConfusingVoidType format: this helps plugins be a little looser on their typing
-  config?(config: ConfigInit): void | ConfigInit | undefined;
+  config?(config: ConfigInit, context: PluginHookContext): void | ConfigInit | undefined;
   /**
    * Declare:
    * - `"pre"`: run this plugin BEFORE all others
@@ -452,6 +454,8 @@ export interface TransformHookOptions {
       meta?: TokenTransformedBase['meta'];
     },
   ): void;
+  /** Resolver */
+  resolver: Resolver;
   /** Momoa documents */
   sources: InputSourceWithDocument[];
 }