sh-ast 0.0.0 → 0.1.0

package/generated/position-fields.d.ts

@@ -0,0 +1,21 @@
+// Code generated by tools/gen-visitor-keys from mvdan.cc/sh/v3 v3.13.1. DO NOT EDIT.
+// See design/ARCHITECTURE.md, "The schema table is generated, not hand-written".
+/**
+ * `nodeType -> fieldName[]` for every field whose static Go type is
+ * `syntax.Pos` — a real position (byte offset + line + column), never
+ * child data. Keyed by the exact, unlowercased Go field name, matching
+ * typedjson's raw JSON keys (the same convention `CHILD_TYPE_SCHEMA`
+ * uses) — `normalize()`'s `buildFields` looks fields up here by the raw
+ * key it sees in `Object.entries(node)`, before lowercasing.
+ *
+ * Scoped per (nodeType, fieldName) rather than a single global set of
+ * bare names: mvdan/sh reuses field names across unrelated struct
+ * shapes (`Do`, `Dollar`, `Select`, `Until`, `Unsigned`, ...), and a
+ * bare-name denylist can't tell a real position apart from real data
+ * that merely happens to share a field name with one, in a different
+ * node type. See design/ARCHITECTURE.md, "The schema table is
+ * generated, not hand-written", and issue #8.
+ *
+ * @internal
+ */
+export declare const POSITION_FIELDS: Record<string, string[]>;

package/generated/position-fields.js

@@ -0,0 +1,50 @@
+// Code generated by tools/gen-visitor-keys from mvdan.cc/sh/v3 v3.13.1. DO NOT EDIT.
+// See design/ARCHITECTURE.md, "The schema table is generated, not hand-written".
+export const POSITION_FIELDS = {
+  ArithmCmd: ['Left', 'Right'],
+  ArithmExp: ['Left', 'Right'],
+  ArrayElem: [],
+  ArrayExpr: ['Lparen', 'Rparen'],
+  Assign: [],
+  BinaryArithm: ['OpPos'],
+  BinaryCmd: ['OpPos'],
+  BinaryTest: ['OpPos'],
+  Block: ['Lbrace', 'Rbrace'],
+  BraceExp: [],
+  CStyleLoop: ['Lparen', 'Rparen'],
+  CallExpr: [],
+  CaseClause: ['Case', 'Esac', 'In'],
+  CaseItem: ['OpPos'],
+  CmdSubst: ['Left', 'Right'],
+  Comment: ['Hash'],
+  CoprocClause: ['Coproc'],
+  DblQuoted: ['Left', 'Right'],
+  DeclClause: [],
+  Expansion: [],
+  ExtGlob: ['OpPos'],
+  File: [],
+  FlagsArithm: [],
+  ForClause: ['DoPos', 'DonePos', 'ForPos'],
+  FuncDecl: ['Position'],
+  IfClause: ['FiPos', 'Position', 'ThenPos'],
+  LetClause: ['Let'],
+  Lit: ['ValueEnd', 'ValuePos'],
+  ParamExp: ['Dollar', 'Rbrace'],
+  ParenArithm: ['Lparen', 'Rparen'],
+  ParenTest: ['Lparen', 'Rparen'],
+  ProcSubst: ['OpPos', 'Rparen'],
+  Redirect: ['OpPos'],
+  Replace: [],
+  SglQuoted: ['Left', 'Right'],
+  Slice: [],
+  Stmt: ['Position', 'Semicolon'],
+  Subshell: ['Lparen', 'Rparen'],
+  TestClause: ['Left', 'Right'],
+  TestDecl: ['Position'],
+  TimeClause: ['Time'],
+  UnaryArithm: ['OpPos'],
+  UnaryTest: ['OpPos'],
+  WhileClause: ['DoPos', 'DonePos', 'WhilePos'],
+  Word: [],
+  WordIter: ['InPos'],
+};

package/generated/visitor-keys.d.ts

@@ -0,0 +1,11 @@
+// Code generated by tools/gen-visitor-keys from mvdan.cc/sh/v3 v3.13.1. DO NOT EDIT.
+// See design/ARCHITECTURE.md, "The schema table is generated, not hand-written".
+/**
+ * Per-node-type traversal keys (lowercased field names, matching the
+ * normalizer's output shape). See design/ARCHITECTURE.md, "The schema
+ * table is generated, not hand-written" — re-exported publicly via
+ * `src/visitor-keys.ts`.
+ *
+ * @internal
+ */
+export declare const visitorKeys: Record<string, string[]>;

package/generated/visitor-keys.js

@@ -0,0 +1,50 @@
+// Code generated by tools/gen-visitor-keys from mvdan.cc/sh/v3 v3.13.1. DO NOT EDIT.
+// See design/ARCHITECTURE.md, "The schema table is generated, not hand-written".
+export const visitorKeys = {
+  ArithmCmd: ['x'],
+  ArithmExp: ['x'],
+  ArrayElem: ['comments', 'index', 'value'],
+  ArrayExpr: ['elems', 'last'],
+  Assign: ['array', 'index', 'name', 'value'],
+  BinaryArithm: ['x', 'y'],
+  BinaryCmd: ['x', 'y'],
+  BinaryTest: ['x', 'y'],
+  Block: ['last', 'stmts'],
+  BraceExp: ['elems'],
+  CStyleLoop: ['cond', 'init', 'post'],
+  CallExpr: ['args', 'assigns'],
+  CaseClause: ['items', 'last', 'word'],
+  CaseItem: ['comments', 'last', 'patterns', 'stmts'],
+  CmdSubst: ['last', 'stmts'],
+  Comment: [],
+  CoprocClause: ['name', 'stmt'],
+  DblQuoted: ['parts'],
+  DeclClause: ['args', 'variant'],
+  Expansion: ['word'],
+  ExtGlob: ['pattern'],
+  File: ['last', 'stmts'],
+  FlagsArithm: ['flags', 'x'],
+  ForClause: ['do', 'dolast', 'loop'],
+  FuncDecl: ['body', 'name', 'names'],
+  IfClause: ['cond', 'condlast', 'else', 'last', 'then', 'thenlast'],
+  LetClause: ['exprs'],
+  Lit: [],
+  ParamExp: ['exp', 'flags', 'index', 'modifiers', 'nestedparam', 'param', 'repl', 'slice'],
+  ParenArithm: ['x'],
+  ParenTest: ['x'],
+  ProcSubst: ['last', 'stmts'],
+  Redirect: ['hdoc', 'n', 'word'],
+  Replace: ['orig', 'with'],
+  SglQuoted: [],
+  Slice: ['length', 'offset'],
+  Stmt: ['cmd', 'comments', 'redirs'],
+  Subshell: ['last', 'stmts'],
+  TestClause: ['x'],
+  TestDecl: ['body', 'description'],
+  TimeClause: ['stmt'],
+  UnaryArithm: ['x'],
+  UnaryTest: ['x'],
+  WhileClause: ['cond', 'condlast', 'do', 'dolast'],
+  Word: ['parts'],
+  WordIter: ['items', 'name'],
+};

package/package.json

@@ -1,13 +1,96 @@
 {
   "name": "sh-ast",
-  "version": "0.0.0",
-  "description": "",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+  "description": "Synchronous shell-script parser (mvdan/sh via WASM) with a normalized, UTF-16-safe AST.",
+  "version": "0.1.0",
+  "author": "Mike North <michael.l.north@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mike-north/sh-ast.git",
+    "directory": "packages/sh-ast"
+  },
+  "homepage": "https://github.com/mike-north/sh-ast/tree/main/packages/sh-ast#readme",
+  "bugs": {
+    "url": "https://github.com/mike-north/sh-ast/issues"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/sh-ast.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./analyze": {
+      "types": "./dist/analyze.d.ts",
+      "default": "./dist/analyze/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "generated/*.js",
+    "generated/*.d.ts",
+    "shim/sh-ast.wasm",
+    "shim/wasm_exec.js"
+  ],
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "nx": {
+    "targets": {
+      "build": {
+        "outputs": [
+          "{projectRoot}/dist/**/*.js",
+          "{projectRoot}/dist/**/*.js.map",
+          "{projectRoot}/dist/**/*.d.ts",
+          "{projectRoot}/dist/**/*.d.ts.map",
+          "!{projectRoot}/dist/sh-ast.d.ts",
+          "!{projectRoot}/dist/analyze.d.ts"
+        ]
+      },
+      "check:api-report": {
+        "outputs": [
+          "{projectRoot}/api-report",
+          "{projectRoot}/temp",
+          "{projectRoot}/dist/sh-ast.d.ts",
+          "{projectRoot}/dist/analyze.d.ts"
+        ]
+      },
+      "uplevel-api-reports": {
+        "dependsOn": [
+          "check:api-report"
+        ],
+        "cache": true,
+        "inputs": [
+          "{projectRoot}/api-report/**",
+          "{projectRoot}/temp/**"
+        ],
+        "outputs": [
+          "{workspaceRoot}/api-report-combined/sh-ast.api.md",
+          "{workspaceRoot}/api-docs-temp/sh-ast.api.json",
+          "{workspaceRoot}/api-report-combined/sh-ast-analyze.api.md",
+          "{workspaceRoot}/api-docs-temp/sh-ast-analyze.api.json"
+        ]
+      }
+    }
   },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "type": "commonjs"
-}
+  "publishConfig": {
+    "access": "public"
+  },
+  "tsd": {
+    "compilerOptions": {
+      "composite": false
+    }
+  },
+  "type": "module",
+  "types": "./dist/sh-ast.d.ts",
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "check": "concurrently -n lint,types,api-report \"pnpm run check:lint-ts\" \"pnpm run check:typecheck\" \"pnpm run check:api-report\"",
+    "check:api-report": "api-extractor run && api-extractor run --config analyze/api-extractor.json",
+    "check:lint-ts": "eslint .",
+    "check:typecheck": "tsc --noEmit",
+    "clean": "rimraf --glob dist \"temp/*\" \"*.tsbuildinfo\"",
+    "fix:api-report": "api-extractor run --local && api-extractor run --local --config analyze/api-extractor.json",
+    "fix:lint-ts": "eslint . --fix",
+    "test": "concurrently -n vitest,tsd \"pnpm run test:ts\" \"pnpm run test:types\"",
+    "test:ts": "vitest run",
+    "test:types": "tsd",
+    "uplevel-api-reports": "mkdir -p ../../api-report-combined ../../api-docs-temp && cp api-report/sh-ast.api.md api-report/sh-ast-analyze.api.md ../../api-report-combined/ && cp temp/sh-ast.api.json temp/sh-ast-analyze.api.json ../../api-docs-temp/"
+  }
+}