@terrazzo/parser 0.0.12 → 0.0.13

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @terrazzo/parser
 
+## 0.0.13
+
+### Patch Changes
+
+- [#289](https://github.com/terrazzoapp/terrazzo/pull/289) [`0fc9738`](https://github.com/terrazzoapp/terrazzo/commit/0fc9738bb3dfecb680d225e4bd3970f21cfe8079) Thanks [@drwpow](https://github.com/drwpow)! - Add YAML support
+
+- [#291](https://github.com/terrazzoapp/terrazzo/pull/291) [`6a875b1`](https://github.com/terrazzoapp/terrazzo/commit/6a875b163539dba8111911851a7819732056b3aa) Thanks [@drwpow](https://github.com/drwpow)! - Allow negative dimension values
+
 ## 0.0.12
 
 ### Patch Changes

package/lib/code-frame.d.ts

@@ -0,0 +1,56 @@
+// MIT License
+//
+// Copyright (c) 2014-present Sebastian McKenzie and other contributors
+//
+// Permission is hereby granted, free of charge, to any person obtaining
+// a copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to
+// permit persons to whom the Software is furnished to do so, subject to
+// the following conditions:
+//
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+export interface Location {
+  line: number;
+  column: number;
+}
+
+export interface NodeLocation {
+  end?: Location;
+  start: Location;
+}
+
+export interface Options {
+  /** Syntax highlight the code as JavaScript for terminals. default: false */
+  highlightCode?: boolean;
+  /**  The number of lines to show above the error. default: 2 */
+  linesAbove?: number;
+  /**  The number of lines to show below the error. default: 3 */
+  linesBelow?: number;
+  /**
+   * Forcibly syntax highlight the code as JavaScript (for non-terminals);
+   * overrides highlightCode.
+   * default: false
+   */
+  forceColor?: boolean;
+  /**
+   * Pass in a string to be displayed inline (if possible) next to the
+   * highlighted location in the code. If it can't be positioned inline,
+   * it will be placed above the code frame.
+   * default: nothing
+   */
+  message?: string;
+}
+
+export function codeFrameColumns(input: string, location: NodeLocation, options?: Options): string;

package/lib/code-frame.js

@@ -0,0 +1,141 @@
+// This is copied from @babel/code-frame package but without the heavyweight color highlighting
+// (note: Babel loads both chalk AND picocolors, and doesn’t treeshake well)
+// Babel is MIT-licensed and unaffiliated with this project.
+
+// MIT License
+//
+// Copyright (c) 2014-present Sebastian McKenzie and other contributors
+//
+// Permission is hereby granted, free of charge, to any person obtaining
+// a copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to
+// permit persons to whom the Software is furnished to do so, subject to
+// the following conditions:
+//
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+/**
+ * Extract what lines should be marked and highlighted.
+ */
+
+function getMarkerLines(loc, source, opts = {}) {
+  const startLoc = {
+    column: 0,
+    line: -1,
+    ...loc.start,
+  };
+  const endLoc = {
+    ...startLoc,
+    ...loc.end,
+  };
+  const { linesAbove = 2, linesBelow = 3 } = opts || {};
+  const startLine = startLoc.line;
+  const startColumn = startLoc.column;
+  const endLine = endLoc.line;
+  const endColumn = endLoc.column;
+
+  let start = Math.max(startLine - (linesAbove + 1), 0);
+  let end = Math.min(source.length, endLine + linesBelow);
+
+  if (startLine === -1) {
+    start = 0;
+  }
+
+  if (endLine === -1) {
+    end = source.length;
+  }
+
+  const lineDiff = endLine - startLine;
+  const markerLines = {};
+
+  if (lineDiff) {
+    for (let i = 0; i <= lineDiff; i++) {
+      const lineNumber = i + startLine;
+
+      if (!startColumn) {
+        markerLines[lineNumber] = true;
+      } else if (i === 0) {
+        const sourceLength = source[lineNumber - 1].length;
+
+        markerLines[lineNumber] = [startColumn, sourceLength - startColumn + 1];
+      } else if (i === lineDiff) {
+        markerLines[lineNumber] = [0, endColumn];
+      } else {
+        const sourceLength = source[lineNumber - i].length;
+
+        markerLines[lineNumber] = [0, sourceLength];
+      }
+    }
+  } else {
+    if (startColumn === endColumn) {
+      if (startColumn) {
+        markerLines[startLine] = [startColumn, 0];
+      } else {
+        markerLines[startLine] = true;
+      }
+    } else {
+      markerLines[startLine] = [startColumn, endColumn - startColumn];
+    }
+  }
+
+  return { start, end, markerLines };
+}
+
+/**
+ * RegExp to test for newlines in terminal.
+ */
+
+const NEWLINE = /\r\n|[\n\r\u2028\u2029]/;
+
+export function codeFrameColumns(rawLines, loc, opts = {}) {
+  const lines = rawLines.split(NEWLINE);
+  const { start, end, markerLines } = getMarkerLines(loc, lines, opts);
+  const hasColumns = loc.start && typeof loc.start.column === 'number';
+
+  const numberMaxWidth = String(end).length;
+
+  let frame = rawLines
+    .split(NEWLINE, end)
+    .slice(start, end)
+    .map((line, index) => {
+      const number = start + 1 + index;
+      const paddedNumber = ` ${number}`.slice(-numberMaxWidth);
+      const gutter = ` ${paddedNumber} |`;
+      const hasMarker = markerLines[number];
+      const lastMarkerLine = !markerLines[number + 1];
+      if (hasMarker) {
+        let markerLine = '';
+        if (Array.isArray(hasMarker)) {
+          const markerSpacing = line.slice(0, Math.max(hasMarker[0] - 1, 0)).replace(/[^\t]/g, ' ');
+          const numberOfMarkers = hasMarker[1] || 1;
+
+          markerLine = ['\n ', gutter.replace(/\d/g, ' '), ' ', markerSpacing, '^'.repeat(numberOfMarkers)].join('');
+
+          if (lastMarkerLine && opts.message) {
+            markerLine += ` ${opts.message}`;
+          }
+        }
+        return ['>', gutter, line.length > 0 ? ` ${line}` : '', markerLine].join('');
+      } else {
+        return ` ${gutter}${line.length > 0 ? ` ${line}` : ''}`;
+      }
+    })
+    .join('\n');
+
+  if (opts.message && !hasColumns) {
+    frame = `${' '.repeat(numberMaxWidth + 1)}${opts.message}\n${frame}`;
+  }
+
+  return frame;
+}

package/lint/plugin-core/rules/duplicate-values.js

@@ -1,5 +1,4 @@
 import { isAlias, isTokenMatch } from '@terrazzo/token-tools';
-import deepEqual from 'deep-equal';
 
 export default function ruleDuplicateValues({ tokens, rule: { severity }, options }) {
   if (severity === 'off') {
@@ -51,7 +50,7 @@ export default function ruleDuplicateValues({ tokens, rule: { severity }, option
     // everything else: use deepEqual
     let isDuplicate = false;
     for (const v of values[t.$type]?.values() ?? []) {
-      if (deepEqual(t.$value, v)) {
+      if (JSON.stringify(t.$value) === JSON.stringify(v)) {
         notices.push({ message: `Duplicated value (${t.id})`, node: t.sourceNode });
         isDuplicate = true;
         break;

package/logger.js

@@ -1,7 +1,6 @@
-import { codeFrameColumns } from '@babel/code-frame';
 import color from 'picocolors';
-import { fileURLToPath } from 'node:url';
 import wcmatch from 'wildcard-match';
+import { codeFrameColumns } from './lib/code-frame.js';
 
 export const LOG_ORDER = ['error', 'warn', 'info', 'debug'];
 
@@ -26,7 +25,8 @@ export function formatMessage(entry, severity) {
   }
   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 })}`;
+    // note: strip "file://" protocol, but not href
+    message = `${message}\n\n${entry.filename ? `${entry.filename.href.replace(/^file:\/\//, '')}:${start?.line ?? 0}:${start?.column ?? 0}\n\n` : ''}${codeFrameColumns(entry.src, { start }, { highlightCode: false })}`;
   }
   return message;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@terrazzo/parser",
-  "version": "0.0.12",
+  "version": "0.0.13",
   "description": "Parser/validator for the Design Tokens Community Group (DTCG) standard.",
   "type": "module",
   "author": {
@@ -30,20 +30,21 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@babel/code-frame": "^7.24.7",
-    "@humanwhocodes/momoa": "^3.1.1",
+    "@humanwhocodes/momoa": "^3.2.0",
     "@types/babel__code-frame": "^7.0.6",
     "@types/culori": "^2.1.1",
-    "@types/deep-equal": "^1.0.4",
     "culori": "^4.0.1",
-    "deep-equal": "^2.2.3",
     "is-what": "^4.1.16",
     "merge-anything": "^5.1.7",
     "picocolors": "^1.0.1",
     "wildcard-match": "^5.1.3",
-    "yaml": "^2.4.5",
+    "yaml": "^2.5.0",
     "@terrazzo/token-tools": "^0.0.6"
   },
+  "devDependencies": {
+    "esbuild": "^0.23.0",
+    "yaml-to-momoa": "^0.0.1"
+  },
   "scripts": {
     "lint": "biome check .",
     "test": "pnpm --filter @terrazzo/parser run \"/^test:.*/\"",

package/parse/index.d.ts

@@ -1,5 +1,6 @@
 import type { DocumentNode } from '@humanwhocodes/momoa';
 import type { TokenNormalized } from '@terrazzo/token-tools';
+import type yamlToMomoa from 'yaml-to-momoa';
 import type { ConfigInit } from '../config.js';
 import type Logger from '../logger.js';
 
@@ -19,6 +20,8 @@ export interface ParseOptions {
   skipLint?: boolean;
   /** Continue on error? (Useful for `tz check`) (default: false) */
   continueOnError?: boolean;
+  /** Provide yamlToMomoa module to parse YAML (by default, this isn’t shipped to cut down on package weight) */
+  yamlToMomoa?: typeof yamlToMomoa;
 }
 
 export interface ParseResult {

package/parse/index.js

@@ -1,10 +1,8 @@
 import { evaluate, parse as parseJSON, print } from '@humanwhocodes/momoa';
 import { isAlias, parseAlias, pluralize, splitID } from '@terrazzo/token-tools';
-import { fileURLToPath } from 'node:url';
 import lintRunner from '../lint/index.js';
 import Logger from '../logger.js';
 import normalize from './normalize.js';
-import parseYAML from './yaml.js';
 import validate from './validate.js';
 import { getObjMembers, injectObjMembers, traverse } from './json.js';
 
@@ -27,6 +25,7 @@ export * from './validate.js';
  * @typedef {object} ParseOptions
  * @property {Logger} logger
  * @property {import("../config.js").Config} config
+ * @property {import("yamlToMomoa")} yamlToMomoa
  * @property {boolean} [skipLint=false]
  * @property {boolean} [continueOnError=false]
  */
@@ -38,7 +37,7 @@ export * from './validate.js';
  */
 export default async function parse(
   input,
-  { logger = new Logger(), skipLint = false, config = {}, continueOnError = false } = {},
+  { logger = new Logger(), skipLint = false, config = {}, continueOnError = false, yamlToMomoa } = {},
 ) {
   let tokens = {};
   // note: only keeps track of sources with locations on disk; in-memory sources are discarded
@@ -73,11 +72,12 @@ export default async function parse(
       config,
       skipLint,
       continueOnError,
+      yamlToMomoa,
     });
 
     tokens = Object.assign(tokens, result.tokens);
     if (input[i].filename) {
-      sources[input[i].filename.protocol === 'file:' ? fileURLToPath(input[i].filename) : input[i].filename.href] = {
+      sources[input[i].filename.protocol === 'file:' ? input[i].filename.href : input[i].filename.href] = {
         filename: input[i].filename,
         src: result.src,
         document: result.document,
@@ -172,7 +172,7 @@ export default async function parse(
  * @param {import("../config.js").Config} [options.config]
  * @param {boolean} [options.skipLint]
  */
-async function parseSingle(input, { filename, logger, config, skipLint, continueOnError = false }) {
+async function parseSingle(input, { filename, logger, config, skipLint, continueOnError = false, yamlToMomoa }) {
   // 1. Build AST
   let src;
   if (typeof input === 'string') {
@@ -182,7 +182,25 @@ async function parseSingle(input, { filename, logger, config, skipLint, continue
   logger.debug({ group: 'parser', task: 'parse', message: 'Start tokens parsing' });
   let document;
   if (typeof input === 'string' && !maybeJSONString(input)) {
-    document = parseYAML(input, { logger }); // if string, but not JSON, attempt YAML
+    if (yamlToMomoa) {
+      try {
+        document = yamlToMomoa(input); // if string, but not JSON, attempt YAML
+      } catch (err) {
+        logger.error({ message: String(err), filename, src: input, continueOnError });
+      }
+    } else {
+      logger.error({
+        group: 'parser',
+        task: 'parse',
+        message: `Install \`yaml-to-momoa\` package to parse YAML, and pass in as option, e.g.:
+
+    import { parse } from '@terrazzo/parser';
+    import yamlToMomoa from 'yaml-to-momoa';
+
+    parse(yamlString, { yamlToMomoa });`,
+        continueOnError: false, // fail here; no point in continuing
+      });
+    }
   } else {
     document = parseJSON(
       typeof input === 'string' ? input : JSON.stringify(input, undefined, 2), // everything else: assert it’s JSON-serializable
@@ -259,7 +277,7 @@ async function parseSingle(input, { filename, logger, config, skipLint, continue
             originalValue: evaluate(node.value),
             group,
             source: {
-              loc: filename ? fileURLToPath(filename) : undefined,
+              loc: filename ? filename.href : undefined,
               node: sourceNode.value,
             },
           };
@@ -276,7 +294,7 @@ async function parseSingle(input, { filename, logger, config, skipLint, continue
               $type: token.$type,
               $value: mode === '.' ? token.$value : evaluate(modeValues[mode]),
               source: {
-                loc: filename ? fileURLToPath(filename) : undefined,
+                loc: filename ? filename.href : undefined,
                 node: mode === '.' ? structuredClone(token.source.node) : modeValues[mode],
               },
             };

package/parse/validate.js

@@ -266,9 +266,9 @@ export function validateDimension($value, node, { filename, src, logger }) {
     logger.error({ message: `Expected string, received ${$value.type}`, filename, node: $value, src });
   } else if ($value.value === '') {
     logger.error({ message: 'Expected dimension, received empty string', filename, node: $value, src });
-  } else if (String(Number($value.value)) === $value.value) {
+  } else if (String(Number.parseFloat($value.value)) === $value.value) {
     logger.error({ message: 'Missing units', filename, node: $value, src });
-  } else if (!/^[0-9]+/.test($value.value)) {
+  } else if (!/^-?[0-9]+(\.[0-9]+)?/.test($value.value)) {
     logger.error({ message: `Expected dimension with units, received ${print($value)}`, filename, node: $value, src });
   }
 }

package/parse/yaml.d.ts

@@ -1,11 +0,0 @@
-import type { DocumentNode } from '@humanwhocodes/momoa';
-import type Logger from '../logger.js';
-
-export interface ParseYAMLOptions {
-  logger: Logger;
-}
-
-/**
- * Take a YAML document and create a Momoa JSON AST from it
- */
-export default function yamlToAST(input: string, options: ParseYAMLOptions): DocumentNode;

package/parse/yaml.js

@@ -1,45 +0,0 @@
-import { Composer, Parser } from 'yaml';
-
-/**
- * @typedef {import("yaml").YAMLError} YAMLError
- */
-
-/**
- * Convert YAML position to line, column
- * @param {string} input
- * @param {YAMLError{"pos"]} pos
- * @return {import("@babel/code-frame").SourceLocation["start"]}
- */
-function posToLoc(input, pos) {
-  let line = 1;
-  let column = 0;
-  for (let i = 0; i <= (pos[0] || 0); i++) {
-    const c = input[i];
-    if (c === '\n') {
-      line++;
-      column = 0;
-    }
-    column++;
-  }
-  return { line, column };
-}
-
-/**
- * Take a YAML document and create a Momoa JSON AST from it
- */
-export default function yamlToAST(input, { logger }) {
-  const parser = new Parser();
-  const composer = new Composer();
-  for (const node of composer.compose(parser.parse(input))) {
-    if (node.errors) {
-      for (const error of node.errors) {
-        logger.error({
-          label: 'parse:yaml',
-          message: `${error.code} ${error.message}`,
-          node: { loc: { start: posToLoc(input, error.pos) } },
-          source: input,
-        });
-      }
-    }
-  }
-}