@formspec/eslint-plugin 0.1.0-alpha.10

package/dist/utils/type-utils.js

@@ -0,0 +1,216 @@
+/**
+ * Utility functions for TypeScript type checking in ESLint rules.
+ */
+/**
+ * Checks if a TypeScript type is a string type.
+ *
+ * Handles string primitives, string literals, and unions of string types.
+ *
+ * @param type - The TypeScript type to check
+ * @param checker - The TypeScript type checker instance
+ * @returns True if the type is string, a string literal, or a union of string types
+ */
+export function isStringType(type, checker) {
+    // Check for string primitive
+    if (type.flags & 4 /* ts.TypeFlags.String */) {
+        return true;
+    }
+    // Check for string literal
+    if (type.flags & 128 /* ts.TypeFlags.StringLiteral */) {
+        return true;
+    }
+    // Check for union of string literals (e.g., "a" | "b")
+    if (type.isUnion()) {
+        return type.types.every((t) => isStringType(t, checker));
+    }
+    return false;
+}
+/**
+ * Checks if a TypeScript type is a number type.
+ *
+ * Handles number primitives, number literals, and unions of number types.
+ *
+ * @param type - The TypeScript type to check
+ * @param checker - The TypeScript type checker instance
+ * @returns True if the type is number, a number literal, or a union of number types
+ */
+export function isNumberType(type, checker) {
+    // Check for number primitive
+    if (type.flags & 8 /* ts.TypeFlags.Number */) {
+        return true;
+    }
+    // Check for number literal
+    if (type.flags & 256 /* ts.TypeFlags.NumberLiteral */) {
+        return true;
+    }
+    // Check for union of number literals
+    if (type.isUnion()) {
+        return type.types.every((t) => isNumberType(t, checker));
+    }
+    return false;
+}
+/**
+ * Checks if a TypeScript type is a boolean type.
+ *
+ * Handles boolean primitives, boolean literals (true/false), and unions of boolean types.
+ *
+ * @param type - The TypeScript type to check
+ * @param checker - The TypeScript type checker instance
+ * @returns True if the type is boolean, true, false, or a union of boolean types
+ */
+export function isBooleanType(type, checker) {
+    // Check for boolean primitive
+    if (type.flags & 16 /* ts.TypeFlags.Boolean */) {
+        return true;
+    }
+    // Check for boolean literal (true or false)
+    if (type.flags & 512 /* ts.TypeFlags.BooleanLiteral */) {
+        return true;
+    }
+    // Check for union of true | false
+    if (type.isUnion()) {
+        return type.types.every((t) => isBooleanType(t, checker));
+    }
+    return false;
+}
+/**
+ * Checks if a TypeScript type is an array type.
+ *
+ * Handles Array<T>, T[], and readonly arrays.
+ *
+ * @param type - The TypeScript type to check
+ * @param checker - The TypeScript type checker instance
+ * @returns True if the type is an array type
+ */
+export function isArrayType(type, checker) {
+    // Check symbol name for Array
+    const symbol = type.getSymbol();
+    if (symbol?.name === "Array") {
+        return true;
+    }
+    // Check for array type node (T[])
+    const typeString = checker.typeToString(type);
+    if (typeString.endsWith("[]") || typeString.startsWith("Array<")) {
+        return true;
+    }
+    // Check if it's a reference to Array
+    const typeRef = type;
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- target may not exist on non-reference types
+    if (typeRef.target && typeRef.target.symbol?.name === "Array") {
+        return true;
+    }
+    return false;
+}
+/**
+ * Strips `undefined` and `null` from a union type.
+ *
+ * Optional fields (`field?: string`) have type `string | undefined`. This
+ * function returns the non-nullish part so that type categorization works
+ * correctly for optional fields.
+ *
+ * If the type is not a union or all constituents are nullish, returns the
+ * original type unchanged.
+ */
+function stripNullishFromUnion(type) {
+    if (!type.isUnion())
+        return type;
+    const nonNullish = type.types.filter((t) => !((t.flags & (32768 | 65536)) /* ts.TypeFlags.Undefined | ts.TypeFlags.Null */));
+    if (nonNullish.length === 0)
+        return type;
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- length check above guarantees element exists
+    if (nonNullish.length === 1)
+        return nonNullish[0];
+    // Still a union after stripping — return original (union categorization applies)
+    return type;
+}
+/**
+ * Determines the field type category from a TypeScript type.
+ *
+ * Categories help determine which decorators are valid for a field.
+ *
+ * @param type - The TypeScript type to categorize
+ * @param checker - The TypeScript type checker instance
+ * @returns The field type category
+ */
+export function getFieldTypeCategory(type, checker) {
+    // Strip undefined/null from union types (e.g., optional fields: string | undefined → string)
+    const stripped = stripNullishFromUnion(type);
+    if (isStringType(stripped, checker))
+        return "string";
+    if (isNumberType(stripped, checker))
+        return "number";
+    if (isBooleanType(stripped, checker))
+        return "boolean";
+    if (isArrayType(stripped, checker))
+        return "array";
+    // Check for object types (but not arrays)
+    if (stripped.flags & 524288 /* ts.TypeFlags.Object */) {
+        return "object";
+    }
+    // Check for unions that aren't all strings/numbers
+    if (stripped.isUnion()) {
+        return "union";
+    }
+    return "unknown";
+}
+/**
+ * Gets the TypeScript type of a class property.
+ */
+export function getPropertyType(node, services) {
+    try {
+        const checker = services.program.getTypeChecker();
+        const tsNode = services.esTreeNodeToTSNodeMap.get(node);
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- map.get() can return undefined
+        if (!tsNode)
+            return null;
+        // Get the type from the type annotation or initializer
+        const type = checker.getTypeAtLocation(tsNode);
+        return type;
+    }
+    catch {
+        return null;
+    }
+}
+/**
+ * Extracts string literal values from a union type.
+ * For type "a" | "b" | "c", returns ["a", "b", "c"].
+ */
+export function getStringLiteralUnionValues(type, _checker) {
+    if (!type.isUnion()) {
+        // Single string literal
+        if (type.isStringLiteral()) {
+            return [type.value];
+        }
+        return null;
+    }
+    const values = [];
+    for (const t of type.types) {
+        if (t.isStringLiteral()) {
+            values.push(t.value);
+        }
+        else {
+            // Not all members are string literals
+            return null;
+        }
+    }
+    return values.length > 0 ? values : null;
+}
+/**
+ * Checks if a field is marked as optional (has `?` modifier).
+ */
+export function isOptionalProperty(node) {
+    return node.optional;
+}
+/**
+ * Gets the type checker from parser services.
+ */
+export function getTypeChecker(services) {
+    return services.program.getTypeChecker();
+}
+/**
+ * Converts a TypeScript type to a readable string.
+ */
+export function typeToString(type, checker) {
+    return checker.typeToString(type);
+}
+//# sourceMappingURL=type-utils.js.map

package/dist/utils/type-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-utils.js","sourceRoot":"","sources":["../../src/utils/type-utils.ts"],"names":[],"mappings":"AAAA;;GAEG;AAkBH;;;;;;;;GAQG;AACH,MAAM,UAAU,YAAY,CAAC,IAAa,EAAE,OAAuB;IACjE,6BAA6B;IAC7B,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,yBAAyB,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,2BAA2B;IAC3B,IAAI,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,gCAAgC,EAAE,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,uDAAuD;IACvD,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;QACnB,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,YAAY,CAAC,IAAa,EAAE,OAAuB;IACjE,6BAA6B;IAC7B,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,yBAAyB,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,2BAA2B;IAC3B,IAAI,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,gCAAgC,EAAE,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,qCAAqC;IACrC,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;QACnB,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,aAAa,CAAC,IAAa,EAAE,OAAuB;IAClE,8BAA8B;IAC9B,IAAI,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC,0BAA0B,EAAE,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,4CAA4C;IAC5C,IAAI,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,iCAAiC,EAAE,CAAC;QACvD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kCAAkC;IAClC,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;QACnB,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,WAAW,CAAC,IAAa,EAAE,OAAuB;IAChE,8BAA8B;IAC9B,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;IAChC,IAAI,MAAM,EAAE,IAAI,KAAK,OAAO,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kCAAkC;IAClC,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC9C,IAAI,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QACjE,OAAO,IAAI,CAAC;IACd,CAAC;IAED,qCAAqC;IACrC,MAAM,OAAO,GAAG,IAAwB,CAAC;IACzC,sHAAsH;IACtH,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,KAAK,OAAO,EAAE,CAAC;QAC9D,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,qBAAqB,CAAC,IAAa;IAC1C,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;QAAE,OAAO,IAAI,CAAC;IAEjC,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAClC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,gDAAgD,CAAC,CACvF,CAAC;IAEF,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACzC,oHAAoH;IACpH,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,UAAU,CAAC,CAAC,CAAE,CAAC;IAEnD,iFAAiF;IACjF,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAAa,EAAE,OAAuB;IACzE,6FAA6F;IAC7F,MAAM,QAAQ,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAE7C,IAAI,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC;QAAE,OAAO,QAAQ,CAAC;IACrD,IAAI,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC;QAAE,OAAO,QAAQ,CAAC;IACrD,IAAI,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC;QAAE,OAAO,SAAS,CAAC;IACvD,IAAI,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC;QAAE,OAAO,OAAO,CAAC;IAEnD,0CAA0C;IAC1C,IAAI,QAAQ,CAAC,KAAK,GAAG,MAAM,CAAC,yBAAyB,EAAE,CAAC;QACtD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,mDAAmD;IACnD,IAAI,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC;QACvB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAC7B,IAAiC,EACjC,QAA2C;IAE3C,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;QAClD,MAAM,MAAM,GAAG,QAAQ,CAAC,qBAAqB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAExD,yGAAyG;QACzG,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC;QAEzB,uDAAuD;QACvD,MAAM,IAAI,GAAG,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,2BAA2B,CACzC,IAAa,EACb,QAAwB;IAExB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;QACpB,wBAAwB;QACxB,IAAI,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC;YAC3B,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAC3B,IAAI,CAAC,CAAC,eAAe,EAAE,EAAE,CAAC;YACxB,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;aAAM,CAAC;YACN,sCAAsC;YACtC,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;AAC3C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAiC;IAClE,OAAO,IAAI,CAAC,QAAQ,CAAC;AACvB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,QAA2C;IACxE,OAAO,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;AAC3C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,IAAa,EAAE,OAAuB;IACjE,OAAO,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;AACpC,CAAC"}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@formspec/eslint-plugin",
+  "version": "0.1.0-alpha.10",
+  "description": "ESLint rules for FormSpec decorator DSL type safety",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/eslint-plugin.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/eslint-plugin.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@typescript-eslint/utils": "^8.0.0",
+    "@formspec/constraints": "0.1.0-alpha.10",
+    "@formspec/core": "0.1.0-alpha.10"
+  },
+  "peerDependencies": {
+    "eslint": "^9.0.0",
+    "typescript": "^5.0.0"
+  },
+  "devDependencies": {
+    "@typescript-eslint/rule-tester": "^8.0.0",
+    "vitest": "^3.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "UNLICENSED",
+  "keywords": [
+    "eslint",
+    "eslint-plugin",
+    "formspec",
+    "decorators",
+    "typescript"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist temp",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "api-extractor": "api-extractor run",
+    "api-extractor:local": "api-extractor run --local",
+    "api-documenter": "api-documenter markdown -i temp -o docs"
+  }
+}