biome-plugin-suitescript 0.1.0 → 0.2.0

package/dist/rules/noModuleScopeApiCalls.js

@@ -0,0 +1,39 @@
+import { ast, defineRule, registerDiagnostic, } from "@biomejs/runtime/plugin";
+import { pairs, parseDefine } from "../lib/define.js";
+const FUNCTIONS = [
+    "JS_FUNCTION_EXPRESSION",
+    "JS_ARROW_FUNCTION_EXPRESSION",
+    "JS_FUNCTION_DECLARATION",
+    "JS_METHOD_OBJECT_MEMBER",
+    "JS_METHOD_CLASS_MEMBER",
+];
+// N/ APIs called while the define() callback runs (module scope) can fail on
+// deploy; initialize lazily from an entry point instead. N/log is exempt.
+export const noModuleScopeApiCalls = defineRule({
+    query: ast("JS_CALL_EXPRESSION"),
+    run(node) {
+        const def = parseDefine(node);
+        if (!def?.body)
+            return;
+        const aliases = new Set(pairs(def)
+            .filter((d) => d.name?.startsWith("N/") && d.name !== "N/log")
+            .map((d) => d.param?.text));
+        const visit = (n) => {
+            if (FUNCTIONS.includes(n.kind))
+                return;
+            if (n.kind === "JS_CALL_EXPRESSION") {
+                const callee = n.children()[0];
+                const object = callee?.kind === "JS_STATIC_MEMBER_EXPRESSION"
+                    ? callee.children()[0]?.text
+                    : undefined;
+                if (object && aliases.has(object)) {
+                    registerDiagnostic(n, "warning", `${callee?.text}() runs at module scope; call it from an entry point.`);
+                }
+            }
+            for (const child of n.children())
+                visit(child);
+        };
+        for (const child of def.body.children())
+            visit(child);
+    },
+});

package/dist/rules/noNativeIterators.js

@@ -0,0 +1,16 @@
+import { ast, defineRule, registerDiagnostic } from "@biomejs/runtime/plugin";
+// NetSuite runs GraalJS; Oracle's guidance is to use array methods, not
+// generators or Symbol.iterator.
+export const noNativeIterators = defineRule({
+    query: ast("JS_FUNCTION_DECLARATION", "JS_FUNCTION_EXPRESSION", "JS_STATIC_MEMBER_EXPRESSION"),
+    run(node) {
+        if (node.kind === "JS_STATIC_MEMBER_EXPRESSION") {
+            if (node.text === "Symbol.iterator") {
+                registerDiagnostic(node, "warning", "Avoid Symbol.iterator.");
+            }
+        }
+        else if (node.starToken) {
+            registerDiagnostic(node, "warning", "Avoid generator functions.");
+        }
+    },
+});

package/dist/rules/noQueryColumnFieldAndFormula.js

@@ -0,0 +1,19 @@
+import { ast, defineRule, registerDiagnostic } from "@biomejs/runtime/plugin";
+import { hasProperty } from "../lib/log.js";
+// Oracle (N/query): a column's `formula` and `fieldId` "cannot be set at the same time."
+export const noQueryColumnFieldAndFormula = defineRule({
+    query: ast("JS_OBJECT_EXPRESSION"),
+    run(node) {
+        if (!hasProperty(node, "fieldId") || !hasProperty(node, "formula"))
+            return;
+        const inColumn = node.ancestors().some((a) => {
+            if (a.kind === "JS_CALL_EXPRESSION")
+                return /createColumn$/.test(a.children()[0]?.text ?? "");
+            return (a.kind === "JS_PROPERTY_OBJECT_MEMBER" &&
+                a.children()[0]?.text === "columns");
+        });
+        if (inColumn) {
+            registerDiagnostic(node, "error", "A query column cannot set both fieldId and formula.");
+        }
+    },
+});

package/dist/rules/noRecordInLoop.js

@@ -0,0 +1,31 @@
+import { ast, defineRule, registerDiagnostic } from "@biomejs/runtime/plugin";
+const LOOPS = [
+    "JS_FOR_STATEMENT",
+    "JS_FOR_OF_STATEMENT",
+    "JS_FOR_IN_STATEMENT",
+    "JS_WHILE_STATEMENT",
+    "JS_DO_WHILE_STATEMENT",
+];
+const ITERATORS = /\.(forEach|each|map)$/;
+const RECORD_CALLS = ["record.load", "record.create"];
+// Loading or creating a record per iteration burns governance; search or
+// submitFields in bulk instead. Opt-in: Map/Reduce `map` handles one record per call.
+export const noRecordInLoop = defineRule({
+    query: ast("JS_CALL_EXPRESSION"),
+    run(node) {
+        if (!RECORD_CALLS.includes(node.callee?.text ?? ""))
+            return;
+        const inLoop = node.ancestors().some((a) => {
+            if (LOOPS.includes(a.kind))
+                return true;
+            if (a.kind !== "JS_CALL_ARGUMENT_LIST")
+                return false;
+            const call = a.parent?.parent;
+            return (call?.kind === "JS_CALL_EXPRESSION" &&
+                ITERATORS.test(call.children()[0]?.text ?? ""));
+        });
+        if (inLoop) {
+            registerDiagnostic(node, "warning", `${node.callee?.text}() inside a loop; use a search or submitFields instead.`);
+        }
+    },
+});

package/dist/rules/noSuiteScript1Api.js

@@ -0,0 +1,10 @@
+import { ast, defineRule, registerDiagnostic } from "@biomejs/runtime/plugin";
+// SuiteScript 2.1 only: nlapiXxx functions and nlobjXxx objects are 1.0 leftovers.
+export const noSuiteScript1Api = defineRule({
+    query: ast("JS_REFERENCE_IDENTIFIER"),
+    run(node) {
+        if (/^(nlapi|nlobj)[A-Z]/.test(node.text)) {
+            registerDiagnostic(node, "error", `'${node.text}' is SuiteScript 1.0; use the SuiteScript 2.1 N/ modules.`);
+        }
+    },
+});

package/dist/rules/noUserEventContextSave.js

@@ -0,0 +1,12 @@
+import { ast, defineRule, registerDiagnostic } from "@biomejs/runtime/plugin";
+// Oracle: "You can't use record.Record.save() here" for the newRecord and
+// oldRecord of a user event context; load the record to change it instead.
+export const noUserEventContextSave = defineRule({
+    query: ast("JS_CALL_EXPRESSION"),
+    run(node) {
+        const callee = node.callee?.text ?? "";
+        if (/(^|\.)(newRecord|oldRecord)\.save$/.test(callee)) {
+            registerDiagnostic(node, "error", `${callee}() is not allowed; the context record is read-only.`);
+        }
+    },
+});

package/dist/rules/noWrongScriptTypeModules.js

@@ -0,0 +1,28 @@
+import { ast, defineRule, registerDiagnostic } from "@biomejs/runtime/plugin";
+import { dependencies } from "../lib/biome-modules.js";
+import { misplacedModule, sideOf, unsupportedModule, } from "../lib/module-script-types.js";
+import { inferredTypes } from "../lib/script-side.js";
+// Loading a client-only module in a server script (or the reverse), or a module
+// a script type does not support, fails at runtime. The type comes from the
+// entry points the module returns, so libraries and uninferable modules are
+// never flagged.
+export const noWrongScriptTypeModules = defineRule({
+    query: ast("JS_CALL_EXPRESSION", "JS_IMPORT"),
+    run(node) {
+        const deps = dependencies(node);
+        if (deps.length === 0)
+            return;
+        const types = inferredTypes(node);
+        if (!types)
+            return;
+        const side = sideOf(types);
+        const single = types.length === 1 ? types[0]?.name : undefined;
+        for (const { name, nameNode } of deps) {
+            const message = name &&
+                ((side && misplacedModule(side, name)) ||
+                    (single && unsupportedModule(single, name)));
+            if (message && nameNode)
+                registerDiagnostic(nameNode, "error", message);
+        }
+    },
+});

package/dist/rules/requireClientValidateReturn.js

@@ -0,0 +1,27 @@
+import { ast, defineRule, registerDiagnostic } from "@biomejs/runtime/plugin";
+import { descendants, functionName, scriptSide } from "../lib/script-side.js";
+const VALIDATORS = [
+    "saveRecord",
+    "validateField",
+    "validateLine",
+    "validateInsert",
+    "validateDelete",
+];
+// Oracle: saveRecord and validateField return "true ... false otherwise". Only a
+// body with no `return <value>` at all is flagged; code paths are not analysed.
+export const requireClientValidateReturn = defineRule({
+    query: ast("JS_FUNCTION_DECLARATION", "JS_FUNCTION_EXPRESSION", "JS_ARROW_FUNCTION_EXPRESSION", "JS_METHOD_OBJECT_MEMBER"),
+    run(node) {
+        const name = functionName(node);
+        if (!name || !VALIDATORS.includes(name))
+            return;
+        const body = node.children().find((c) => c.kind === "JS_FUNCTION_BODY");
+        if (!body || scriptSide(node) !== "client")
+            return;
+        for (const d of descendants(body)) {
+            if (d.kind === "JS_RETURN_STATEMENT" && d.children().length > 0)
+                return;
+        }
+        registerDiagnostic(node, "warning", `'${name}' must return true or false.`);
+    },
+});

package/dist/rules/requireCustpagePrefix.js

@@ -0,0 +1,22 @@
+import { ast, defineRule, registerDiagnostic } from "@biomejs/runtime/plugin";
+const ADDERS = /\.(addField|addFieldGroup|addSublist|addTab|addSubtab|addButton)$/;
+// Oracle: the internal ID of a UI object added to a page "must be prefixed with
+// custpage". Only a string literal `id` is checked.
+export const requireCustpagePrefix = defineRule({
+    query: ast("JS_CALL_EXPRESSION"),
+    run(node) {
+        if (!ADDERS.test(node.callee?.text ?? ""))
+            return;
+        const options = node.arguments?.children()[0]?.children()[0];
+        if (options?.kind !== "JS_OBJECT_EXPRESSION")
+            return;
+        for (const member of options.children()[0]?.children() ?? []) {
+            const [name, value] = member.children();
+            if (name?.text === "id" &&
+                value?.kind === "JS_STRING_LITERAL_EXPRESSION" &&
+                !/^['"]custpage/.test(value.text)) {
+                registerDiagnostic(value, "warning", "The id of a UI object must start with 'custpage'.");
+            }
+        }
+    },
+});

package/package.json

@@ -1,83 +1,83 @@
-{
-  "name": "biome-plugin-suitescript",
-  "version": "0.1.0",
-  "description": "Biome lint plugins and configs for NetSuite SuiteScript 1.0/2.x, inspired by eslint-plugin-suitescript.",
-  "keywords": [
-    "biome-plugin",
-    "biome",
-    "suitescript",
-    "netsuite",
-    "lint"
-  ],
-  "homepage": "https://github.com/nemchik/biome-plugin-suitescript#readme",
-  "bugs": "https://github.com/nemchik/biome-plugin-suitescript/issues",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/nemchik/biome-plugin-suitescript.git"
-  },
-  "license": "MIT",
-  "author": "Eric Nemchik",
-  "type": "module",
-  "exports": {
-    "./schema.json": "./schema.json",
-    "biome": "./biome-manifest.json"
-  },
-  "bin": {
-    "biome-plugin-suitescript": "./dist/bin/biome-plugin-suitescript.js"
-  },
-  "files": [
-    "biome-manifest.json",
-    "configs",
-    "dist",
-    "schema.json",
-    "README.md",
-    "LICENSE"
-  ],
-  "scripts": {
-    "prebuild": "node -e \"require(\\\"node:fs\\\").rmSync(\\\"dist\\\",{recursive:true,force:true})\"",
-    "build": "tsc -p tsconfig.build.json && node scripts/build-manifest.ts",
-    "check": "biome check",
-    "preformat": "npm run typecheck",
-    "format": "biome check --write",
-    "lint": "biome lint",
-    "prepack": "npm run build",
-    "sync-modules": "node scripts/sync-modules.ts",
-    "pretest": "npm run build",
-    "test": "node --test test/*.test.ts",
-    "typecheck": "tsc"
-  },
-  "dependencies": {
-    "oxc-parser": "^0.156.0",
-    "tinyglobby": "^0.2.17"
-  },
-  "devDependencies": {
-    "@biomejs/biome": "2.6.4",
-    "@biomejs/runtime": "2.6.4",
-    "@hitc/netsuite-types": "2026.2.4",
-    "@types/node": "24.19.2",
-    "git-pull-run": "2.1.0",
-    "lefthook": "2.2.2",
-    "typescript": "7.0.2"
-  },
-  "peerDependencies": {
-    "@biomejs/biome": "^2.6.4"
-  },
-  "engines": {
-    "node": ">=24"
-  },
-  "devEngines": {
-    "runtime": {
-      "name": "node",
-      "version": "24.22.2",
-      "onFail": "error"
-    },
-    "packageManager": {
-      "name": "npm",
-      "version": "12.2.1",
-      "onFail": "warn"
-    }
-  },
-  "allowScripts": {
-    "lefthook": true
-  }
-}
+{
+  "name": "biome-plugin-suitescript",
+  "version": "0.2.0",
+  "description": "Biome lint plugins and a tag checker for NetSuite SuiteScript 2.1, ported from eslint-plugin-suitescript.",
+  "keywords": [
+    "biome-plugin",
+    "biome",
+    "suitescript",
+    "netsuite",
+    "lint"
+  ],
+  "homepage": "https://github.com/nemchik/biome-plugin-suitescript#readme",
+  "bugs": "https://github.com/nemchik/biome-plugin-suitescript/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nemchik/biome-plugin-suitescript.git"
+  },
+  "license": "MIT",
+  "author": "Eric Nemchik",
+  "type": "module",
+  "exports": {
+    "./schema.json": "./schema.json",
+    "biome": "./biome-manifest.json"
+  },
+  "bin": {
+    "biome-plugin-suitescript": "./dist/bin/biome-plugin-suitescript.js"
+  },
+  "files": [
+    "biome-manifest.json",
+    "configs",
+    "dist",
+    "schema.json",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "prebuild": "node -e \"require(\\\"node:fs\\\").rmSync(\\\"dist\\\",{recursive:true,force:true})\"",
+    "build": "tsc -p tsconfig.build.json && node scripts/build-manifest.ts",
+    "check": "biome check",
+    "preformat": "npm run typecheck",
+    "format": "biome check --write",
+    "lint": "biome lint",
+    "prepack": "npm run build",
+    "sync-modules": "node scripts/sync-modules.ts",
+    "pretest": "npm run build",
+    "test": "node --test test/*.test.ts",
+    "typecheck": "tsc"
+  },
+  "dependencies": {
+    "oxc-parser": "^0.156.0",
+    "tinyglobby": "^0.2.17"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "2.6.4",
+    "@biomejs/runtime": "2.6.4",
+    "@hitc/netsuite-types": "2026.2.4",
+    "@types/node": "24.19.2",
+    "git-pull-run": "2.1.0",
+    "lefthook": "2.2.2",
+    "typescript": "7.0.2"
+  },
+  "peerDependencies": {
+    "@biomejs/biome": "^2.6.4"
+  },
+  "engines": {
+    "node": ">=24"
+  },
+  "devEngines": {
+    "runtime": {
+      "name": "node",
+      "version": "24.22.2",
+      "onFail": "error"
+    },
+    "packageManager": {
+      "name": "npm",
+      "version": "12.2.1",
+      "onFail": "warn"
+    }
+  },
+  "allowScripts": {
+    "lefthook": true
+  }
+}

package/schema.json

@@ -1,21 +1,21 @@
-{
-  "$id": "https://github.com/nemchik/biome-plugin-suitescript/schema.json",
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "additionalProperties": false,
-  "description": "Configuration for the `biome-plugin-suitescript check` command.",
-  "properties": {
-    "$schema": { "type": "string" },
-    "includes": {
-      "description": "Glob patterns of SuiteScript source files to check: files deployed to the file cabinet, or the sources they are transpiled from (not the transpiled output). Prefix a pattern with ! to exclude, as in Biome's `includes`.",
-      "examples": [
-        ["src/TypeScripts/**/*.{js,ts}", "!**/*.d.ts", "!**/*.test.*"]
-      ],
-      "items": { "minLength": 1, "type": "string" },
-      "minItems": 1,
-      "type": "array"
-    }
-  },
-  "required": ["includes"],
-  "title": "biome-plugin-suitescript configuration",
-  "type": "object"
-}
+{
+  "$id": "https://github.com/nemchik/biome-plugin-suitescript/schema.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": false,
+  "description": "Configuration for the `biome-plugin-suitescript check` command.",
+  "properties": {
+    "$schema": { "type": "string" },
+    "includes": {
+      "description": "Glob patterns of SuiteScript source files to check: files deployed to the file cabinet, or the sources they are transpiled from (not the transpiled output). Prefix a pattern with ! to exclude, as in Biome's `includes`.",
+      "examples": [
+        ["src/TypeScripts/**/*.{js,ts}", "!**/*.d.ts", "!**/*.test.*"]
+      ],
+      "items": { "minLength": 1, "type": "string" },
+      "minItems": 1,
+      "type": "array"
+    }
+  },
+  "required": ["includes"],
+  "title": "biome-plugin-suitescript configuration",
+  "type": "object"
+}