unplugin-keywords 2.16.0 → 2.16.1

package/README.md

@@ -86,17 +86,15 @@ const _="b";const a={a:_,c:data};
   _Convention:_ `import * as K from '~keywords';`
 
 - **`~keywords/public` (Stable Hash):**
-  Generates deterministic, key-derived hashes (e.g., `"z2pL21k"`). Designed for **public-facing APIs** and structural contracts that must remain consistent across package boundaries (e.g., `package.json` exports).
+  Generates deterministic, key-derived hashes (e.g., `"z2pL21k"`). Designed for **public-facing APIs** and structural contracts that must remain consistent across package boundaries (e.g., RPC).
   _Convention:_ `import * as PK from '~keywords/public';`
 
-  > **Note:** If you are building libraries for consumers who also use this plugin, see **Library Integration** below for a more optimal approach.
-
 - **`~keywords/raw` (Literal String):**
   Yields the exact, unobfuscated string literal (e.g., `"function"`, `"click"`). Ideal for standard APIs and repeating language keywords. Ensures a single memory instance of the string across your bundle.
   _Convention:_ `import * as RK from '~keywords/raw';`
 
 **Module Separation:**
-To minimize bundle size, identifiers can be partitioned: use `PK.*` for properties exposed to consumers, use `RK.*` for deduplicating raw strings like `typeof fn === RK.function`, and obscure all internal state and private members behind the default `K.*`.
+To minimize bundle size, identifiers can be partitioned: use `PK.*` for contracts shared between packages, use `RK.*` for deduplicating raw strings like `typeof fn === RK.function`, and obscure all internal state and private members behind the default `K.*`.
 
 ## Integration
 
@@ -133,6 +131,19 @@ npx keywords
 > [!TIP]
 > During development, the plugin automatically runs a background type generation process while the bundler is running. Manual CLI execution is only necessary for pre-flight type checking (e.g., in CI) before the bundler runs.
 
+When depending on a library that has `"keywordified": true` (where `import * as K from '~keywords'` remains intact), configure `paths` in your `tsconfig.json` to enable proper module resolution:
+
+```json
+{
+  "compilerOptions": {
+    "paths": {
+      "~keywords": ["./node_modules/~keywords/index.d.ts"],
+      "~keywords/*": ["./node_modules/~keywords/*.d.ts"]
+    }
+  }
+}
+```
+
 ## Library Integration
 
 When publishing libraries intended for consumers who also use `unplugin-keywords`, do not use the plugin during your library's build step. Instead, solely use the `keywords` CLI to generate types for development experience.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unplugin-keywords",
-  "version": "2.16.0",
+  "version": "2.16.1",
   "description": "A build plugin for structural string literal minification and obfuscation.",
   "keywords": [
     "unplugin",
@@ -81,25 +81,5 @@
     "svelte": {
       "optional": true
     }
-  },
-  "devDependencies": {
-    "@biomejs/biome": "^2.4.14",
-    "@mdn/browser-compat-data": "^8.0.0",
-    "@tsconfig/bases": "^1.0.23",
-    "@types/node": "^25.6.0",
-    "globals": "^17.6.0",
-    "svelte": "^5.55.9",
-    "tsdown": "^0.22.0",
-    "typescript": "^6.0.3",
-    "vitest": "^4.1.5"
-  },
-  "scripts": {
-    "precheck": "pnpm --filter \"./demo/*\" typegen",
-    "check": "tsc --build && biome check",
-    "format": "biome check --write",
-    "build": "tsdown",
-    "build:demo": "pnpm --filter \"./demo/*\" build",
-    "test": "vitest run",
-    "test:demo": "pnpm --filter \"./demo/*\" test"
   }
 }