happy-css-modules 3.1.1 → 4.0.0

package/src/runner.test.ts

@@ -3,9 +3,7 @@ import { randomUUID } from 'node:crypto';
 import { createRequire } from 'node:module';
 import { dirname, join, resolve } from 'path';
 import { fileURLToPath } from 'url';
-import * as fileCacheCore from '@file-cache/core';
 import type { CreateCacheOptions } from '@file-cache/core';
-import { jest } from '@jest/globals';
 import dedent from 'dedent';
 import type { RunnerOptions, Watcher } from './runner.js';
 import { createFixtures, exists, getFixturePath, waitForAsyncTask } from './test-util/util.js';
@@ -13,20 +11,23 @@ import { createFixtures, exists, getFixturePath, waitForAsyncTask } from './test
 const require = createRequire(import.meta.url);
 
 const uuid = randomUUID();
-jest.unstable_mockModule('@file-cache/core', () => ({
-  ...fileCacheCore, // Inherit native functions
-  createCache: async (options: CreateCacheOptions) => {
-    options.keys.push(() => uuid); // Add a random key to avoid cache collision
-    return fileCacheCore.createCache(options);
-  },
-}));
+vi.mock(import('@file-cache/core'), async (importOriginal) => {
+  const fileCacheCore = await importOriginal();
+  return {
+    ...fileCacheCore, // Inherit native functions
+    createCache: async (options: CreateCacheOptions) => {
+      options.keys.push(() => uuid); // Add a random key to avoid cache collision
+      return fileCacheCore.createCache(options);
+    },
+  };
+});
 
 const { run } = await import('./runner.js');
 
 // eslint-disable-next-line @typescript-eslint/no-empty-function
-const consoleLogSpy = jest.spyOn(console, 'log').mockImplementation(() => {});
+const consoleLogSpy = vi.spyOn(console, 'log').mockImplementation(() => {});
 // eslint-disable-next-line @typescript-eslint/no-empty-function
-const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});
+const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(() => {});
 
 const defaultOptions: RunnerOptions = {
   pattern: 'test/**/*.{css,scss}',
@@ -351,3 +352,26 @@ test('support symlink', async () => {
     `"{"version":3,"sources":["./1.css"],"names":["a"],"mappings":"AAAA;AAAA,E,aAAAA,G,WAAA;AAAA;AAAA","file":"1.css.d.ts","sourceRoot":""}"`,
   );
 });
+
+test('changes output directory by outDir', async () => {
+  createFixtures({
+    '/test/1.css': '.a {}',
+  });
+
+  await run({ ...defaultOptions, outDir: getFixturePath('/dist'), cache: false, watch: false });
+
+  expect(await exists(getFixturePath('/dist/test/1.css.d.ts'))).toBe(true);
+  expect(await exists(getFixturePath('/dist/test/1.css.d.ts.map'))).toBe(true);
+
+  expect(await readFile(getFixturePath('/dist/test/1.css.d.ts'), 'utf8')).toMatchInlineSnapshot(`
+    "declare const styles:
+      & Readonly<{ "a": string }>
+    ;
+    export default styles;
+    //# sourceMappingURL=./1.css.d.ts.map
+    "
+  `);
+  expect(await readFile(getFixturePath('/dist/test/1.css.d.ts.map'), 'utf8')).toMatchInlineSnapshot(
+    `"{"version":3,"sources":["../../test/1.css"],"names":["a"],"mappings":"AAAA;AAAA,E,aAAAA,G,WAAA;AAAA;AAAA","file":"1.css.d.ts","sourceRoot":""}"`,
+  );
+});

package/src/runner.ts

@@ -2,7 +2,7 @@ import { resolve, relative } from 'path';
 import * as process from 'process';
 import { createCache } from '@file-cache/core';
 import { createNpmPackageKey } from '@file-cache/npm';
-import AwaitLock from 'await-lock';
+import { Mutex } from 'async-mutex';
 import chalk from 'chalk';
 import * as chokidar from 'chokidar';
 import { glob } from 'glob';
@@ -79,6 +79,8 @@ export interface RunnerOptions {
   logLevel?: 'debug' | 'info' | 'silent' | undefined;
   /** Working directory path. */
   cwd?: string | undefined;
+  /** Output directory for generated files. */
+  outDir?: string | undefined;
 }
 
 type OverrideProp<T, K extends keyof T, V extends T[K]> = Omit<T, K> & { [P in K]: V };
@@ -91,8 +93,7 @@ type OverrideProp<T, K extends keyof T, V extends T[K]> = Omit<T, K> & { [P in K
 export async function run(options: OverrideProp<RunnerOptions, 'watch', true>): Promise<Watcher>;
 export async function run(options: RunnerOptions): Promise<void>;
 export async function run(options: RunnerOptions): Promise<Watcher | void> {
-  // eslint-disable-next-line new-cap
-  const lock = new AwaitLock.default();
+  const lock = new Mutex();
   const logger = new Logger(options.logLevel ?? 'info');
 
   const cwd = options.cwd ?? process.cwd();
@@ -133,13 +134,15 @@ export async function run(options: RunnerOptions): Promise<Watcher | void> {
     }
 
     // Locator#load cannot be called concurrently. Therefore, it takes a lock and waits.
-    await lock.acquireAsync();
+    await lock.acquire();
 
     try {
       const _isGeneratedFilesExist = await isGeneratedFilesExist(
         filePath,
         options.declarationMap,
         options.arbitraryExtensions ?? DEFAULT_ARBITRARY_EXTENSIONS,
+        options.outDir,
+        cwd,
       );
       const _isChangedFile = await isChangedFile(filePath);
       // Generate .d.ts and .d.ts.map only when the file has been updated.
@@ -159,6 +162,8 @@ export async function run(options: RunnerOptions): Promise<Watcher | void> {
           arbitraryExtensions: options.arbitraryExtensions,
         },
         isExternalFile,
+        outDir: options.outDir,
+        cwd,
       });
       logger.info(chalk.green(`${relative(cwd, filePath)} (generated)`));
 

package/src/test-util/util.ts

@@ -10,7 +10,7 @@ import { sleepSync } from '../util.js';
 export const FIXTURE_DIR_PATH = resolve(
   realpathSync(tmpdir()),
   'happy-css-modules/fixtures',
-  process.env['JEST_WORKER_ID']!,
+  process.env['VITEST_POOL_ID']!,
 );
 
 export function createRoot(code: string, from?: string): Root {

package/src/transformer/less-transformer.test.ts

@@ -1,11 +1,10 @@
-import { jest } from '@jest/globals';
 import dedent from 'dedent';
 import { Locator } from '../locator/index.js';
 import { createFixtures, getFixturePath } from '../test-util/util.js';
 import { createLessTransformer } from './less-transformer.js';
 
 const locator = new Locator({ transformer: createLessTransformer() });
-const loadSpy = jest.spyOn(locator, 'load');
+const loadSpy = vi.spyOn(locator, 'load');
 
 afterEach(() => {
   loadSpy.mockClear();

package/src/transformer/postcss-transformer.test.ts

@@ -1,6 +1,5 @@
 import { randomUUID } from 'node:crypto';
 import { createRequire } from 'node:module';
-import { jest } from '@jest/globals';
 import dedent from 'dedent';
 import { Locator } from '../locator/index.js';
 import { createFixtures, getFixturePath } from '../test-util/util.js';
@@ -60,7 +59,7 @@ test('tracks dependencies that have been pre-bundled by postcss compiler', async
       postcssConfig: `${uuid}/postcss.config.js`,
     }),
   });
-  const loadSpy = jest.spyOn(locator, 'load');
+  const loadSpy = vi.spyOn(locator, 'load');
   createFixtures({
     [`/${uuid}/postcss.config.js`]: dedent`
     module.exports = {
@@ -158,8 +157,7 @@ test('returns false if postcssrc is not found', async () => {
     await transformer('', {
       from: getFixturePath('/test/1.css'),
       isIgnoredSpecifier: () => false,
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      resolver: jest.fn() as any,
+      resolver: vi.fn(),
     }),
   ).toBe(false);
 });

package/src/transformer/scss-transformer.test.ts

@@ -1,11 +1,10 @@
-import { jest } from '@jest/globals';
 import dedent from 'dedent';
 import { Locator } from '../locator/index.js';
 import { createFixtures, getFixturePath } from '../test-util/util.js';
 import { createScssTransformer } from './scss-transformer.js';
 
 const locator = new Locator({ transformer: createScssTransformer() });
-const loadSpy = jest.spyOn(locator, 'load');
+const loadSpy = vi.spyOn(locator, 'load');
 
 afterEach(() => {
   loadSpy.mockClear();

package/src/transformer/scss-transformer.ts

@@ -1,42 +1,26 @@
-// NOTE: The workaround for using sass's modern API. happy-css-modules used to use this API.
-// However, due to the implementation of custom resolvers, we have switched to the legacy API.
-// Therefore, the workaround is now disabled. See
-// https://github.com/mizdra/happy-css-modules/issues/65#issuecomment-1229471950 for more information.
-
-import type { LegacyOptions, LegacyResult } from 'sass';
+import { fileURLToPath, pathToFileURL } from 'node:url';
+import type { FileImporter } from 'sass';
+import type { StrictlyResolver } from '../locator/index.js';
 import type { Transformer } from './index.js';
 import { handleImportError } from './index.js';
 
-// For some reason, `util.promisify` does not work. Therefore, use the original promisify.
-function promisifySassRender(sass: typeof import('sass')) {
-  return async (options: LegacyOptions<'async'>) => {
-    return new Promise<LegacyResult>((resolve, reject) => {
-      sass.render(options, (exception, result) => {
-        if (exception) reject(exception);
-        else resolve(result!);
-      });
-    });
-  };
-}
+const createFileImporter: (resolver: StrictlyResolver) => FileImporter<'async'> = (resolver) => ({
+  async findFileUrl(url, context): Promise<URL> {
+    const path = await resolver(url, { request: fileURLToPath(context.containingUrl!) });
+    return pathToFileURL(path);
+  },
+});
 
 export const createScssTransformer: () => Transformer = () => {
   let sass: typeof import('sass');
   return async (source, options) => {
     // eslint-disable-next-line require-atomic-updates
     sass ??= await import('sass').catch(handleImportError('sass'));
-    const render = promisifySassRender(sass);
-    const result = await render({
-      data: source,
-      file: options.from,
-      outFile: 'DUMMY', // Required for sourcemap output.
+    const result = await sass.compileStringAsync(source, {
+      url: pathToFileURL(options.from),
       sourceMap: true,
-      importer: (url, prev, done) => {
-        options
-          .resolver(url, { request: prev })
-          .then((resolved) => done({ file: resolved }))
-          .catch((e) => done(e));
-      },
+      importers: [createFileImporter(options.resolver)],
     });
-    return { css: result.css.toString(), map: result.map!.toString(), dependencies: result.stats.includedFiles };
+    return { css: result.css.toString(), map: JSON.stringify(result.sourceMap!), dependencies: result.loadedUrls };
   };
 };

package/dist/library/source-map/index.d.ts

@@ -1,8 +0,0 @@
-import { SourceNode as OriginalSourceNode, type CodeWithSourceMap } from 'source-map';
-type Chunk = string | StrictlyTypedSourceNode | Chunk[];
-interface StrictlyTypedSourceNode extends OriginalSourceNode {
-    new (line: number | null, column: number | null, source: string | null): StrictlyTypedSourceNode;
-    new (line: number | null, column: number | null, source: string | null, chunk?: Chunk, name?: string): StrictlyTypedSourceNode;
-}
-declare const SourceNode: StrictlyTypedSourceNode;
-export { SourceNode, type CodeWithSourceMap };

package/dist/library/source-map/index.js

@@ -1,5 +0,0 @@
-import { SourceNode as OriginalSourceNode } from 'source-map';
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-const SourceNode = OriginalSourceNode;
-export { SourceNode };
-//# sourceMappingURL=index.js.map

package/dist/library/source-map/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/library/source-map/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,IAAI,kBAAkB,EAA0B,MAAM,YAAY,CAAC;AAsBtF,8DAA8D;AAC9D,MAAM,UAAU,GAA4B,kBAAyB,CAAC;AAEtE,OAAO,EAAE,UAAU,EAA0B,CAAC"}

package/dist/test-util/jest/resolver.cjs

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-// eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/no-require-imports
-const nativeModule = require('node:module');
-// workaround for https://github.com/facebook/jest/issues/12270#issuecomment-1194746382
-/**
- * @typedef {{
- * basedir: string;
- * conditions?: Array<string>;
- * defaultResolver: (path: string, options: ResolverOptions) => string;
- * extensions?: Array<string>;
- * moduleDirectory?: Array<string>;
- * paths?: Array<string>;
- * packageFilter?: (pkg: any, file: string, dir: string) => any;
- * pathFilter?: (pkg: any, path: string, relativePath: string) => string;
- * rootDir?: string;
- * }} ResolverOptions
- */
-/** @type {(path: string, options: ResolverOptions) => string} */
-function resolver(module, options) {
-    const { basedir, defaultResolver } = options;
-    try {
-        return defaultResolver(module, options);
-        // eslint-disable-next-line no-unused-vars
-    }
-    catch (_error) {
-        return nativeModule.createRequire(basedir).resolve(module);
-    }
-}
-module.exports = resolver;
-//# sourceMappingURL=resolver.cjs.map

package/dist/test-util/jest/resolver.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"resolver.cjs","sourceRoot":"","sources":["../../../src/test-util/jest/resolver.cjs"],"names":[],"mappings":";;AAAA,qGAAqG;AACrG,MAAM,YAAY,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;AAE5C,uFAAuF;AAEvF;;;;;;;;;;;;GAYG;AAEH,iEAAiE;AACjE,SAAS,QAAQ,CAAC,MAAM,EAAE,OAAO;IAC/B,MAAM,EAAE,OAAO,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC;IAC7C,IAAI,CAAC;QACH,OAAO,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACxC,0CAA0C;IAC5C,CAAC;IAAC,OAAO,MAAM,EAAE,CAAC;QAChB,OAAO,YAAY,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7D,CAAC;AACH,CAAC;AAED,MAAM,CAAC,OAAO,GAAG,QAAQ,CAAC"}

package/dist/test-util/jest/resolver.d.cts

@@ -1,16 +0,0 @@
-export = resolver;
-declare function resolver(path: string, options: ResolverOptions): string;
-declare namespace resolver {
-    export { ResolverOptions };
-}
-type ResolverOptions = {
-    basedir: string;
-    conditions?: Array<string>;
-    defaultResolver: (path: string, options: ResolverOptions) => string;
-    extensions?: Array<string>;
-    moduleDirectory?: Array<string>;
-    paths?: Array<string>;
-    packageFilter?: (pkg: any, file: string, dir: string) => any;
-    pathFilter?: (pkg: any, path: string, relativePath: string) => string;
-    rootDir?: string;
-};

package/src/library/README.md

@@ -1,3 +0,0 @@
-## library
-
-This is a directory to put library forks or wrappers to avoid bugs.

package/src/library/source-map/index.ts

@@ -1,26 +0,0 @@
-import { SourceNode as OriginalSourceNode, type CodeWithSourceMap } from 'source-map';
-
-// TODO: Open PR to mozilla/source-map
-
-// The type definitions bundled in the source-map package are incorrect.
-// Therefore, the type definitions are overwritten here.
-
-type Chunk = string | StrictlyTypedSourceNode | Chunk[];
-
-interface StrictlyTypedSourceNode extends OriginalSourceNode {
-  // eslint-disable-next-line @typescript-eslint/no-misused-new
-  new (line: number | null, column: number | null, source: string | null): StrictlyTypedSourceNode;
-  // eslint-disable-next-line @typescript-eslint/no-misused-new
-  new (
-    line: number | null,
-    column: number | null,
-    source: string | null,
-    chunk?: Chunk,
-    name?: string,
-  ): StrictlyTypedSourceNode;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-const SourceNode: StrictlyTypedSourceNode = OriginalSourceNode as any;
-
-export { SourceNode, type CodeWithSourceMap };

package/src/test-util/jest/resolver.cjs

@@ -1,31 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/no-require-imports
-const nativeModule = require('node:module');
-
-// workaround for https://github.com/facebook/jest/issues/12270#issuecomment-1194746382
-
-/**
- * @typedef {{
- * basedir: string;
- * conditions?: Array<string>;
- * defaultResolver: (path: string, options: ResolverOptions) => string;
- * extensions?: Array<string>;
- * moduleDirectory?: Array<string>;
- * paths?: Array<string>;
- * packageFilter?: (pkg: any, file: string, dir: string) => any;
- * pathFilter?: (pkg: any, path: string, relativePath: string) => string;
- * rootDir?: string;
- * }} ResolverOptions
- */
-
-/** @type {(path: string, options: ResolverOptions) => string} */
-function resolver(module, options) {
-  const { basedir, defaultResolver } = options;
-  try {
-    return defaultResolver(module, options);
-    // eslint-disable-next-line no-unused-vars
-  } catch (_error) {
-    return nativeModule.createRequire(basedir).resolve(module);
-  }
-}
-
-module.exports = resolver;