@terrazzo/parser 0.1.2 → 0.2.0

package/index.js

@@ -1,35 +0,0 @@
-// MIT License
-//
-// Copyright (c) 2021 Drew Powers
-//
-// 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 { default as build } from './build/index.js';
-export * from './build/index.js';
-
-export { default as defineConfig } from './config.js';
-export * from './config.js';
-
-export { default as lintRunner } from './lint/index.js';
-export * from './lint/index.js';
-
-export { default as Logger } from './logger.js';
-export * from './logger.js';
-
-export { default as parse } from './parse/index.js';
-export * from './parse/index.js';

package/lib/code-frame.d.ts

@@ -1,56 +0,0 @@
-// 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/lint/index.d.ts

@@ -1,44 +0,0 @@
-import type { AnyNode, DocumentNode } from '@humanwhocodes/momoa';
-import type { Group } from '@terrazzo/token-tools';
-import type { ConfigInit } from '../config.js';
-import type Logger from '../logger.js';
-
-export interface LintNotice {
-  /** Lint message shown to the user */
-  message: string;
-  /** Erring node (used to point to a specific line) */
-  node?: AnyNode;
-}
-
-export type LintRuleSeverity = 'error' | 'warn' | 'off';
-export type LintRuleShorthand = LintRuleSeverity | 0 | 1 | 2;
-export type LintRuleLonghand = [LintRuleSeverity | 0 | 1 | 2, any];
-
-export interface LintRuleNormalized<O = any> {
-  id: string;
-  severity: LintRuleSeverity;
-  options?: O;
-}
-
-export interface LinterOptions<O = any> {
-  tokens: Group;
-  rule: {
-    id: string;
-    severity: LintRuleSeverity;
-  };
-  document: DocumentNode;
-  filename?: URL;
-  source?: string;
-  /** Any options the user has declared for this plugin */
-  options?: O;
-}
-export type Linter = (options: LinterOptions) => Promise<LintNotice[] | undefined>;
-
-export interface LintRunnerOptions {
-  document: DocumentNode;
-  filename?: URL;
-  config: ConfigInit;
-  logger: Logger;
-}
-
-export default function lintRunner(options: LintRunnerOptions): Promise<void>;

package/lint/index.js

@@ -1,59 +0,0 @@
-import { pluralize } from '@terrazzo/token-tools';
-
-const listFormat = new Intl.ListFormat('en-us');
-
-export default async function lintRunner({ tokens, ast, config = {}, logger }) {
-  const { plugins = [], lint = { rules: {} } } = config;
-  const unusedLintRules = Object.keys(lint?.rules ?? {});
-
-  for (const plugin of plugins) {
-    if (typeof plugin.lint === 'function') {
-      const s = performance.now();
-      logger.debug({ group: 'plugin', task: plugin.name, message: 'Start linting' });
-
-      const rules = plugin.lint();
-      const errorEntries = [];
-      const warnEntries = [];
-      await Promise.all(
-        Object.entries(rules).map(async ([id, linter]) => {
-          const { severity = 'warn' } = lint.rules[id] || {};
-          const results = await linter({ tokens, ast, rule: { id, severity } });
-          for (const result of results ?? []) {
-            const noticeList = severity === 'error' ? errorEntries : warnEntries;
-            noticeList.push({
-              message: result.message,
-              ast,
-              node: result.node,
-              continueOnError: true,
-            });
-          }
-
-          // tick off used rule
-          const unusedLintRuleI = unusedLintRules.indexOf(id);
-          if (unusedLintRuleI !== -1) {
-            unusedLintRules.splice(unusedLintRuleI, 1);
-          }
-        }),
-      );
-      for (const entry of errorEntries) {
-        logger.error(entry);
-      }
-      for (const entry of warnEntries) {
-        logger.warn(entry);
-      }
-      logger.debug({ group: 'plugin', task: plugin.name, message: 'Finish linting', timing: performance.now() - s });
-      if (errorEntries.length) {
-        const counts = [pluralize(errorEntries.length, 'error', 'errors')];
-        if (warnEntries.length) {
-          counts.push(pluralize(warnEntries.length, 'warning', 'warnings'));
-        }
-        logger.error({ message: `Lint failed with ${listFormat.format(counts)}`, label: plugin.name });
-      }
-    }
-  }
-
-  // warn user if they have unused lint rules (they might have meant to configure something!)
-  for (const unusedRule of unusedLintRules) {
-    logger.warn({ group: 'parser', task: 'lint', message: `Unknown lint rule "${unusedRule}"` });
-  }
-}

package/lint/plugin-core/index.d.ts

@@ -1,3 +0,0 @@
-import type { Plugin } from '../../config.js';
-
-export default function coreLintPlugin(): Plugin;

package/lint/plugin-core/index.js

@@ -1,12 +0,0 @@
-import ruleDuplicateValues from './rules/duplicate-values.js';
-
-export default function coreLintPlugin() {
-  return {
-    name: '@terrazzo/plugin-lint-core',
-    lint() {
-      return {
-        duplicateValues: ruleDuplicateValues,
-      };
-    },
-  };
-}

package/lint/plugin-core/rules/duplicate-values.d.ts

@@ -1,10 +0,0 @@
-import type { LintNotice, LinterOptions } from '../../index.js';
-
-export interface RuleDuplicateValueOptions {
-  /** (optional) Token IDs to ignore. Supports globs (`*`). */
-  ignore?: string[];
-}
-
-export default function ruleDuplicateValues(
-  options: LinterOptions<RuleDuplicateValueOptions>,
-): Promise<LintNotice[] | undefined>;

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

@@ -1,68 +0,0 @@
-import { isAlias, isTokenMatch } from '@terrazzo/token-tools';
-
-export default function ruleDuplicateValues({ tokens, rule: { severity }, options }) {
-  if (severity === 'off') {
-    return;
-  }
-
-  const notices = [];
-  const values = {};
-
-  for (const id in tokens) {
-    if (!Object.hasOwn(tokens, id)) {
-      continue;
-    }
-
-    const t = tokens[id];
-
-    // skip ignored tokens
-    if (options?.ignore && isTokenMatch(id, options.ignore)) {
-      return;
-    }
-
-    if (!values[t.$type]) {
-      values[t.$type] = new Set();
-    }
-
-    // primitives: direct comparison is easy
-    if (
-      t.$type === 'color' ||
-      t.$type === 'dimension' ||
-      t.$type === 'duration' ||
-      t.$type === 'link' ||
-      t.$type === 'number' ||
-      t.$type === 'fontWeight'
-    ) {
-      // skip aliases (note: $value will be resolved)
-      if (isAlias(t._original.$value)) {
-        return;
-      }
-
-      if (values[t.$type]?.has(t.$value)) {
-        notices.push({ message: `Duplicated value: "${t.$value}" (${t.id})`, node: t.sourceNode });
-        return;
-      }
-
-      values[t.$type]?.add(t.$value);
-      return;
-    }
-
-    // everything else: use deepEqual
-    let isDuplicate = false;
-    for (const v of values[t.$type]?.values() ?? []) {
-      if (JSON.stringify(t.$value) === JSON.stringify(v)) {
-        notices.push({ message: `Duplicated value (${t.id})`, node: t.sourceNode });
-        isDuplicate = true;
-        break;
-      }
-    }
-
-    if (isDuplicate) {
-      continue;
-    }
-
-    values[t.$type]?.add(t.$value);
-  }
-
-  return notices;
-}

package/logger.d.ts

@@ -1,71 +0,0 @@
-import type { AnyNode } from '@humanwhocodes/momoa';
-
-declare const LOG_ORDER: readonly ['error', 'warn', 'info', 'debug'];
-
-export type LogSeverity = 'error' | 'warn' | 'info' | 'debug';
-
-export type LogLevel = LogSeverity | 'silent';
-
-export type LogGroup = 'core' | 'plugin';
-
-export interface LogEntry {
-  /** Error message to be logged */
-  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 */
-  src?: string;
-}
-
-export interface DebugEntry {
-  /** `parser` | `plugin` */
-  group: 'parser' | 'plugin';
-  /** Current subtask or submodule */
-  task: string;
-  /** Error message to be logged */
-  message: string;
-  /** (optional) Show code below message */
-  codeFrame?: { src: string; line: number; column: number };
-  /** (optional) Display performance timing */
-  timing?: number;
-}
-
-export default class Logger {
-  constructor(options?: { level?: LogLevel; debugScope: string });
-
-  setLevel(level: LogLevel): void;
-
-  /** Log an error message (always; can’t be silenced) */
-  error(entry: LogEntry): void;
-
-  /** Log an info message (if logging level permits) */
-  info(entry: LogEntry): void;
-
-  /** Log a warning message (if logging level permits) */
-  warn(entry: LogEntry): void;
-
-  /** Log a diagnostics message (if logging level permits) */
-  debug(entry: DebugEntry): void;
-
-  /** Get current stats for logger instance */
-  stats(): {
-    errorCount: number;
-    infoCount: number;
-    warnCount: number;
-    debugCount: number;
-  };
-}
-
-export class TokensJSONError extends Error {
-  level: LogLevel;
-  debugScope: string;
-  node?: AnyNode;
-
-  constructor(message: string, node: AnyNode);
-}

package/parse/index.d.ts

@@ -1,45 +0,0 @@
-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';
-
-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;
-  /** 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 {
-  tokens: Record<string, TokenNormalized>;
-  /** 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: ParseInput[], options: ParseOptions): Promise<ParseResult>;
-
-/** Determine if an input is likely a JSON string */
-export function maybeJSONString(input: unknown): boolean;
-
-/** Resolve alias */
-export function resolveAlias(
-  alias: string,
-  options: { tokens: Record<string, TokenNormalized>; logger: Logger; path: string[] },
-): string | undefined;