Add extendedSourceFiles in CMKConfig (#265)

* fix comment

* add `extendedSourceFiles` in `CMKConfig`

* remove test

- A test fails on Windows.
- The test expects `extendedSourceFiles` to return in 8.3 filename format but instead receives full filenames.
- On the other hand, this test examines internal behavior of the TypeScript Compiler API.
- This test should be removed.

Author: mizdra

.changeset/khaki-pillows-change.md

@@ -0,0 +1,5 @@
+---
+'@css-modules-kit/core': minor
+---
+
+feat: add `extendedSourceFiles` in `CMKConfig`

packages/core/src/config.test.ts

@@ -18,19 +18,21 @@ describe('readConfigFile', () => {
   });
   test('returns the default options even if tsconfig is empty', async () => {
     const iff = await createIFF({ 'tsconfig.json': '{}' });
-    expect(readConfigFile(iff.rootDir)).toStrictEqual<CMKConfig>(
-      expect.objectContaining({
-        includes: [iff.join('**/*')],
-        excludes: [],
-        dtsOutDir: iff.join('generated'),
-        arbitraryExtensions: false,
-        namedExports: false,
-        prioritizeNamedImports: false,
-        keyframes: true,
-        compilerOptions: expect.any(Object),
-        wildcardDirectories: [{ fileName: iff.rootDir, recursive: true }],
-      }),
-    );
+    expect(readConfigFile(iff.rootDir)).toStrictEqual<CMKConfig>({
+      includes: [iff.join('**/*')],
+      excludes: [],
+      dtsOutDir: iff.join('generated'),
+      arbitraryExtensions: false,
+      namedExports: false,
+      prioritizeNamedImports: false,
+      keyframes: true,
+      basePath: iff.rootDir,
+      configFileName: iff.paths['tsconfig.json'],
+      compilerOptions: expect.any(Object),
+      wildcardDirectories: [{ fileName: iff.rootDir, recursive: true }],
+      extendedSourceFiles: [],
+      diagnostics: [],
+    });
   });
   test('default option values are overridden by config file values', async () => {
     const iff = await createIFF({
@@ -101,6 +103,7 @@ describe('readConfigFile', () => {
             module: ts.ModuleKind.ESNext,
           }),
           wildcardDirectories: [{ fileName: iff.join('src'), recursive: true }],
+          extendedSourceFiles: [iff.join('tsconfig.base.json')],
         }),
       );
     });
@@ -134,6 +137,7 @@ describe('readConfigFile', () => {
             module: ts.ModuleKind.ES2015,
           }),
           wildcardDirectories: [{ fileName: iff.join('src2'), recursive: true }],
+          extendedSourceFiles: [iff.join('tsconfig.base.json')],
         }),
       );
     });
@@ -161,6 +165,7 @@ describe('readConfigFile', () => {
             module: ts.ModuleKind.ESNext,
           }),
           wildcardDirectories: [{ fileName: iff.join('src'), recursive: true }],
+          extendedSourceFiles: [iff.join('tsconfig.base2.json'), iff.join('tsconfig.base1.json')],
         }),
       );
     });
@@ -185,21 +190,6 @@ describe('readConfigFile', () => {
       });
       expect(readConfigFile(iff.rootDir).dtsOutDir).toBe(iff.join('generated2'));
     });
-    test('inherits from a package', async () => {
-      const iff = await createIFF({
-        'node_modules/some-pkg/tsconfig.json': dedent`
-          {
-            "cmkOptions": { "dtsOutDir": "generated/cmk" }
-          }
-        `,
-        'tsconfig.json': dedent`
-          {
-            "extends": "some-pkg/tsconfig.json"
-          }
-        `,
-      });
-      expect(readConfigFile(iff.rootDir).dtsOutDir).toBe(iff.join('generated/cmk'));
-    });
     test('inherits from multiple files', async () => {
       const iff = await createIFF({
         'tsconfig.base1.json': dedent`
@@ -222,6 +212,7 @@ describe('readConfigFile', () => {
         expect.objectContaining({
           dtsOutDir: iff.join('generated/cmk'),
           arbitraryExtensions: true,
+          extendedSourceFiles: [iff.join('tsconfig.base1.json'), iff.join('tsconfig.base2.json')],
         }),
       );
     });

packages/core/src/config.ts

@@ -60,6 +60,8 @@ export interface CMKConfig {
   compilerOptions: ts.CompilerOptions;
   /** The directories to watch when watch mode is enabled. */
   wildcardDirectories: { fileName: string; recursive: boolean }[];
+  /** The tsconfig files inherited by `configFileName`. */
+  extendedSourceFiles: string[];
   /** The diagnostics that occurred while reading the config file. */
   diagnostics: Diagnostic[];
 }
@@ -246,7 +248,7 @@ export function readConfigFile(project: string): CMKConfig {
 
   const basePath = dirname(configFileName);
   return {
-    // If `include` is not specified, fallback to the default include spec。
+    // If `include` is not specified, fallback to the default include spec.
     // ref: https://github.com/microsoft/TypeScript/blob/caf1aee269d1660b4d2a8b555c2d602c97cb28d7/src/compiler/commandLineParser.ts#L3102
     includes: (parsedTsConfig.config.includes ?? [DEFAULT_INCLUDE_SPEC]).map((i) => join(basePath, i)),
     excludes: (parsedTsConfig.config.excludes ?? []).map((e) => join(basePath, e)),
@@ -259,6 +261,7 @@ export function readConfigFile(project: string): CMKConfig {
     configFileName,
     compilerOptions: parsedTsConfig.compilerOptions,
     wildcardDirectories: parsedTsConfig.wildcardDirectories,
+    extendedSourceFiles: parsedTsConfig.extendedSourceFiles ?? [],
     diagnostics: parsedTsConfig.diagnostics,
   };
 }

packages/core/src/test/faker.ts

@@ -16,6 +16,7 @@ export function fakeConfig(args?: Partial<CMKConfig>): CMKConfig {
     compilerOptions: {},
     wildcardDirectories: [{ fileName: '/app', recursive: true }],
     diagnostics: [],
+    extendedSourceFiles: [],
     ...args,
   };
 }