happy-css-modules 4.0.0 → 5.0.0

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

@@ -1,6 +1,6 @@
 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 { createLessTransformer } from './less-transformer.js';
 
 const locator = new Locator({ transformer: createLessTransformer() });
@@ -23,60 +23,92 @@ test('handles less features', async () => {
         .b_1();
         .b_2();
       }
-      `,
+    `,
     '/test/2.less': dedent`
       .b_1 { dummy: ''; }
       .b_2() { dummy: ''; }
-      `,
+    `,
     '/test/3.less': dedent`
       .c { dummy: ''; }
-      `,
+    `,
   });
   const result = await locator.load(getFixturePath('/test/1.less'));
 
   // FIXME: The end position of 'a_2_2' is incorrect.
-  expect(result).toMatchInlineSnapshot(`
+  expect(replaceFixtureDir(result)).toMatchInlineSnapshot(`
     {
-      dependencies: ["<fixtures>/test/2.less"],
-      tokens: [
+      "dependencies": [
+        "<fixtures>/test/2.less",
+      ],
+      "tokens": [
         {
-          name: "b_1",
-          originalLocation: {
-            filePath: "<fixtures>/test/2.less",
-            start: { line: 1, column: 1 },
-            end: { line: 1, column: 4 },
+          "name": "b_1",
+          "originalLocation": {
+            "end": {
+              "column": 4,
+              "line": 1,
+            },
+            "filePath": "<fixtures>/test/2.less",
+            "start": {
+              "column": 1,
+              "line": 1,
+            },
           },
         },
         {
-          name: "a_1",
-          originalLocation: {
-            filePath: "<fixtures>/test/1.less",
-            start: { line: 2, column: 1 },
-            end: { line: 2, column: 4 },
+          "name": "a_1",
+          "originalLocation": {
+            "end": {
+              "column": 4,
+              "line": 2,
+            },
+            "filePath": "<fixtures>/test/1.less",
+            "start": {
+              "column": 1,
+              "line": 2,
+            },
           },
         },
         {
-          name: "a_2",
-          originalLocation: {
-            filePath: "<fixtures>/test/1.less",
-            start: { line: 3, column: 1 },
-            end: { line: 3, column: 4 },
+          "name": "a_2",
+          "originalLocation": {
+            "end": {
+              "column": 4,
+              "line": 3,
+            },
+            "filePath": "<fixtures>/test/1.less",
+            "start": {
+              "column": 1,
+              "line": 3,
+            },
           },
         },
         {
-          name: "a_2_1",
-          originalLocation: {
-            filePath: "<fixtures>/test/1.less",
-            start: { line: 6, column: 3 },
-            end: { line: 6, column: 8 },
+          "name": "a_2_1",
+          "originalLocation": {
+            "end": {
+              "column": 8,
+              "line": 6,
+            },
+            "filePath": "<fixtures>/test/1.less",
+            "start": {
+              "column": 3,
+              "line": 6,
+            },
           },
         },
         {
-          name: "a_2_2",
-          originalLocation: {
-            filePath: "<fixtures>/test/1.less",
-            start: { line: 7, column: 3 },
-            end: { line: 7, column: 8 },
+          "name": "a_2_2",
+          "originalLocation": {
+            "end": {
+              "column": 8,
+              "line": 7,
+            },
+            "filePath": "<fixtures>/test/1.less",
+            "start": {
+              "column": 3,
+              "line": 7,
+            },
           },
         },
       ],
@@ -87,13 +119,13 @@ test('handles less features', async () => {
 test('tracks dependencies that have been pre-bundled by less compiler', async () => {
   createFixtures({
     '/test/1.less': dedent`
-    @import './2.less';
-    @import './3.less';
+      @import './2.less';
+      @import './3.less';
     `,
     '/test/2.less': dedent`
     `,
     '/test/3.less': dedent`
-    @import './4.less';
+      @import './4.less';
     `,
     '/test/4.less': dedent`
     `,
@@ -102,13 +134,11 @@ test('tracks dependencies that have been pre-bundled by less 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.less'));
 
   // The files pre-bundled by the compiler are also included in `result.dependencies`
-  // eslint-disable-next-line @typescript-eslint/require-array-sort-compare
   expect(result.dependencies.sort()).toStrictEqual(
-    // eslint-disable-next-line @typescript-eslint/require-array-sort-compare
     ['/test/2.less', '/test/3.less', '/test/4.less'].map(getFixturePath).sort(),
   );
 });
@@ -116,16 +146,14 @@ test('tracks dependencies that have been pre-bundled by less compiler', async ()
 test('resolves specifier using resolver', async () => {
   createFixtures({
     '/test/1.less': 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.less': `.a {}`,
   });
   const result = await locator.load(getFixturePath('/test/1.less'));
-  // eslint-disable-next-line @typescript-eslint/require-array-sort-compare
   expect(result.dependencies.sort()).toStrictEqual(
-    // eslint-disable-next-line @typescript-eslint/require-array-sort-compare
     [getFixturePath('/node_modules/package-1/index.css'), getFixturePath('/node_modules/package-2/index.less')].sort(),
   );
 });
@@ -133,9 +161,9 @@ test('resolves specifier using resolver', async () => {
 test('ignores http(s) protocol file', async () => {
   createFixtures({
     '/test/1.less': dedent`
-    @import 'http://example.com/path/http.css';
-    @import 'https://example.com/path/https.css';
-    @import 'https://example.com/path/less.less';
+      @import 'http://example.com/path/http.css';
+      @import 'https://example.com/path/https.css';
+      @import 'https://example.com/path/less.less';
     `,
   });
   const result = await locator.load(getFixturePath('/test/1.less'));

package/src/transformer/less-transformer.ts

@@ -2,7 +2,6 @@ import type { Transformer } from '../index.js';
 import type { TransformerOptions } from './index.js';
 import { handleImportError } from './index.js';
 
-// eslint-disable-next-line @typescript-eslint/naming-convention
 function createLessPluginResolver(Less: typeof import('less'), options: TransformerOptions): Less.Plugin {
   class ResolverFileManager extends Less.FileManager {
     options: TransformerOptions;
@@ -32,7 +31,7 @@ function createLessPluginResolver(Less: typeof import('less'), options: Transfor
     constructor(options: TransformerOptions) {
       this.options = options;
     }
-    public install(less: LessStatic, pluginManager: Less.PluginManager): void {
+    public install(_less: LessStatic, pluginManager: Less.PluginManager): void {
       pluginManager.addFileManager(new ResolverFileManager(this.options));
     }
     public minVersion: [number, number, number] = [2, 1, 1];
@@ -44,7 +43,6 @@ function createLessPluginResolver(Less: typeof import('less'), options: Transfor
 export const createLessTransformer: () => Transformer = () => {
   let less: typeof import('less');
   return async (source, options) => {
-    // eslint-disable-next-line require-atomic-updates
     less ??= (await import('less').catch(handleImportError('less'))).default;
     const result = await less.render(source, {
       filename: options.from,

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

@@ -2,7 +2,7 @@ import { randomUUID } from 'node:crypto';
 import { createRequire } from 'node:module';
 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 { createPostcssTransformer } from './postcss-transformer.js';
 
 const cwd = getFixturePath('/');
@@ -21,29 +21,35 @@ test('handles postcss features', async () => {
   });
   createFixtures({
     [`/${uuid}/postcss.config.js`]: dedent`
-    module.exports = {
-      plugins: [
-        require('${require.resolve('postcss-simple-vars')}'),
-      ],
-    };
+      module.exports = {
+        plugins: [
+          require('${require.resolve('postcss-simple-vars')}'),
+        ],
+      };
     `,
     '/test/1.css': dedent`
-    $prefix: foo;
-    .$(prefix)_bar {}
+      $prefix: foo;
+      .$(prefix)_bar {}
     `,
   });
   const result = await locator.load(getFixturePath('/test/1.css'));
 
-  expect(result).toMatchInlineSnapshot(`
+  expect(replaceFixtureDir(result)).toMatchInlineSnapshot(`
     {
-      dependencies: [],
-      tokens: [
+      "dependencies": [],
+      "tokens": [
         {
-          name: "foo_bar",
-          originalLocation: {
-            filePath: "<fixtures>/test/1.css",
-            start: { line: 2, column: 1 },
-            end: { line: 2, column: 8 },
+          "name": "foo_bar",
+          "originalLocation": {
+            "end": {
+              "column": 8,
+              "line": 2,
+            },
+            "filePath": "<fixtures>/test/1.css",
+            "start": {
+              "column": 1,
+              "line": 2,
+            },
           },
         },
       ],
@@ -62,15 +68,15 @@ test('tracks dependencies that have been pre-bundled by postcss compiler', async
   const loadSpy = vi.spyOn(locator, 'load');
   createFixtures({
     [`/${uuid}/postcss.config.js`]: dedent`
-    module.exports = {
-      plugins: [
-        require('${require.resolve('postcss-import')}'),
-      ],
-    };
+      module.exports = {
+        plugins: [
+          require('${require.resolve('postcss-import')}'),
+        ],
+      };
     `,
     '/test/1.css': dedent`
-    @import './2.css';
-    @import './3.css';
+      @import './2.css';
+      @import './3.css';
     `,
     '/test/2.css': ``,
     '/test/3.css': `@import './4.css'`,
@@ -80,7 +86,7 @@ test('tracks dependencies that have been pre-bundled by postcss 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.css'));
 
   // The files pre-bundled by the compiler are also included in `result.dependencies`
@@ -97,16 +103,16 @@ test('resolves specifier using resolver', async () => {
   });
   createFixtures({
     [`/${uuid}/postcss.config.js`]: dedent`
-    module.exports = {
-      plugins: [
-        // When using postcss-import, the resolver of happy-css-modules is ignored.
-        // Therefore, we test here without postcss-import.
-        // require('${require.resolve('postcss-import')}'),
-      ],
-    };
+      module.exports = {
+        plugins: [
+          // When using postcss-import, the resolver of happy-css-modules is ignored.
+          // Therefore, we test here without postcss-import.
+          // require('${require.resolve('postcss-import')}'),
+        ],
+      };
     `,
     '/test/1.css': dedent`
-    @import 'package';
+      @import 'package';
     `,
     '/node_modules/package/index.css': `.a {}`,
   });
@@ -124,17 +130,17 @@ test('ignores http(s) protocol file', async () => {
   });
   createFixtures({
     [`/${uuid}/postcss.config.js`]: dedent`
-    module.exports = {
-      plugins: [
-        // When using postcss-import, the resolver of happy-css-modules is ignored.
-        // Therefore, we test here without postcss-import.
-        // require('${require.resolve('postcss-import')}'),
-      ],
-    };
+      module.exports = {
+        plugins: [
+          // When using postcss-import, the resolver of happy-css-modules is ignored.
+          // Therefore, we test here without postcss-import.
+          // require('${require.resolve('postcss-import')}'),
+        ],
+      };
     `,
     '/test/1.css': dedent`
-    @import 'http://example.com/path/http.css';
-    @import 'https://example.com/path/https.css';
+      @import 'http://example.com/path/http.css';
+      @import 'https://example.com/path/https.css';
     `,
   });
   const result = await locator.load(getFixturePath('/test/1.css'));
@@ -149,8 +155,8 @@ test('returns false if postcssrc is not found', async () => {
   });
   createFixtures({
     '/test/1.css': dedent`
-    @import 'http://example.com/path/http.css';
-    @import 'https://example.com/path/https.css';
+      @import 'http://example.com/path/http.css';
+      @import 'https://example.com/path/https.css';
     `,
   });
   expect(
@@ -172,15 +178,15 @@ test('searches config from cwd if postcssConfig option is missing', async () =>
   });
   createFixtures({
     [`/${uuid}/postcss.config.js`]: dedent`
-    module.exports = {
-      plugins: [
-        require('${require.resolve('postcss-simple-vars')}'),
-      ],
-    };
+      module.exports = {
+        plugins: [
+          require('${require.resolve('postcss-simple-vars')}'),
+        ],
+      };
     `,
     '/test/1.css': dedent`
-    $prefix: foo;
-    .$(prefix)_bar {}
+      $prefix: foo;
+      .$(prefix)_bar {}
     `,
   });
   const result = await locator.load(getFixturePath('/test/1.css'));

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

@@ -1,8 +1,18 @@
 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 = vi.spyOn(locator, 'load');
 
@@ -22,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'));
 
@@ -41,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,
+            },
           },
         },
       ],
@@ -109,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`
     `,
@@ -124,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`
@@ -134,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 {}`,
@@ -149,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

@@ -14,7 +14,6 @@ const createFileImporter: (resolver: StrictlyResolver) => FileImporter<'async'>
 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 result = await sass.compileStringAsync(source, {
       url: pathToFileURL(options.from),

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