swc-plugin-keys 0.1.1

package/README.md

@@ -0,0 +1,75 @@
+# swc-plugin-keys
+
+An SWC plugin that transforms `keys<T>()` calls into compile-time arrays of object keys derived from TypeScript type aliases.
+
+## Install
+
+```bash
+npm install swc-plugin-keys
+```
+
+## Setup
+
+Add the plugin to your SWC config (`.swcrc`, `next.config.js`, or programmatic usage):
+
+```json
+{
+  "jsc": {
+    "experimental": {
+      "plugins": [["swc-plugin-keys", {}]]
+    }
+  }
+}
+```
+
+## Usage
+
+Import `keys` and call it with a type argument. The plugin replaces each call with a string array literal at compile time.
+
+### Input
+
+```typescript
+import { keys } from 'swc-plugin-keys';
+
+type User = {
+  name: string;
+  age: number;
+  email: string;
+};
+
+const userKeys = keys<User>();
+```
+
+### Output
+
+```javascript
+const userKeys = ["name", "age", "email"];
+```
+
+The import is removed and the `keys<User>()` call is replaced with the actual property names from the type alias.
+
+## Configuration
+
+### `include`
+
+An array of glob patterns. When specified, only files whose path matches at least one pattern will be processed. Files that don't match are passed through untouched, avoiding unnecessary work.
+
+```json
+{
+  "jsc": {
+    "experimental": {
+      "plugins": [
+        ["swc-plugin-keys", { "include": ["src/models/**/*.ts"] }]
+      ]
+    }
+  }
+}
+```
+
+When `include` is omitted or empty, all files are processed (default behavior).
+
+## Limitations
+
+- Only resolves type aliases defined as type literals (`type Foo = { ... }`). Interfaces, mapped types, and intersection/union types are not supported.
+- The type alias must be defined in the same file as the `keys()` call.
+- When the type argument cannot be resolved, `keys()` falls back to an empty array `[]`.

package/index.d.ts

@@ -0,0 +1 @@
+export declare function keys<T>(): (keyof T)[];

package/index.js

@@ -0,0 +1,6 @@
+export function keys() {
+  throw new Error(
+    "swc-plugin-keys: keys() must be compiled away by the SWC plugin. " +
+    "Ensure the plugin is configured in your SWC config."
+  );
+}

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "swc-plugin-keys",
+  "version": "0.1.1",
+  "description": "SWC plugin that transforms keys<T>() calls into arrays of object keys derived from TypeScript types",
+  "main": "swc_plugin_keys.wasm",
+  "types": "index.d.ts",
+  "module": "index.js",
+  "scripts": {
+    "prepack": "cargo build-wasip1 --release && cp target/wasm32-wasip1/release/swc_plugin_keys.wasm ."
+  },
+  "files": [
+    "swc_plugin_keys.wasm",
+    "index.js",
+    "index.d.ts"
+  ],
+  "license": "MIT"
+}