@html-validate/plugin-utils 1.0.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2017 David Sveningsson <ext@sidvind.com>
+
+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.

package/README.md

@@ -0,0 +1,3 @@
+# @html-validate/plugin-utils`
+
+Plugin utilities and helpers for writing plugins to HTML-Validate

package/dist/index.cjs.js

@@ -0,0 +1,210 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  TemplateExtractor: () => TemplateExtractor,
+  positionFromOffset: () => positionFromOffset,
+  positionToOffset: () => positionToOffset
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/position-from-offset.ts
+function positionFromOffset(text, offset) {
+  let line = 1;
+  let prev = 0;
+  let pos = text.indexOf("\n");
+  while (pos !== -1) {
+    if (pos >= offset) {
+      return [line, offset - prev + 1];
+    }
+    line++;
+    prev = pos + 1;
+    pos = text.indexOf("\n", pos + 1);
+  }
+  return [line, offset - prev + 1];
+}
+
+// src/position-to-offset.ts
+function positionToOffset(position, data) {
+  let line = position.line;
+  let column = position.column + 1;
+  for (let i = 0; i < data.length; i++) {
+    if (line > 1) {
+      if (data[i] === "\n") {
+        line--;
+      }
+    } else if (column > 1) {
+      column--;
+    } else {
+      return i;
+    }
+  }
+  throw new Error("Failed to compute location offset from position");
+}
+
+// src/template-extractor.ts
+var espree = __toESM(require("espree"));
+var walk = __toESM(require("acorn-walk"));
+function joinTemplateLiteral(nodes) {
+  let offset = nodes[0].start + 1;
+  let output = "";
+  for (const node of nodes) {
+    output += " ".repeat(node.start + 1 - offset);
+    output += node.value.raw;
+    offset = node.end - 2;
+  }
+  return output;
+}
+function extractLiteral(node, filename, data) {
+  switch (node.type) {
+    case "FunctionExpression":
+    case "Identifier":
+      return null;
+    case "Literal":
+      if (typeof node.value !== "string") {
+        return null;
+      }
+      return {
+        data: node.value.toString(),
+        filename,
+        line: node.loc.start.line,
+        column: node.loc.start.column + 1,
+        offset: positionToOffset(node.loc.start, data) + 1
+      };
+    case "TemplateLiteral":
+      return {
+        data: joinTemplateLiteral(node.quasis),
+        filename,
+        line: node.loc.start.line,
+        column: node.loc.start.column + 1,
+        offset: positionToOffset(node.loc.start, data) + 1
+      };
+    case "TaggedTemplateExpression":
+      return {
+        data: joinTemplateLiteral(node.quasi.quasis),
+        filename,
+        line: node.quasi.loc.start.line,
+        column: node.quasi.loc.start.column + 1,
+        offset: positionToOffset(node.quasi.loc.start, data) + 1
+      };
+    case "ArrowFunctionExpression": {
+      const whitelist = ["Literal", "TemplateLiteral"];
+      if (whitelist.includes(node.body.type)) {
+        return extractLiteral(node.body, filename, data);
+      } else {
+        return null;
+      }
+    }
+    default: {
+      const loc = node.loc.start;
+      const context = `${filename}:${loc.line}:${loc.column}`;
+      throw new Error(`Unhandled node type "${node.type}" at "${context}" in extractLiteral`);
+    }
+  }
+}
+function compareKey(node, key, filename) {
+  switch (node.type) {
+    case "Identifier":
+      return node.name === key;
+    case "Literal":
+      return node.value === key;
+    default: {
+      const loc = node.loc.start;
+      const context = `${filename}:${loc.line}:${loc.column}`;
+      throw new Error(`Unhandled node type "${node.type}" at "${context}" in compareKey`);
+    }
+  }
+}
+var TemplateExtractor = class {
+  constructor(ast, filename, data) {
+    this.ast = ast;
+    this.filename = filename;
+    this.data = data;
+  }
+  /**
+   * Create a new [[TemplateExtractor]] from javascript source code.
+   *
+   * `Source` offsets will be relative to the string, i.e. offset 0 is the first
+   * character of the string. If the string is only a subset of a larger string
+   * the offsets must be adjusted manually.
+   *
+   * @param source - Source code.
+   * @param filename - Optional filename to set in the resulting
+   * `Source`. Defauls to `"inline"`.
+   */
+  static fromString(source, filename) {
+    const ast = espree.parse(source, {
+      ecmaVersion: "latest",
+      sourceType: "module",
+      loc: true
+    });
+    return new TemplateExtractor(ast, filename || "inline", source);
+  }
+  /**
+   * Extract object properties.
+   *
+   * Given a key `"template"` this method finds all objects literals with a
+   * `"template"` property and creates a [[Source]] instance with proper offsets
+   * with the value of the property. For instance:
+   *
+   * ```
+   * const myObj = {
+   *   foo: 'bar',
+   * };
+   * ```
+   *
+   * The above snippet would yield a `Source` with the content `bar`.
+   *
+   */
+  extractObjectProperty(key) {
+    const result = [];
+    const { filename, data } = this;
+    const node = this.ast;
+    walk.simple(node, {
+      Property(node2) {
+        if (compareKey(node2.key, key, filename)) {
+          const source = extractLiteral(node2.value, filename, data);
+          if (source) {
+            source.filename = filename;
+            result.push(source);
+          }
+        }
+      }
+    });
+    return result;
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  TemplateExtractor,
+  positionFromOffset,
+  positionToOffset
+});

package/dist/index.d.ts

@@ -0,0 +1,75 @@
+import { Source } from 'html-validate';
+
+/**
+ * Represents line and column.
+ *
+ * @public
+ * @since 1.0.0
+ */
+export declare interface Position {
+    /** Line number (First line is 1) */
+    line: number;
+    /** Column number (first column is 1) */
+    column: number;
+}
+
+/**
+ * Given an offset into a source, calculate the corresponding line and column.
+ *
+ * @public
+ * @since 1.0.0
+ */
+export declare function positionFromOffset(text: string, offset: number): [line: number, column: number];
+
+/**
+ * Compute source offset from line and column and the given markup.
+ *
+ * @public
+ * @since 1.0.0
+ * @param position - Line and column.
+ * @param data - Source markup.
+ * @returns The byte offset into the markup which line and column corresponds to.
+ */
+export declare function positionToOffset(position: Position, data: string): number;
+
+/**
+ * @public
+ * @since 1.0.0
+ */
+export declare class TemplateExtractor {
+    private ast;
+    private filename;
+    private data;
+    private constructor();
+    /**
+     * Create a new [[TemplateExtractor]] from javascript source code.
+     *
+     * `Source` offsets will be relative to the string, i.e. offset 0 is the first
+     * character of the string. If the string is only a subset of a larger string
+     * the offsets must be adjusted manually.
+     *
+     * @param source - Source code.
+     * @param filename - Optional filename to set in the resulting
+     * `Source`. Defauls to `"inline"`.
+     */
+    static fromString(source: string, filename?: string): TemplateExtractor;
+    /**
+     * Extract object properties.
+     *
+     * Given a key `"template"` this method finds all objects literals with a
+     * `"template"` property and creates a [[Source]] instance with proper offsets
+     * with the value of the property. For instance:
+     *
+     * ```
+     * const myObj = {
+     *   foo: 'bar',
+     * };
+     * ```
+     *
+     * The above snippet would yield a `Source` with the content `bar`.
+     *
+     */
+    extractObjectProperty(key: string): Source[];
+}
+
+export { }

package/dist/index.esm.js

@@ -0,0 +1,171 @@
+// src/position-from-offset.ts
+function positionFromOffset(text, offset) {
+  let line = 1;
+  let prev = 0;
+  let pos = text.indexOf("\n");
+  while (pos !== -1) {
+    if (pos >= offset) {
+      return [line, offset - prev + 1];
+    }
+    line++;
+    prev = pos + 1;
+    pos = text.indexOf("\n", pos + 1);
+  }
+  return [line, offset - prev + 1];
+}
+
+// src/position-to-offset.ts
+function positionToOffset(position, data) {
+  let line = position.line;
+  let column = position.column + 1;
+  for (let i = 0; i < data.length; i++) {
+    if (line > 1) {
+      if (data[i] === "\n") {
+        line--;
+      }
+    } else if (column > 1) {
+      column--;
+    } else {
+      return i;
+    }
+  }
+  throw new Error("Failed to compute location offset from position");
+}
+
+// src/template-extractor.ts
+import * as espree from "espree";
+import * as walk from "acorn-walk";
+function joinTemplateLiteral(nodes) {
+  let offset = nodes[0].start + 1;
+  let output = "";
+  for (const node of nodes) {
+    output += " ".repeat(node.start + 1 - offset);
+    output += node.value.raw;
+    offset = node.end - 2;
+  }
+  return output;
+}
+function extractLiteral(node, filename, data) {
+  switch (node.type) {
+    case "FunctionExpression":
+    case "Identifier":
+      return null;
+    case "Literal":
+      if (typeof node.value !== "string") {
+        return null;
+      }
+      return {
+        data: node.value.toString(),
+        filename,
+        line: node.loc.start.line,
+        column: node.loc.start.column + 1,
+        offset: positionToOffset(node.loc.start, data) + 1
+      };
+    case "TemplateLiteral":
+      return {
+        data: joinTemplateLiteral(node.quasis),
+        filename,
+        line: node.loc.start.line,
+        column: node.loc.start.column + 1,
+        offset: positionToOffset(node.loc.start, data) + 1
+      };
+    case "TaggedTemplateExpression":
+      return {
+        data: joinTemplateLiteral(node.quasi.quasis),
+        filename,
+        line: node.quasi.loc.start.line,
+        column: node.quasi.loc.start.column + 1,
+        offset: positionToOffset(node.quasi.loc.start, data) + 1
+      };
+    case "ArrowFunctionExpression": {
+      const whitelist = ["Literal", "TemplateLiteral"];
+      if (whitelist.includes(node.body.type)) {
+        return extractLiteral(node.body, filename, data);
+      } else {
+        return null;
+      }
+    }
+    default: {
+      const loc = node.loc.start;
+      const context = `${filename}:${loc.line}:${loc.column}`;
+      throw new Error(`Unhandled node type "${node.type}" at "${context}" in extractLiteral`);
+    }
+  }
+}
+function compareKey(node, key, filename) {
+  switch (node.type) {
+    case "Identifier":
+      return node.name === key;
+    case "Literal":
+      return node.value === key;
+    default: {
+      const loc = node.loc.start;
+      const context = `${filename}:${loc.line}:${loc.column}`;
+      throw new Error(`Unhandled node type "${node.type}" at "${context}" in compareKey`);
+    }
+  }
+}
+var TemplateExtractor = class {
+  constructor(ast, filename, data) {
+    this.ast = ast;
+    this.filename = filename;
+    this.data = data;
+  }
+  /**
+   * Create a new [[TemplateExtractor]] from javascript source code.
+   *
+   * `Source` offsets will be relative to the string, i.e. offset 0 is the first
+   * character of the string. If the string is only a subset of a larger string
+   * the offsets must be adjusted manually.
+   *
+   * @param source - Source code.
+   * @param filename - Optional filename to set in the resulting
+   * `Source`. Defauls to `"inline"`.
+   */
+  static fromString(source, filename) {
+    const ast = espree.parse(source, {
+      ecmaVersion: "latest",
+      sourceType: "module",
+      loc: true
+    });
+    return new TemplateExtractor(ast, filename || "inline", source);
+  }
+  /**
+   * Extract object properties.
+   *
+   * Given a key `"template"` this method finds all objects literals with a
+   * `"template"` property and creates a [[Source]] instance with proper offsets
+   * with the value of the property. For instance:
+   *
+   * ```
+   * const myObj = {
+   *   foo: 'bar',
+   * };
+   * ```
+   *
+   * The above snippet would yield a `Source` with the content `bar`.
+   *
+   */
+  extractObjectProperty(key) {
+    const result = [];
+    const { filename, data } = this;
+    const node = this.ast;
+    walk.simple(node, {
+      Property(node2) {
+        if (compareKey(node2.key, key, filename)) {
+          const source = extractLiteral(node2.value, filename, data);
+          if (source) {
+            source.filename = filename;
+            result.push(source);
+          }
+        }
+      }
+    });
+    return result;
+  }
+};
+export {
+  TemplateExtractor,
+  positionFromOffset,
+  positionToOffset
+};

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.34.9"
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@html-validate/plugin-utils",
+  "version": "1.0.0",
+  "description": "Plugin utilities and helpers for writing plugins to HTML-Validate",
+  "keywords": [
+    "html-validate"
+  ],
+  "homepage": "https://html-validate.org",
+  "bugs": {
+    "url": "https://gitlab.com/html-validate/plugin-utils/issues/new"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.com/html-validate/plugin-utils.git"
+  },
+  "license": "MIT",
+  "author": "David Sveningsson <ext@sidvind.com>",
+  "sideEffects": false,
+  "type": "commonjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs.js",
+      "import": "./dist/index.esm.js"
+    }
+  },
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.esm.js",
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "acorn-walk": "^8",
+    "espree": "^9",
+    "html-validate": "^5 || ^6 || ^7"
+  },
+  "engines": {
+    "node": ">= 16.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}