@cloudalgo/eslint-parser-apex 0.1.5

package/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, CloudAlgo
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/dist/index.d.ts

@@ -0,0 +1,42 @@
+export interface ApexNode {
+    type: string;
+    /** Children — the only property ESLint traverses via visitorKeys. */
+    body: ApexNode[];
+    loc: {
+        start: Pos;
+        end: Pos;
+    };
+    range: [number, number];
+    /** Original ANTLR context, unwrapped in the plugin adapter so rules get it. */
+    _antlr: any;
+}
+interface Pos {
+    line: number;
+    column: number;
+}
+export declare const visitorKeys: Record<string, string[]>;
+export interface ParseResult {
+    ast: any;
+    visitorKeys: Record<string, string[]>;
+    /** Syntax errors collected during parse. */
+    errors: Array<{
+        line: number;
+        column: number;
+        message: string;
+    }>;
+}
+/**
+ * ESLint custom parser entrypoint.
+ * ESLint calls `parseForESLint(text, options)` first; falls back to `parse`.
+ */
+export declare function parse(text: string, _options?: unknown): any;
+declare const defaultExport: {
+    parse: typeof parse;
+    parseForESLint: typeof parseForESLint;
+    meta: {
+        name: string;
+        version: string;
+    };
+};
+export default defaultExport;
+export declare function parseForESLint(text: string, _options?: unknown): ParseResult;

package/dist/index.js

@@ -0,0 +1,114 @@
+import { ApexParserFactory } from "@apexdevtools/apex-parser";
+// ESLint needs to know which property holds children for each node type.
+// We use a single "body" property for all types, so every type maps to ['body'].
+export const visitorKeys = new Proxy({}, { get: (_t, _k) => ["body"] });
+// ─── ANTLR → ESTree conversion ────────────────────────────────────────────────
+function toPos(token, isEnd = false) {
+    if (!token)
+        return { line: 1, column: 0 };
+    return {
+        line: token.line ?? 1,
+        column: isEnd
+            ? (token.column ?? 0) + (token.text?.length ?? 1)
+            : (token.column ?? 0),
+    };
+}
+function convertNode(antlr) {
+    const start = antlr.start;
+    const stop = antlr.stop;
+    const node = {
+        type: antlr.constructor?.name ?? "Unknown",
+        body: [],
+        loc: {
+            start: toPos(start, false),
+            end: toPos(stop, true),
+        },
+        range: [start?.startIndex ?? 0, (stop?.stopIndex ?? 0) + 1],
+        _antlr: antlr,
+    };
+    const count = antlr.getChildCount?.() ?? 0;
+    for (let i = 0; i < count; i++) {
+        const child = antlr.getChild(i);
+        // Only recurse into context nodes; skip terminal tokens
+        if (child?.constructor?.name?.endsWith("Context")) {
+            node.body.push(convertNode(child));
+        }
+    }
+    return node;
+}
+/**
+ * Extract ANTLR tokens from the token stream into ESLint's token format.
+ * ESLint's SourceCode constructor validates that `ast.tokens` exists and is
+ * an array; the content is used for eslint-disable comments and token-level
+ * rules. We include all non-hidden-channel tokens.
+ */
+function extractTokens(parser, vocabulary) {
+    const stream = parser.inputStream ?? parser.tokenStream ?? parser._input;
+    if (!stream)
+        return [];
+    // Fill the stream so all tokens are available
+    stream.fill?.();
+    const raw = stream.tokens ?? [];
+    return raw
+        .filter((t) => t.channel === 0 && t.type !== -1 /* EOF */)
+        .map((t) => {
+        const typeName = vocabulary?.getSymbolicName?.(t.type) ??
+            vocabulary?.getLiteralName?.(t.type) ??
+            "Token";
+        const text = t.text ?? "";
+        const startCol = t.column ?? 0;
+        const endCol = startCol + text.length;
+        return {
+            type: typeName,
+            value: text,
+            range: [t.startIndex ?? 0, (t.stopIndex ?? 0) + 1],
+            loc: {
+                start: { line: t.line ?? 1, column: startCol },
+                end: { line: t.line ?? 1, column: endCol },
+            },
+        };
+    });
+}
+// ─── Parse entrypoint ─────────────────────────────────────────────────────────
+const TRIGGER_RE = /^\s*(?:\/\/[^\n]*\n\s*)*trigger\b/i;
+/** Synthetic root wrapping the real root so ESLint sees type="Program". */
+function wrapAsProgram(root, tokens) {
+    return {
+        type: "Program",
+        body: [root],
+        loc: root.loc,
+        range: root.range,
+        _antlr: root._antlr,
+        tokens,
+        comments: [],
+    };
+}
+/**
+ * ESLint custom parser entrypoint.
+ * ESLint calls `parseForESLint(text, options)` first; falls back to `parse`.
+ */
+export function parse(text, _options) {
+    return parseForESLint(text, _options).ast;
+}
+const defaultExport = { parse, parseForESLint, meta: { name: "@cloudalgo/eslint-parser-apex", version: "0.1.0" } };
+export default defaultExport;
+export function parseForESLint(text, _options) {
+    const errors = [];
+    const parser = ApexParserFactory.createParser(text, false);
+    parser.removeErrorListeners();
+    parser.addErrorListener({
+        syntaxError: (_r, _o, line, column, msg) => {
+            errors.push({ line, column, message: msg });
+        },
+        reportAmbiguity: () => { },
+        reportAttemptingFullContext: () => { },
+        reportContextSensitivity: () => { },
+    });
+    const antlrRoot = TRIGGER_RE.test(text)
+        ? parser.triggerUnit()
+        : parser.compilationUnit();
+    const tokens = extractTokens(parser, parser.vocabulary);
+    const ast = wrapAsProgram(convertNode(antlrRoot), tokens);
+    return { ast, visitorKeys, errors };
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAmB9D,yEAAyE;AACzE,iFAAiF;AACjF,MAAM,CAAC,MAAM,WAAW,GAA6B,IAAI,KAAK,CAC5D,EAA8B,EAC9B,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAC9B,CAAC;AAEF,iFAAiF;AAEjF,SAAS,KAAK,CAAC,KAAU,EAAE,KAAK,GAAG,KAAK;IACtC,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IAC1C,OAAO;QACL,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC;QACrB,MAAM,EAAE,KAAK;YACX,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC;KACxB,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,KAAU;IAC7B,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;IAC1B,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;IAExB,MAAM,IAAI,GAAa;QACrB,IAAI,EAAE,KAAK,CAAC,WAAW,EAAE,IAAI,IAAI,SAAS;QAC1C,IAAI,EAAE,EAAE;QACR,GAAG,EAAE;YACH,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC;YAC1B,GAAG,EAAE,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC;SACvB;QACD,KAAK,EAAE,CAAC,KAAK,EAAE,UAAU,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,SAAS,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QAC3D,MAAM,EAAE,KAAK;KACd,CAAC;IAEF,MAAM,KAAK,GAAG,KAAK,CAAC,aAAa,EAAE,EAAE,IAAI,CAAC,CAAC;IAC3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;QAC/B,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAChC,wDAAwD;QACxD,IAAI,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YAClD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAWD;;;;;GAKG;AACH,SAAS,aAAa,CAAC,MAAW,EAAE,UAAe;IACjD,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,MAAM,CAAC;IACzE,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IACvB,8CAA8C;IAC9C,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;IAChB,MAAM,GAAG,GAAU,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC;IAEvC,OAAO,GAAG;SACP,MAAM,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;SAC9D,GAAG,CAAC,CAAC,CAAM,EAAE,EAAE;QACd,MAAM,QAAQ,GACZ,UAAU,EAAE,eAAe,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;YACrC,UAAU,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;YACpC,OAAO,CAAC;QACV,MAAM,IAAI,GAAW,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;QAClC,MAAM,QAAQ,GAAW,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC;QACvC,MAAM,MAAM,GAAW,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC;QAC9C,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,IAAI;YACX,KAAK,EAAE,CAAC,CAAC,CAAC,UAAU,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC,GAAG,CAAC,CAAqB;YACtE,GAAG,EAAE;gBACH,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE;gBAC9C,GAAG,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE;aAC3C;SACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACP,CAAC;AAED,iFAAiF;AAEjF,MAAM,UAAU,GAAG,oCAAoC,CAAC;AAExD,2EAA2E;AAC3E,SAAS,aAAa,CAAC,IAAc,EAAE,MAAqB;IAC1D,OAAO;QACL,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,CAAC,IAAI,CAAC;QACZ,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,MAAM;QACN,QAAQ,EAAE,EAAE;KACb,CAAC;AACJ,CAAC;AASD;;;GAGG;AACH,MAAM,UAAU,KAAK,CAAC,IAAY,EAAE,QAAkB;IACpD,OAAO,cAAc,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,GAAG,CAAC;AAC5C,CAAC;AAED,MAAM,aAAa,GAAG,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,+BAA+B,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC;AACnH,eAAe,aAAa,CAAC;AAE7B,MAAM,UAAU,cAAc,CAC5B,IAAY,EACZ,QAAkB;IAElB,MAAM,MAAM,GAA0B,EAAE,CAAC;IAEzC,MAAM,MAAM,GAAG,iBAAiB,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC3D,MAAM,CAAC,oBAAoB,EAAE,CAAC;IAC9B,MAAM,CAAC,gBAAgB,CAAC;QACtB,WAAW,EAAE,CACX,EAAW,EACX,EAAW,EACX,IAAY,EACZ,MAAc,EACd,GAAW,EACX,EAAE;YACF,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;QAC9C,CAAC;QACD,eAAe,EAAE,GAAG,EAAE,GAAE,CAAC;QACzB,2BAA2B,EAAE,GAAG,EAAE,GAAE,CAAC;QACrC,wBAAwB,EAAE,GAAG,EAAE,GAAE,CAAC;KAC5B,CAAC,CAAC;IAEV,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC;QACrC,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE;QACtB,CAAC,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;IAE7B,MAAM,MAAM,GAAG,aAAa,CAAC,MAAM,EAAG,MAAc,CAAC,UAAU,CAAC,CAAC;IACjE,MAAM,GAAG,GAAG,aAAa,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,CAAC;IAC1D,OAAO,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC;AACtC,CAAC"}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@cloudalgo/eslint-parser-apex",
+  "version": "0.1.5",
+  "description": "ESLint custom parser for Salesforce Apex — bridges @apexdevtools/apex-parser to ESTree",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@apexdevtools/apex-parser": "^5.0.0"
+  },
+  "license": "BSD-3-Clause",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cloudalgo/apex-lint"
+  },
+  "homepage": "https://github.com/cloudalgo/apex-lint#readme",
+  "bugs": {
+    "url": "https://github.com/cloudalgo/apex-lint/issues"
+  },
+  "keywords": [
+    "salesforce",
+    "apex",
+    "eslint",
+    "parser"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  }
+}