happy-css-modules 3.2.0 → 5.0.0

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

@@ -1,11 +1,20 @@
-import { jest } from '@jest/globals';
 import dedent from 'dedent';
 import { Locator } from '../locator/index.js';
-import { createFixtures, getFixturePath } from '../test-util/util.js';
+import { createFixtures, getFixturePath, replaceFixtureDir } from '../test-util/util.js';
 import { createScssTransformer } from './scss-transformer.js';
 
+vi.mock('sass', async (importOriginal) => {
+  const sass = await importOriginal<typeof import('sass')>();
+  return {
+    ...sass,
+    // Suppress the warning: `Sass @import rules are deprecated and will be removed in Dart Sass 3.0.0.`
+    compileStringAsync: async (source: string, options?: Parameters<typeof sass.compileStringAsync>[1]) =>
+      sass.compileStringAsync(source, { silenceDeprecations: ['import'], ...options }),
+  };
+});
+
 const locator = new Locator({ transformer: createScssTransformer() });
-const loadSpy = jest.spyOn(locator, 'load');
+const loadSpy = vi.spyOn(locator, 'load');
 
 afterEach(() => {
   loadSpy.mockClear();
@@ -23,17 +32,17 @@ test('handles sass features', async () => {
         .a_2_1 { dummy: ''; }
         &_2 { dummy: ''; }
       }
-      `,
+    `,
     '/test/2.scss': dedent`
       .b_1 { dummy: ''; }
       @mixin b_2 { dummy: ''; }
-      `,
+    `,
     '/test/3.scss': dedent`
       .c { dummy: ''; }
-      `,
+    `,
     '/test/4.scss': dedent`
       .d { dummy: ''; }
-      `,
+    `,
   });
   const result = await locator.load(getFixturePath('/test/1.scss'));
 
@@ -42,64 +51,109 @@ test('handles sass features', async () => {
   // FIXME: The sass compiler or Loader implementation needs to be fixed.
 
   // FIXME: The end position of 'a_2_2' is incorrect.
-  expect(result).toMatchInlineSnapshot(`
+  expect(replaceFixtureDir(result)).toMatchInlineSnapshot(`
     {
-      dependencies: ["<fixtures>/test/2.scss", "<fixtures>/test/3.scss"],
-      tokens: [
+      "dependencies": [
+        "<fixtures>/test/2.scss",
+        "<fixtures>/test/3.scss",
+      ],
+      "tokens": [
         {
-          name: "b_1",
-          originalLocation: {
-            filePath: "<fixtures>/test/2.scss",
-            start: { line: 1, column: 1 },
-            end: { line: 1, column: 4 },
+          "name": "b_1",
+          "originalLocation": {
+            "end": {
+              "column": 4,
+              "line": 1,
+            },
+            "filePath": "<fixtures>/test/2.scss",
+            "start": {
+              "column": 1,
+              "line": 1,
+            },
           },
         },
         {
-          name: "c",
-          originalLocation: {
-            filePath: "<fixtures>/test/3.scss",
-            start: { line: 1, column: 1 },
-            end: { line: 1, column: 2 },
+          "name": "c",
+          "originalLocation": {
+            "end": {
+              "column": 2,
+              "line": 1,
+            },
+            "filePath": "<fixtures>/test/3.scss",
+            "start": {
+              "column": 1,
+              "line": 1,
+            },
           },
         },
         {
-          name: "a_1",
-          originalLocation: {
-            filePath: "<fixtures>/test/1.scss",
-            start: { line: 3, column: 1 },
-            end: { line: 3, column: 4 },
+          "name": "a_1",
+          "originalLocation": {
+            "end": {
+              "column": 4,
+              "line": 3,
+            },
+            "filePath": "<fixtures>/test/1.scss",
+            "start": {
+              "column": 1,
+              "line": 3,
+            },
           },
         },
         {
-          name: "a_2",
-          originalLocation: {
-            filePath: "<fixtures>/test/1.scss",
-            start: { line: 4, column: 1 },
-            end: { line: 4, column: 4 },
+          "name": "a_2",
+          "originalLocation": {
+            "end": {
+              "column": 4,
+              "line": 4,
+            },
+            "filePath": "<fixtures>/test/1.scss",
+            "start": {
+              "column": 1,
+              "line": 4,
+            },
           },
         },
         {
-          name: "a_2",
-          originalLocation: {
-            filePath: "<fixtures>/test/1.scss",
-            start: { line: 7, column: 3 },
-            end: { line: 7, column: 6 },
+          "name": "a_2",
+          "originalLocation": {
+            "end": {
+              "column": 6,
+              "line": 7,
+            },
+            "filePath": "<fixtures>/test/1.scss",
+            "start": {
+              "column": 3,
+              "line": 7,
+            },
           },
         },
         {
-          name: "a_2_1",
-          originalLocation: {
-            filePath: "<fixtures>/test/1.scss",
-            start: { line: 7, column: 3 },
-            end: { line: 7, column: 8 },
+          "name": "a_2_1",
+          "originalLocation": {
+            "end": {
+              "column": 8,
+              "line": 7,
+            },
+            "filePath": "<fixtures>/test/1.scss",
+            "start": {
+              "column": 3,
+              "line": 7,
+            },
           },
         },
         {
-          name: "a_2_2",
-          originalLocation: {
-            filePath: "<fixtures>/test/1.scss",
-            start: { line: 8, column: 3 },
-            end: { line: 8, column: 8 },
+          "name": "a_2_2",
+          "originalLocation": {
+            "end": {
+              "column": 8,
+              "line": 8,
+            },
+            "filePath": "<fixtures>/test/1.scss",
+            "start": {
+              "column": 3,
+              "line": 8,
+            },
           },
         },
       ],
@@ -110,13 +164,13 @@ test('handles sass features', async () => {
 test('tracks dependencies that have been pre-bundled by sass compiler', async () => {
   createFixtures({
     '/test/1.scss': dedent`
-    @import './2.scss';
-    @import './3.scss';
+      @import './2.scss';
+      @import './3.scss';
     `,
     '/test/2.scss': dedent`
     `,
     '/test/3.scss': dedent`
-    @import './4.scss';
+      @import './4.scss';
     `,
     '/test/4.scss': dedent`
     `,
@@ -125,7 +179,7 @@ test('tracks dependencies that have been pre-bundled by sass compiler', async ()
 
   // The files imported using @import are pre-bundled by the compiler.
   // Therefore, `Locator#load` is not called to process other files.
-  expect(loadSpy).toBeCalledTimes(1);
+  expect(loadSpy).toHaveBeenCalledTimes(1);
   expect(loadSpy).toHaveBeenNthCalledWith(1, getFixturePath('/test/1.scss'));
 
   // The files pre-bundled by the compiler are also included in `result.dependencies`
@@ -135,8 +189,8 @@ test('tracks dependencies that have been pre-bundled by sass compiler', async ()
 test('resolves specifier using resolver', async () => {
   createFixtures({
     '/test/1.scss': dedent`
-    @import 'package-1';
-    @import 'package-2';
+      @import 'package-1';
+      @import 'package-2';
     `,
     '/node_modules/package-1/index.css': `.a {}`,
     '/node_modules/package-2/index.scss': `.a {}`,
@@ -150,9 +204,9 @@ test('resolves specifier using resolver', async () => {
 test('ignores http(s) protocol file', async () => {
   createFixtures({
     '/test/1.scss': dedent`
-    @import 'http://example.com/path/http.css';
-    @import 'https://example.com/path/https.css';
-    @import 'https://example.com/path/scss.scss';
+      @import 'http://example.com/path/http.css';
+      @import 'https://example.com/path/https.css';
+      @import 'https://example.com/path/scss.scss';
     `,
   });
   const result = await locator.load(getFixturePath('/test/1.scss'));

package/src/transformer/scss-transformer.ts

@@ -1,42 +1,25 @@
-// 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/src/util.test.ts

@@ -1,10 +1,10 @@
-import { join } from 'path';
+import { join } from 'node:path';
 import { createFixtures, getFixturePath } from './test-util/util.js';
 import { hasProp, isObject, isSystemError, unique, uniqueBy, isMatchByGlob, exists } from './util.js';
 
 function fakeSystemError({ code }: { code: string }) {
   const error = new Error();
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  // oxlint-disable-next-line typescript/no-explicit-any
   (error as any).code = code;
   return error;
 }

package/src/util.ts

@@ -1,9 +1,8 @@
-import { constants, readFileSync } from 'fs';
-import { access } from 'fs/promises';
-import { join, dirname, resolve } from 'path';
-import { fileURLToPath } from 'url';
+import { constants, readFileSync } from 'node:fs';
+import { access } from 'node:fs/promises';
+import { join, dirname, resolve, matchesGlob } from 'node:path';
+import { fileURLToPath } from 'node:url';
 import { resolve as importMetaResolve } from 'import-meta-resolve';
-import { minimatch } from 'minimatch';
 
 /**
  * The SystemError type of Node.js.
@@ -52,7 +51,6 @@ export function uniqueBy<T, U>(arr: T[], fn: (el: T) => U): T[] {
 
 export function sleepSync(ms: number) {
   const start = Date.now();
-  // eslint-disable-next-line no-empty
   while (Date.now() - start < ms) {}
 }
 
@@ -60,13 +58,13 @@ export async function exists(path: string): Promise<boolean> {
   try {
     await access(path, constants.F_OK);
     return true;
-  } catch (e) {
+  } catch {
     return false;
   }
 }
 
 export function isMatchByGlob(filePath: string, pattern: string, options: { cwd: string }): boolean {
-  return minimatch(filePath, join(options.cwd, pattern), { windowsPathsNoEscape: true });
+  return matchesGlob(filePath, join(options.cwd, pattern));
 }
 
 export function getPackageJson() {

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/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;