@kattebak/typespec-enum-emitter 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 kattebak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,135 @@
+# TypeSpec Enum Emitter
+
+A custom TypeSpec emitter that exports enums as JavaScript const objects with proper TypeScript type definitions.
+
+## Features
+
+- Converts TypeSpec enums to JavaScript const objects
+- Generates TypeScript declaration files (.d.ts)
+- Supports string and numeric enum values
+- Uses the TypeSpec emitter framework
+
+## Installation
+
+```bash
+npm install typespec-enum-emitter
+```
+
+## Usage
+
+### 1. Create a TypeSpec file with enums
+
+```typespec
+import "typespec-enum-emitter";
+
+enum Status {
+	Active,
+	Inactive,
+	Pending,
+}
+
+enum Priority {
+	Low: "low",
+	Medium: "medium",
+	High: "high",
+}
+
+enum HttpStatusCode {
+	OK: 200,
+	NotFound: 404,
+	InternalServerError: 500,
+}
+```
+
+### 2. Configure tspconfig.yaml
+
+```yaml
+emit:
+  - @kattebak/typespec-enum-emitter
+options:
+  typespec-enum-emitter:
+    output-file: "enums.js"
+```
+
+### 3. Compile
+
+```bash
+npx tsp compile .
+```
+
+### 4. Generated Output
+
+**enums.js:**
+
+```javascript
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+
+export const Status = {
+  Active: "Active",
+  Inactive: "Inactive",
+  Pending: "Pending",
+};
+
+export const Priority = {
+  Low: "low",
+  Medium: "medium",
+  High: "high",
+};
+
+export const HttpStatusCode = {
+  OK: 200,
+  NotFound: 404,
+  InternalServerError: 500,
+};
+```
+
+**enums.d.ts:**
+
+```typescript
+export declare const Status: {
+  readonly Active: "Active";
+  readonly Inactive: "Inactive";
+  readonly Pending: "Pending";
+};
+
+export declare const Priority: {
+  readonly Low: "low";
+  readonly Medium: "medium";
+  readonly High: "high";
+};
+
+export declare const HttpStatusCode: {
+  readonly OK: 200;
+  readonly NotFound: 404;
+  readonly InternalServerError: 500;
+};
+```
+
+## Configuration Options
+
+- `output-file`: Name of the output file (default: "enums.js")
+- `output-dir`: Output directory (defaults to emitter output directory)
+
+## Why Use This?
+
+TypeScript enums have some quirks:
+
+- They generate runtime code that can be hard to tree-shake
+- Const enums don't preserve values at runtime
+- Regular enums can have unexpected behavior with numeric values
+
+This emitter generates simple const objects that:
+
+- Are fully tree-shakeable
+- Have clear runtime behavior
+- Work seamlessly with TypeScript's type system
+- Are easy to inspect and debug
+
+## Implementation
+
+Built using the TypeSpec emitter framework with:
+
+- `@typespec/compiler` for AST traversal
+- Namespace-aware enum collection
+- Proper TypeScript declaration generation

package/dist/emitter.d.ts

@@ -0,0 +1,4 @@
+import type { EmitContext } from "@typespec/compiler";
+import type { EnumEmitterOptions } from "./lib.js";
+export declare function $onEmit(context: EmitContext<EnumEmitterOptions>): Promise<void>;
+//# sourceMappingURL=emitter.d.ts.map

package/dist/emitter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"emitter.d.ts","sourceRoot":"","sources":["../src/emitter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAQtD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAEnD,wBAAsB,OAAO,CAAC,OAAO,EAAE,WAAW,CAAC,kBAAkB,CAAC,iBAmCrE"}

package/dist/emitter.js

@@ -0,0 +1,68 @@
+import { emitFile, resolvePath, } from "@typespec/compiler";
+export async function $onEmit(context) {
+    const enums = [];
+    function collectEnums(namespace) {
+        for (const [_, type] of namespace.enums) {
+            enums.push(type);
+        }
+        for (const [_, ns] of namespace.namespaces) {
+            collectEnums(ns);
+        }
+    }
+    const globalNamespace = context.program.getGlobalNamespaceType();
+    collectEnums(globalNamespace);
+    if (enums.length === 0) {
+        return;
+    }
+    const outputDir = context.emitterOutputDir;
+    const outputFile = context.options["output-file"] ?? "enums.js";
+    const jsContent = generateJavaScript(enums);
+    const tsContent = generateTypeScript(enums);
+    await emitFile(context.program, {
+        path: resolvePath(outputDir, outputFile),
+        content: jsContent,
+    });
+    await emitFile(context.program, {
+        path: resolvePath(outputDir, outputFile.replace(".js", ".d.ts")),
+        content: tsContent,
+    });
+}
+function generateJavaScript(enums) {
+    const enumDefinitions = enums
+        .map((enumType) => {
+        const members = Array.from(enumType.members.values());
+        const enumObject = generateEnumObject(members);
+        return `export const ${enumType.name} = ${enumObject};`;
+    })
+        .join("\n\n");
+    return `"use strict";\nObject.defineProperty(exports, "__esModule", { value: true });\n\n${enumDefinitions}\n`;
+}
+function generateEnumObject(members) {
+    const entries = members
+        .map((member) => {
+        const key = member.name;
+        const value = member.value ?? member.name;
+        const valueStr = typeof value === "string" ? `"${value}"` : value;
+        return `\t${key}: ${valueStr}`;
+    })
+        .join(",\n");
+    return `{\n${entries}\n}`;
+}
+function generateTypeScript(enums) {
+    const enumDeclarations = enums
+        .map((enumType) => {
+        const members = Array.from(enumType.members.values());
+        const memberTypes = members
+            .map((member) => {
+            const key = member.name;
+            const value = member.value ?? member.name;
+            const valueStr = typeof value === "string" ? `"${value}"` : value;
+            return `\treadonly ${key}: ${valueStr}`;
+        })
+            .join(";\n");
+        return `export declare const ${enumType.name}: {\n${memberTypes}\n};`;
+    })
+        .join("\n\n");
+    return `${enumDeclarations}\n`;
+}
+//# sourceMappingURL=emitter.js.map

package/dist/emitter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"emitter.js","sourceRoot":"","sources":["../src/emitter.ts"],"names":[],"mappings":"AACA,OAAO,EAGN,QAAQ,EAER,WAAW,GACX,MAAM,oBAAoB,CAAC;AAG5B,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,OAAwC;IACrE,MAAM,KAAK,GAAW,EAAE,CAAC;IAEzB,SAAS,YAAY,CAAC,SAAoB;QACzC,KAAK,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;YACzC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,CAAC;QAED,KAAK,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,SAAS,CAAC,UAAU,EAAE,CAAC;YAC5C,YAAY,CAAC,EAAE,CAAC,CAAC;QAClB,CAAC;IACF,CAAC;IAED,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,sBAAsB,EAAE,CAAC;IACjE,YAAY,CAAC,eAAe,CAAC,CAAC;IAE9B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO;IACR,CAAC;IAED,MAAM,SAAS,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAC3C,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,UAAU,CAAC;IAEhE,MAAM,SAAS,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAC5C,MAAM,SAAS,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAE5C,MAAM,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE;QAC/B,IAAI,EAAE,WAAW,CAAC,SAAS,EAAE,UAAU,CAAC;QACxC,OAAO,EAAE,SAAS;KAClB,CAAC,CAAC;IAEH,MAAM,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE;QAC/B,IAAI,EAAE,WAAW,CAAC,SAAS,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAChE,OAAO,EAAE,SAAS;KAClB,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,kBAAkB,CAAC,KAAa;IACxC,MAAM,eAAe,GAAG,KAAK;SAC3B,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;QACjB,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QACtD,MAAM,UAAU,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAE/C,OAAO,gBAAgB,QAAQ,CAAC,IAAI,MAAM,UAAU,GAAG,CAAC;IACzD,CAAC,CAAC;SACD,IAAI,CAAC,MAAM,CAAC,CAAC;IAEf,OAAO,oFAAoF,eAAe,IAAI,CAAC;AAChH,CAAC;AAED,SAAS,kBAAkB,CAAC,OAAqB;IAChD,MAAM,OAAO,GAAG,OAAO;SACrB,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QACf,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC;QAC1C,MAAM,QAAQ,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC;QAClE,OAAO,KAAK,GAAG,KAAK,QAAQ,EAAE,CAAC;IAChC,CAAC,CAAC;SACD,IAAI,CAAC,KAAK,CAAC,CAAC;IAEd,OAAO,MAAM,OAAO,KAAK,CAAC;AAC3B,CAAC;AAED,SAAS,kBAAkB,CAAC,KAAa;IACxC,MAAM,gBAAgB,GAAG,KAAK;SAC5B,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;QACjB,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QACtD,MAAM,WAAW,GAAG,OAAO;aACzB,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YACf,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC;YACxB,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC;YAC1C,MAAM,QAAQ,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC;YAClE,OAAO,cAAc,GAAG,KAAK,QAAQ,EAAE,CAAC;QACzC,CAAC,CAAC;aACD,IAAI,CAAC,KAAK,CAAC,CAAC;QAEd,OAAO,wBAAwB,QAAQ,CAAC,IAAI,QAAQ,WAAW,MAAM,CAAC;IACvE,CAAC,CAAC;SACD,IAAI,CAAC,MAAM,CAAC,CAAC;IAEf,OAAO,GAAG,gBAAgB,IAAI,CAAC;AAChC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./emitter.js";
+export { $lib } from "./lib.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export * from "./emitter.js";
+export { $lib } from "./lib.js";
+//# 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,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC"}

package/dist/lib.d.ts

@@ -0,0 +1,23 @@
+export interface EnumEmitterOptions {
+    "output-dir"?: string;
+    "output-file"?: string;
+}
+export declare const $lib: {
+    "emitter-options-schema": {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly properties: {
+            readonly "output-dir": {
+                readonly type: "string";
+                readonly nullable: true;
+            };
+            readonly "output-file": {
+                readonly type: "string";
+                readonly nullable: true;
+                readonly default: "enums.js";
+            };
+        };
+        readonly required: readonly [];
+    };
+};
+//# sourceMappingURL=lib.d.ts.map

package/dist/lib.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lib.d.ts","sourceRoot":"","sources":["../src/lib.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,kBAAkB;IAClC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;CAUhB,CAAC"}

package/dist/lib.js

@@ -0,0 +1,12 @@
+export const $lib = {
+    "emitter-options-schema": {
+        type: "object",
+        additionalProperties: false,
+        properties: {
+            "output-dir": { type: "string", nullable: true },
+            "output-file": { type: "string", nullable: true, default: "enums.js" },
+        },
+        required: [],
+    },
+};
+//# sourceMappingURL=lib.js.map

package/dist/lib.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lib.js","sourceRoot":"","sources":["../src/lib.ts"],"names":[],"mappings":"AAKA,MAAM,CAAC,MAAM,IAAI,GAAG;IACnB,wBAAwB,EAAE;QACzB,IAAI,EAAE,QAAQ;QACd,oBAAoB,EAAE,KAAK;QAC3B,UAAU,EAAE;YACX,YAAY,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;YAChD,aAAa,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE;SACtE;QACD,QAAQ,EAAE,EAAE;KACH;CACV,CAAC"}

package/package.json

@@ -0,0 +1,33 @@
+{
+	"name": "@kattebak/typespec-enum-emitter",
+	"version": "1.1.0",
+	"description": "TypeSpec emitter for JavaScript const enums",
+	"type": "module",
+	"main": "dist/index.js",
+	"publishConfig": {
+		"access": "public"
+	},
+	"files": [
+		"dist",
+		"tsp"
+	],
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"default": "./dist/index.js",
+			"typespec": "./tsp/main.tsp"
+		}
+	},
+	"scripts": {
+		"build": "tsc",
+		"watch": "tsc --watch",
+		"test": "npm run build && npm run lint",
+		"fix": "npx @biomejs/biome check --write",
+		"lint": "npx @biomejs/biome check"
+	},
+	"devDependencies": {
+		"@biomejs/biome": "2.3.7",
+		"@typespec/compiler": "^1.4.0",
+		"typescript": "^5.9.3"
+	}
+}

package/tsp/main.tsp

@@ -0,0 +1 @@
+import "../dist/index.js";