@css-modules-kit/ts-plugin 0.0.3 → 0.0.5

package/README.md

@@ -2,75 +2,9 @@
 
 A TypeScript Language Service Plugin for CSS Modules
 
-## Features
+## What is this?
 
-<details>
-<summary>Go to Definition</summary>
-
-https://github.com/user-attachments/assets/bdeb2c8a-d615-4223-bae4-e7446f62d353
-
-</details>
-
-<details>
-<summary>Rename class names or `@value`</summary>
-
-https://github.com/user-attachments/assets/db39a95e-2fc8-42a6-a64d-02f2822afbfe
-
-</details>
-
-<details>
-<summary>Find all references</summary>
-
-https://github.com/user-attachments/assets/df1e2feb-2a1a-4bf5-ae70-1cac36d90409
-
-</details>
-
-<details>
-<summary>Automatically update import statements when moving `*.module.css`</summary>
-
-https://github.com/user-attachments/assets/4af168fa-357d-44e1-b010-3053802bf1a2
-
-</details>
-
-<details>
-<summary>Create CSS Module file for current file.</summary>
-
-If there is no CSS Module file corresponding to `xxx.tsx`, create one.
-
-https://github.com/user-attachments/assets/05f9e839-9617-43dc-a519-d5a20adf1146
-
-</details>
-
-<details>
-<summary>Complete `className={...}` instead of `className="..."`</summary>
-
-In projects where CSS Modules are used, the element is styled with `className={styles.xxx}`. However, when you type `className`, `className="..."` is completed. This is annoying to the user.
-
-So, instead of `className="..."` instead of `className={...}` instead of `className="..."`.
-
-https://github.com/user-attachments/assets/b3609c8a-123f-4f4b-af8c-3c8bf7ab4363
-
-</details>
-
-<details>
-<summary>Prioritize the `styles' import for the current component file</summary>
-
-When you request `styles` completion, the CSS Module file `styles` will be suggested. If there are many CSS Module files in the project, more items will be suggested. This can be confusing to the user.
-
-So I have made it so that the `styles` of the CSS Module file corresponding to the current file is shown first.
-
-<img width="821" alt="image" src="https://github.com/user-attachments/assets/413373ec-1258-484d-9248-bc173e4f6d4a" />
-
-</details>
-
-<details>
-<summary>Add missing CSS rule</summary>
-
-If you are trying to use a class name that is not defined, you can add it with Quick Fixes.
-
-https://github.com/user-attachments/assets/3502150a-985d-45f3-9912-bbc183e41c03
-
-</details>
+`@css-modules-kit/ts-plugin` is a TypeScript Language Service Plugin that extends tsserver to handle `*.module.css` files. As a result, many language features like code navigation and rename refactoring become available.
 
 ## Installation
 
@@ -78,15 +12,23 @@ https://github.com/user-attachments/assets/3502150a-985d-45f3-9912-bbc183e41c03
 npm i -D @css-modules-kit/ts-plugin
 ```
 
-## Usage
+## How to setup your editor
+
+### Neovim
 
-Add the "plugin" option to your tsconfig.json file. For example:
+```lua
+local lspconfig = require('lspconfig')
 
-```jsonc
-{
-  "compilerOptions": {
-    "plugins": [{ "name": "@css-modules-kit/ts-plugin" }],
+lspconfig.ts_ls.setup {
+  init_options = {
+    plugins = {
+      {
+        name = '@css-modules-kit/ts-plugin',
+        languages = { 'css' },
+      },
+    },
   },
+  filetypes = { 'typescript', 'javascript', 'javascriptreact', 'typescriptreact', 'css' },
 }
 ```
 

package/dist/index.js

@@ -30,7 +30,7 @@ const plugin = (0, createLanguageServicePlugin_js_1.createLanguageServicePlugin)
             return { languagePlugins: [] };
         }
     }
-    const resolver = (0, core_1.createResolver)(config.paths);
+    const resolver = (0, core_1.createResolver)(config.compilerOptions);
     const matchesPattern = (0, core_1.createMatchesPattern)(config);
     return {
         languagePlugins: [(0, language_plugin_js_1.createCSSModuleLanguagePlugin)(resolver, matchesPattern)],

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA,gDAA6F;AAC7F,gDAAkE;AAClE,oHAA8G;AAC9G,6DAAqE;AACrE,0DAAmE;AAEnE,MAAM,MAAM,GAAG,IAAA,4DAA2B,EAAC,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE;IACtD,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QAClE,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,8DAA8D,CAAC,CAAC;QACxG,OAAO,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC;IACjC,CAAC;IAED,IAAI,MAAiB,CAAC;IACtB,IAAI,CAAC;QACH,MAAM,GAAG,IAAA,qBAAc,EAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;QACvD,2BAA2B;QAC3B,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CACrC,4DAA4D,MAAM,CAAC,cAAc,GAAG,CACrF,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,uDAAuD;QACvD,IAAI,KAAK,YAAY,gCAAyB,EAAE,CAAC;YAC/C,OAAO,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC;QACjC,CAAC;aAAM,CAAC;YACN,IAAI,GAAG,GAAG,8DAA8D,CAAC;YACzE,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;gBAC3B,GAAG,IAAI,OAAO,KAAK,CAAC,OAAO,EAAE,CAAC;gBAC9B,GAAG,IAAI,KAAK,KAAK,CAAC,KAAK,EAAE,CAAC;YAC5B,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC7C,OAAO,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC;QACjC,CAAC;IACH,CAAC;IAED,MAAM,QAAQ,GAAG,IAAA,qBAAc,EAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9C,MAAM,cAAc,GAAG,IAAA,2BAAoB,EAAC,MAAM,CAAC,CAAC;IAEpD,OAAO;QACL,eAAe,EAAE,CAAC,IAAA,kDAA6B,EAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QAC1E,KAAK,EAAE,CAAC,QAAQ,EAAE,EAAE;YAClB,IAAI,CAAC,eAAe,GAAG,IAAA,+BAAoB,EACzC,QAAQ,EACR,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,OAAO,EACZ,QAAQ,EACR,cAAc,CACf,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,iBAAS,MAAM,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA,gDAA6F;AAC7F,gDAAkE;AAClE,oHAA8G;AAC9G,6DAAqE;AACrE,0DAAmE;AAEnE,MAAM,MAAM,GAAG,IAAA,4DAA2B,EAAC,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE;IACtD,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QAClE,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,8DAA8D,CAAC,CAAC;QACxG,OAAO,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC;IACjC,CAAC;IAED,IAAI,MAAiB,CAAC;IACtB,IAAI,CAAC;QACH,MAAM,GAAG,IAAA,qBAAc,EAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;QACvD,2BAA2B;QAC3B,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CACrC,4DAA4D,MAAM,CAAC,cAAc,GAAG,CACrF,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,uDAAuD;QACvD,IAAI,KAAK,YAAY,gCAAyB,EAAE,CAAC;YAC/C,OAAO,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC;QACjC,CAAC;aAAM,CAAC;YACN,IAAI,GAAG,GAAG,8DAA8D,CAAC;YACzE,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;gBAC3B,GAAG,IAAI,OAAO,KAAK,CAAC,OAAO,EAAE,CAAC;gBAC9B,GAAG,IAAI,KAAK,KAAK,CAAC,KAAK,EAAE,CAAC;YAC5B,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC7C,OAAO,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC;QACjC,CAAC;IACH,CAAC;IAED,MAAM,QAAQ,GAAG,IAAA,qBAAc,EAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IACxD,MAAM,cAAc,GAAG,IAAA,2BAAoB,EAAC,MAAM,CAAC,CAAC;IAEpD,OAAO;QACL,eAAe,EAAE,CAAC,IAAA,kDAA6B,EAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QAC1E,KAAK,EAAE,CAAC,QAAQ,EAAE,EAAE;YAClB,IAAI,CAAC,eAAe,GAAG,IAAA,+BAAoB,EACzC,QAAQ,EACR,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,OAAO,EACZ,QAAQ,EACR,cAAc,CACf,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,iBAAS,MAAM,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@css-modules-kit/ts-plugin",
   "description": "A TypeScript Language Service Plugin for CSS Modules",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "type": "commonjs",
   "sideEffects": false,
   "repository": {
@@ -39,7 +39,7 @@
   "dependencies": {
     "@volar/language-core": "^2.4.11",
     "@volar/typescript": "^2.4.11",
-    "@css-modules-kit/core": "^0.0.3"
+    "@css-modules-kit/core": "^0.0.5"
   },
   "peerDependencies": {
     "typescript": ">=5.6.3"

package/src/index.ts

@@ -33,7 +33,7 @@ const plugin = createLanguageServicePlugin((ts, info) => {
     }
   }
 
-  const resolver = createResolver(config.paths);
+  const resolver = createResolver(config.compilerOptions);
   const matchesPattern = createMatchesPattern(config);
 
   return {