@terrazzo/parser 0.0.10 → 0.0.12

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# @terrazzo/parser
+
+## 0.0.12
+
+### Patch Changes
+
+- [#285](https://github.com/terrazzoapp/terrazzo/pull/285) [`e8a0df1`](https://github.com/terrazzoapp/terrazzo/commit/e8a0df1f3b50cf7cb292bcc475aae271feae4569) Thanks [@drwpow](https://github.com/drwpow)! - Add support for multiple token files
+
+- Updated dependencies [[`e8a0df1`](https://github.com/terrazzoapp/terrazzo/commit/e8a0df1f3b50cf7cb292bcc475aae271feae4569)]:
+  - @terrazzo/token-tools@0.0.6

package/README.md

@@ -1,4 +1,4 @@
-# 💠 @terrazzo/parser
+# ⛋ @terrazzo/parser
 
 JS API for parsing / validating / transforming DTCG tokens.
 

package/build/index.d.ts

@@ -4,7 +4,7 @@ import type { ConfigInit } from '../config.js';
 import type Logger from '../logger.js';
 
 export interface BuildRunnerOptions {
-  ast: DocumentNode;
+  sources: { filename?: URL; src: string; document: DocumentNode }[];
   config: ConfigInit;
   logger?: Logger;
 }
@@ -73,8 +73,8 @@ export interface TransformHookOptions {
       mode?: string;
     },
   ): void;
-  /** Momoa document */
-  ast: DocumentNode;
+  /** Momoa documents */
+  sources: { filename?: URL; src: string; document: DocumentNode }[];
 }
 
 export interface BuildHookOptions {
@@ -82,8 +82,8 @@ export interface BuildHookOptions {
   tokens: Record<string, TokenNormalized>;
   /** Query transformed values */
   getTransforms(params: TransformParams): TokenTransformed[];
-  /** Momoa document */
-  ast: DocumentNode;
+  /** Momoa documents */
+  sources: { filename?: URL; src: string; document: DocumentNode }[];
   outputFile: (
     /** Filename to output (relative to outDir) */
     filename: string,
@@ -101,8 +101,8 @@ export interface BuildEndHookOptions {
   tokens: Record<string, TokenNormalized>;
   /** Query transformed values */
   getTransforms(params: TransformParams): TokenTransformed[];
-  /** Momoa document */
-  ast: DocumentNode;
+  /** Momoa documents */
+  sources: { filename?: URL; src: string; document: DocumentNode }[];
   /** Final files to be written */
   outputFiles: OutputFileExpanded[];
 }

package/build/index.js

@@ -5,7 +5,7 @@ import Logger from '../logger.js';
 /**
  * @typedef {object} BuildRunnerOptions
  * @typedef {Record<string, TokenNormalized>} BuildRunnerOptions.tokens
- * @typedef {DocumentNode} BuildRunnerOptions.ast
+ * @typedef {Array} BuildRunnerOptions.sources
  * @typedef {ConfigInit} BuildRunnerOptions.config
  * @typedef {Logger} BuildRunnerOptions.logger
  * @typedef {import("@humanwhocodes/momoa").DocumentNode} DocumentNode
@@ -60,7 +60,7 @@ function validateTransformParams({ params, token, logger, pluginName }) {
  * @param {BuildOptions} options
  * @return {Promise<BuildResult>}
  */
-export default async function build(tokens, { ast, logger = new Logger(), config }) {
+export default async function build(tokens, { sources, logger = new Logger(), config }) {
   const formats = {};
   const result = { outputFiles: [] };
 
@@ -95,7 +95,7 @@ export default async function build(tokens, { ast, logger = new Logger(), config
     if (typeof plugin.transform === 'function') {
       await plugin.transform({
         tokens,
-        ast,
+        sources,
         getTransforms,
         setTransform(id, params) {
           if (transformsLocked) {
@@ -165,7 +165,7 @@ export default async function build(tokens, { ast, logger = new Logger(), config
       const pluginBuildStart = performance.now();
       await plugin.build({
         tokens,
-        ast,
+        sources,
         getTransforms,
         outputFile(filename, contents) {
           const resolved = new URL(filename, config.outDir);
@@ -196,7 +196,7 @@ export default async function build(tokens, { ast, logger = new Logger(), config
     if (typeof plugin.buildEnd === 'function') {
       await plugin.buildEnd({
         tokens,
-        ast,
+        sources,
         getTransforms,
         format: (formatID) => createFormatter(formatID),
         outputFiles: structruedClone(result.outputFiles),

package/lint/index.d.ts

@@ -26,7 +26,8 @@ export interface LinterOptions<O = any> {
     id: string;
     severity: LintRuleSeverity;
   };
-  ast: DocumentNode;
+  document: DocumentNode;
+  filename?: URL;
   source?: string;
   /** Any options the user has declared for this plugin */
   options?: O;
@@ -34,7 +35,8 @@ export interface LinterOptions<O = any> {
 export type Linter = (options: LinterOptions) => Promise<LintNotice[] | undefined>;
 
 export interface LintRunnerOptions {
-  ast: DocumentNode;
+  document: DocumentNode;
+  filename?: URL;
   config: ConfigInit;
   logger: Logger;
 }

package/logger.d.ts

@@ -13,12 +13,14 @@ export interface LogEntry {
   message: string;
   /** (optional) Prefix message with label */
   label?: string;
+  /** (optional) File in disk */
+  filename?: URL;
   /** Continue on error? (default: false) */
   continueOnError?: boolean;
   /** (optional) Show a code frame for the erring node */
   node?: AnyNode;
   /** (optional) To show a code frame, provide the original source code */
-  source?: string;
+  src?: string;
 }
 
 export interface DebugEntry {
@@ -29,7 +31,7 @@ export interface DebugEntry {
   /** Error message to be logged */
   message: string;
   /** (optional) Show code below message */
-  codeFrame?: { source: string; line: number; column: number };
+  codeFrame?: { src: string; line: number; column: number };
   /** (optional) Display performance timing */
   timing?: number;
 }

package/logger.js

@@ -1,5 +1,6 @@
 import { codeFrameColumns } from '@babel/code-frame';
 import color from 'picocolors';
+import { fileURLToPath } from 'node:url';
 import wcmatch from 'wildcard-match';
 
 export const LOG_ORDER = ['error', 'warn', 'info', 'debug'];
@@ -23,8 +24,9 @@ export function formatMessage(entry, severity) {
   if (severity in MESSAGE_COLOR) {
     message = MESSAGE_COLOR[severity](message);
   }
-  if (entry.source) {
-    message = `${message}\n\n${codeFrameColumns(entry.source, { start: entry.node?.loc?.start })}`;
+  if (entry.src) {
+    const start = entry.node?.loc?.start;
+    message = `${message}\n\n${entry.filename ? `${fileURLToPath(entry.filename)}:${start?.line ?? 0}:${start?.column ?? 0}\n\n` : ''}${codeFrameColumns(entry.src, { start })}`;
   }
   return message;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@terrazzo/parser",
-  "version": "0.0.10",
+  "version": "0.0.12",
   "description": "Parser/validator for the Design Tokens Community Group (DTCG) standard.",
   "type": "module",
   "author": {
@@ -42,11 +42,11 @@
     "picocolors": "^1.0.1",
     "wildcard-match": "^5.1.3",
     "yaml": "^2.4.5",
-    "@terrazzo/token-tools": "^0.0.4"
+    "@terrazzo/token-tools": "^0.0.6"
   },
   "scripts": {
     "lint": "biome check .",
-    "test": "pnpm run \"/^test:.*/\"",
+    "test": "pnpm --filter @terrazzo/parser run \"/^test:.*/\"",
     "test:js": "vitest run",
     "test:ts": "tsc --noEmit"
   }

package/parse/index.d.ts

@@ -5,24 +5,32 @@ import type Logger from '../logger.js';
 
 export * from './validate.js';
 
+export interface ParseInput {
+  /** Source filename (if read from disk) */
+  filename?: URL;
+  /** JSON/YAML string, or JSON-serializable object (if already in memory) */
+  src: string | object;
+}
+
 export interface ParseOptions {
   logger?: Logger;
+  config: ConfigInit;
   /** Skip lint step (default: false) */
   skipLint?: boolean;
-  config: ConfigInit;
   /** Continue on error? (Useful for `tz check`) (default: false) */
   continueOnError?: boolean;
 }
 
 export interface ParseResult {
   tokens: Record<string, TokenNormalized>;
-  ast: DocumentNode;
+  /** ASTs are returned in order of input array */
+  sources: { filename?: URL; src: string; document: DocumentNode }[];
 }
 
 /**
  * Parse and validate Tokens JSON, and lint it
  */
-export default function parse(input: string | object, options?: ParseOptions): Promise<ParseResult>;
+export default function parse(input: ParseInput[], options?: ParseOptions): Promise<ParseResult>;
 
 /** Determine if an input is likely a JSON string */
 export function maybeJSONString(input: unknown): boolean;