support prioritizeNamedImports option

Author: mizdra

README.md

@@ -165,6 +165,26 @@ Determines whether to generate named exports in the d.ts file instead of a defau
 }
 ```
 
+### `cmkOptions.prioritizeNamedImports`
+
+Type: `boolean`, Default: `false`
+
+Whether to prioritize named imports over namespace imports when adding import statements. This option effects only `cmkOptions.namedExports` is `true`.
+
+When this option is `true`, `import { button } from '...'` will be added. When this option is `false`, `import button from '...'` will be added.
+
+```jsonc
+{
+  "compilerOptions": {
+    // ...
+  },
+  "cmkOptions": {
+    "namedExports": true,
+    "prioritizeNamedImports": true,
+  },
+}
+```
+
 ## Limitations
 
 - Sass/Less are not supported to simplify the implementation
@@ -180,3 +200,7 @@ Determines whether to generate named exports in the d.ts file instead of a defau
 This project was created as a next-generation tool to replace [happy-css-modules](https://github.com/mizdra/happy-css-modules)
 
 happy-css-modules was also a tool that provided language functionality for `*.module.css`. However, the tool was limited in the type of language features it could provide. To solve this limitation, css-modules-kit was created.
+
+```
+
+```

packages/core/src/config.test.ts

@@ -29,7 +29,8 @@ describe('readTsConfigFile', () => {
           "cmkOptions": {
             "dtsOutDir": "generated/cmk",
             "arbitraryExtensions": false,
-            "namedExports": true
+            "namedExports": true,
+            "prioritizeNamedImports": true
           }
         }
       `,
@@ -42,6 +43,7 @@ describe('readTsConfigFile', () => {
         dtsOutDir: 'generated/cmk',
         arbitraryExtensions: false,
         namedExports: true,
+        prioritizeNamedImports: true,
       },
       compilerOptions: expect.objectContaining({
         module: ts.ModuleKind.ESNext,

packages/core/src/config.ts

@@ -15,8 +15,8 @@ export interface CMKConfig {
   excludes: string[];
   dtsOutDir: string;
   arbitraryExtensions: boolean;
-  /** Whether to generate named exports in the d.ts file instead of a default export. */
   namedExports: boolean;
+  prioritizeNamedImports: boolean;
   /**
    * A root directory to resolve relative path entries in the config file to.
    * This is an absolute path.
@@ -71,6 +71,7 @@ interface UnnormalizedRawConfig {
   dtsOutDir?: string;
   arbitraryExtensions?: boolean;
   namedExports?: boolean;
+  prioritizeNamedImports?: boolean;
 }
 
 /**
@@ -148,6 +149,17 @@ function parseRawData(raw: unknown, tsConfigSourceFile: ts.TsConfigSourceFile):
         });
       }
     }
+    if ('prioritizeNamedImports' in raw.cmkOptions) {
+      if (typeof raw.cmkOptions.prioritizeNamedImports === 'boolean') {
+        result.config.prioritizeNamedImports = raw.cmkOptions.prioritizeNamedImports;
+      } else {
+        result.diagnostics.push({
+          category: 'error',
+          text: `\`prioritizeNamedImports\` in ${tsConfigSourceFile.fileName} must be a boolean.`,
+          // MEMO: Location information can be obtained from `tsConfigSourceFile.statements`, but this is complicated and will be omitted.
+        });
+      }
+    }
   }
   return result;
 }
@@ -242,6 +254,7 @@ export function readConfigFile(project: string): CMKConfig {
     dtsOutDir: join(basePath, config.dtsOutDir ?? 'generated'),
     arbitraryExtensions: config.arbitraryExtensions ?? false,
     namedExports: config.namedExports ?? false,
+    prioritizeNamedImports: config.prioritizeNamedImports ?? false,
     basePath,
     configFileName,
     compilerOptions,

packages/ts-plugin/src/language-plugin.ts

@@ -59,7 +59,7 @@ export function createCSSLanguagePlugin(
         matchesPattern,
         namedExports: config.namedExports,
       });
-      if (config.namedExports) {
+      if (config.namedExports && !config.prioritizeNamedImports) {
         // Export `styles` to appear in code completion suggestions
         text += 'declare const styles: {};\nexport default styles;\n';
       }

packages/ts-plugin/src/language-service/feature/code-fix.ts

@@ -29,7 +29,7 @@ export function getCodeFixesAtPosition(
       ),
     );
 
-    if (config.namedExports) {
+    if (config.namedExports && !config.prioritizeNamedImports) {
       convertDefaultImportsToNamespaceImports(prior, fileName, resolver);
     }
 

packages/ts-plugin/src/language-service/feature/completion.ts

@@ -30,7 +30,7 @@ export function getCompletionsAtPosition(
         }
       }
     }
-    if (config.namedExports) {
+    if (config.namedExports && !config.prioritizeNamedImports) {
       // When `namedExports` is enabled, you can write code as follows:
       // ```tsx
       // import { button } from './a.module.css';
@@ -106,7 +106,7 @@ export function getCompletionEntryDetails(
     );
     if (!details) return undefined;
 
-    if (config.namedExports && details.codeActions) {
+    if (config.namedExports && !config.prioritizeNamedImports && details.codeActions) {
       convertDefaultImportsToNamespaceImports(details.codeActions, fileName, resolver);
     }
     return details;