@cloudalgo/eslint-plugin-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/adapter.d.ts

@@ -0,0 +1,11 @@
+import type { Rule } from "@cloudalgo/apex-core";
+import type { MetadataProvider } from "@cloudalgo/apex-core";
+/**
+ * Wrap one apex-core Rule into an ESLint Rule.
+ *
+ * Key design: ESLint traverses the converted ESTree (ApexNode with `body`
+ * children), but our handlers need the original ANTLR context. The ESTree
+ * nodes carry `_antlr`; we unwrap it before dispatching to rule handlers.
+ * This lets all 15 rules run unchanged — they never know they're inside ESLint.
+ */
+export declare function toEslintRule(apexRule: Rule, getMetadata: () => MetadataProvider): any;

package/dist/adapter.js

@@ -0,0 +1,74 @@
+const SEV_TO_ESLINT = {
+    critical: "error",
+    high: "error",
+    moderate: "warn",
+    low: "warn",
+    info: "warn",
+};
+/**
+ * Wrap one apex-core Rule into an ESLint Rule.
+ *
+ * Key design: ESLint traverses the converted ESTree (ApexNode with `body`
+ * children), but our handlers need the original ANTLR context. The ESTree
+ * nodes carry `_antlr`; we unwrap it before dispatching to rule handlers.
+ * This lets all 15 rules run unchanged — they never know they're inside ESLint.
+ */
+export function toEslintRule(apexRule, getMetadata) {
+    return {
+        meta: {
+            type: "suggestion",
+            docs: {
+                description: apexRule.description,
+                category: apexRule.category,
+                recommended: true,
+                url: `https://github.com/cloudalgo/apex-lint#${apexRule.id.toLowerCase()}`,
+            },
+            schema: [],
+            messages: {
+                apex: "{{ message }}",
+            },
+        },
+        create(context) {
+            const filename = context.getFilename?.() ?? context.filename ?? "";
+            const ruleCtx = {
+                filePath: filename,
+                source: context.getSourceCode?.()?.getText?.() ?? "",
+                metadata: getMetadata(),
+                report(antlrNode, message) {
+                    const line = antlrNode?.start?.line ?? 1;
+                    const col = antlrNode?.start?.column ?? 0;
+                    context.report({
+                        // ESLint needs at least a loc or node; we use loc directly so
+                        // position comes from the ANTLR token, not the ESTree wrapper.
+                        loc: {
+                            start: { line, column: col },
+                            end: {
+                                line: antlrNode?.stop?.line ?? line,
+                                column: (antlrNode?.stop?.column ?? col) +
+                                    (antlrNode?.stop?.text?.length ?? 1),
+                            },
+                        },
+                        messageId: "apex",
+                        data: { message },
+                    });
+                },
+            };
+            // Our rule returns listeners keyed by ANTLR context type name.
+            // ESLint dispatches by the node's `type` property — which we set to the
+            // ANTLR constructor name in the parser. So the keys match directly.
+            const apexListeners = apexRule.create(ruleCtx);
+            const eslintListeners = {};
+            for (const [nodeType, handler] of Object.entries(apexListeners)) {
+                if (!handler)
+                    continue;
+                eslintListeners[nodeType] = (esNode) => {
+                    // Unwrap the ANTLR context stored during parse
+                    const antlrNode = esNode._antlr ?? esNode;
+                    handler(antlrNode);
+                };
+            }
+            return eslintListeners;
+        },
+    };
+}
+//# sourceMappingURL=adapter.js.map

package/dist/adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.js","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAGA,MAAM,aAAa,GAAuC;IACxD,QAAQ,EAAE,OAAO;IACjB,IAAI,EAAE,OAAO;IACb,QAAQ,EAAE,MAAM;IAChB,GAAG,EAAE,MAAM;IACX,IAAI,EAAE,MAAM;CACb,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAC1B,QAAc,EACd,WAAmC;IAEnC,OAAO;QACL,IAAI,EAAE;YACJ,IAAI,EAAE,YAAY;YAClB,IAAI,EAAE;gBACJ,WAAW,EAAE,QAAQ,CAAC,WAAW;gBACjC,QAAQ,EAAE,QAAQ,CAAC,QAAQ;gBAC3B,WAAW,EAAE,IAAI;gBACjB,GAAG,EAAE,0CAA0C,QAAQ,CAAC,EAAE,CAAC,WAAW,EAAE,EAAE;aAC3E;YACD,MAAM,EAAE,EAAE;YACV,QAAQ,EAAE;gBACR,IAAI,EAAE,eAAe;aACtB;SACF;QAED,MAAM,CAAC,OAAY;YACjB,MAAM,QAAQ,GACZ,OAAO,CAAC,WAAW,EAAE,EAAE,IAAI,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC;YAEpD,MAAM,OAAO,GAAgB;gBAC3B,QAAQ,EAAE,QAAQ;gBAClB,MAAM,EAAE,OAAO,CAAC,aAAa,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE;gBACpD,QAAQ,EAAE,WAAW,EAAE;gBACvB,MAAM,CAAC,SAAc,EAAE,OAAe;oBACpC,MAAM,IAAI,GAAW,SAAS,EAAE,KAAK,EAAE,IAAI,IAAI,CAAC,CAAC;oBACjD,MAAM,GAAG,GAAW,SAAS,EAAE,KAAK,EAAE,MAAM,IAAI,CAAC,CAAC;oBAClD,OAAO,CAAC,MAAM,CAAC;wBACb,8DAA8D;wBAC9D,+DAA+D;wBAC/D,GAAG,EAAE;4BACH,KAAK,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE;4BAC5B,GAAG,EAAE;gCACH,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,IAAI,IAAI;gCACnC,MAAM,EACJ,CAAC,SAAS,EAAE,IAAI,EAAE,MAAM,IAAI,GAAG,CAAC;oCAChC,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC,CAAC;6BACvC;yBACF;wBACD,SAAS,EAAE,MAAM;wBACjB,IAAI,EAAE,EAAE,OAAO,EAAE;qBAClB,CAAC,CAAC;gBACL,CAAC;aACF,CAAC;YAEF,+DAA+D;YAC/D,wEAAwE;YACxE,oEAAoE;YACpE,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC/C,MAAM,eAAe,GAA0C,EAAE,CAAC;YAElE,KAAK,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;gBAChE,IAAI,CAAC,OAAO;oBAAE,SAAS;gBACvB,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAW,EAAE,EAAE;oBAC1C,+CAA+C;oBAC/C,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC;oBAC1C,OAAO,CAAC,SAAS,CAAC,CAAC;gBACrB,CAAC,CAAC;YACJ,CAAC;YAED,OAAO,eAAe,CAAC;QACzB,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,68 @@
+import { parse, parseForESLint, visitorKeys } from "@cloudalgo/eslint-parser-apex";
+declare const rules: Record<string, any>;
+declare const parser: {
+    parse: typeof parse;
+    parseForESLint: typeof parseForESLint;
+    meta: {
+        name: string;
+        version: string;
+    };
+};
+declare const plugin: {
+    meta: {
+        name: string;
+        version: string;
+    };
+    /** The custom Apex parser — include in `parser:` for legacy config. */
+    parser: {
+        parse: typeof parse;
+        parseForESLint: typeof parseForESLint;
+        meta: {
+            name: string;
+            version: string;
+        };
+    };
+    rules: Record<string, any>;
+    /**
+     * Legacy eslintrc config (ESLint v8 and below):
+     *   { "extends": ["plugin:apex/recommended"] }
+     */
+    configs: {
+        recommended: {
+            parser: string;
+            plugins: string[];
+            rules: Record<string, string>;
+        };
+    };
+    /**
+     * Flat config objects (ESLint v9+):
+     *   import apex from '@cloudalgo/eslint-plugin-apex';
+     *   export default [ ...apex.flatConfigs.recommended ];
+     */
+    flatConfigs: {
+        recommended: readonly [{
+            readonly files: readonly ["**/*.cls", "**/*.trigger"];
+            readonly languageOptions: {
+                readonly parser: {
+                    parse: typeof parse;
+                    parseForESLint: typeof parseForESLint;
+                    meta: {
+                        name: string;
+                        version: string;
+                    };
+                };
+                readonly parserOptions: {
+                    readonly sourceType: "module";
+                };
+            };
+            readonly plugins: {
+                readonly apex: {
+                    readonly rules: Record<string, any>;
+                };
+            };
+            readonly rules: Record<string, string>;
+        }];
+    };
+};
+export default plugin;
+export { plugin, rules, parser, visitorKeys };

package/dist/index.js

@@ -0,0 +1,77 @@
+import { resolve } from "node:path";
+import { allRules, FilesystemMetadataProvider, NullMetadataProvider, } from "@cloudalgo/apex-core";
+import { parse, parseForESLint, visitorKeys } from "@cloudalgo/eslint-parser-apex";
+import { toEslintRule } from "./adapter.js";
+// ─── Metadata provider ────────────────────────────────────────────────────────
+// Rules that need SObject names (UnguardedCrudOperation) read metadataRoot
+// from the plugin's shared settings or fall back to cwd.
+function makeMetadataGetter(settings) {
+    let cached = null;
+    return () => {
+        if (cached)
+            return cached;
+        const root = settings?.["apex/metadataRoot"] ??
+            settings?.["apexMetadataRoot"];
+        cached = root
+            ? new FilesystemMetadataProvider([resolve(root)])
+            : new NullMetadataProvider();
+        return cached;
+    };
+}
+// ─── Rules ────────────────────────────────────────────────────────────────────
+const rules = {};
+for (const rule of allRules) {
+    // Use a lazy metadata getter — we don't have ESLint context at module load time
+    rules[rule.id] = toEslintRule(rule, makeMetadataGetter());
+}
+// ─── Parser re-export ─────────────────────────────────────────────────────────
+// Including the parser in the plugin lets users configure with just the plugin.
+const parser = { parse, parseForESLint, meta: { name: "@cloudalgo/eslint-parser-apex", version: "0.1.0" } };
+// ─── Recommended rule config ──────────────────────────────────────────────────
+const recommendedRules = {};
+for (const rule of allRules) {
+    const level = rule.severity === "critical" || rule.severity === "high" ? "error" : "warn";
+    recommendedRules[`apex/${rule.id}`] = level;
+}
+// ─── Plugin export (legacy + flat config) ─────────────────────────────────────
+const plugin = {
+    meta: {
+        name: "@cloudalgo/eslint-plugin-apex",
+        version: "0.1.0",
+    },
+    /** The custom Apex parser — include in `parser:` for legacy config. */
+    parser,
+    rules,
+    /**
+     * Legacy eslintrc config (ESLint v8 and below):
+     *   { "extends": ["plugin:apex/recommended"] }
+     */
+    configs: {
+        recommended: {
+            parser: "@cloudalgo/eslint-parser-apex",
+            plugins: ["apex"],
+            rules: recommendedRules,
+        },
+    },
+    /**
+     * Flat config objects (ESLint v9+):
+     *   import apex from '@cloudalgo/eslint-plugin-apex';
+     *   export default [ ...apex.flatConfigs.recommended ];
+     */
+    flatConfigs: {
+        recommended: [
+            {
+                files: ["**/*.cls", "**/*.trigger"],
+                languageOptions: {
+                    parser,
+                    parserOptions: { sourceType: "module" },
+                },
+                plugins: { apex: { rules } },
+                rules: recommendedRules,
+            },
+        ],
+    },
+};
+export default plugin;
+export { plugin, rules, parser, visitorKeys };
+//# 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,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EACL,QAAQ,EACR,0BAA0B,EAC1B,oBAAoB,GACrB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AACnF,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE5C,iFAAiF;AACjF,2EAA2E;AAC3E,yDAAyD;AAEzD,SAAS,kBAAkB,CAAC,QAAkC;IAC5D,IAAI,MAAM,GAA6D,IAAI,CAAC;IAC5E,OAAO,GAAG,EAAE;QACV,IAAI,MAAM;YAAE,OAAO,MAAM,CAAC;QAC1B,MAAM,IAAI,GACP,QAAQ,EAAE,CAAC,mBAAmB,CAAwB;YACtD,QAAQ,EAAE,CAAC,kBAAkB,CAAwB,CAAC;QACzD,MAAM,GAAG,IAAI;YACX,CAAC,CAAC,IAAI,0BAA0B,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;YACjD,CAAC,CAAC,IAAI,oBAAoB,EAAE,CAAC;QAC/B,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AAED,iFAAiF;AAEjF,MAAM,KAAK,GAAwB,EAAE,CAAC;AACtC,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;IAC5B,gFAAgF;IAChF,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,IAAI,EAAE,kBAAkB,EAAE,CAAC,CAAC;AAC5D,CAAC;AAED,iFAAiF;AACjF,gFAAgF;AAEhF,MAAM,MAAM,GAAG,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,+BAA+B,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC;AAE5G,iFAAiF;AAEjF,MAAM,gBAAgB,GAA2B,EAAE,CAAC;AACpD,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;IAC5B,MAAM,KAAK,GACT,IAAI,CAAC,QAAQ,KAAK,UAAU,IAAI,IAAI,CAAC,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;IAC9E,gBAAgB,CAAC,QAAQ,IAAI,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC;AAC9C,CAAC;AAED,iFAAiF;AAEjF,MAAM,MAAM,GAAG;IACb,IAAI,EAAE;QACJ,IAAI,EAAE,+BAA+B;QACrC,OAAO,EAAE,OAAO;KACjB;IAED,uEAAuE;IACvE,MAAM;IAEN,KAAK;IAEL;;;OAGG;IACH,OAAO,EAAE;QACP,WAAW,EAAE;YACX,MAAM,EAAE,+BAA+B;YACvC,OAAO,EAAE,CAAC,MAAM,CAAC;YACjB,KAAK,EAAE,gBAAgB;SACxB;KACF;IAED;;;;OAIG;IACH,WAAW,EAAE;QACX,WAAW,EAAE;YACX;gBACE,KAAK,EAAE,CAAC,UAAU,EAAE,cAAc,CAAC;gBACnC,eAAe,EAAE;oBACf,MAAM;oBACN,aAAa,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE;iBACxC;gBACD,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,EAAE;gBAC5B,KAAK,EAAE,gBAAgB;aACxB;SACO;KACX;CACF,CAAC;AAEF,eAAe,MAAM,CAAC;AACtB,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC"}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@cloudalgo/eslint-plugin-apex",
+  "version": "0.1.5",
+  "description": "ESLint plugin for Salesforce Apex — 15 rules for SOQL injection, governor limits, security and code quality",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@cloudalgo/apex-core": "0.1.5",
+    "@cloudalgo/eslint-parser-apex": "0.1.5"
+  },
+  "peerDependencies": {
+    "eslint": ">=8.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",
+    "eslint-plugin",
+    "lint",
+    "static-analysis"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  }
+}