feat(config): support modules config to customize css modules processing

__tests__/cli.test.ts

@@ -1,10 +1,12 @@
-import { execSync } from "child_process";
+import { execSync, spawnSync } from "child_process";
 
 describe("cli", () => {
   it("should run when no files are found", () => {
-    const result = execSync("npm run typed-scss-modules src").toString();
+    const result = spawnSync("npm run typed-scss-modules src", {
+      shell: true,
+    });
 
-    expect(result).toContain("No files found.");
+    expect(result.stderr.toString()).toContain("No files found.");
   });
 
   describe("examples", () => {

__tests__/core/alerts.test.ts

@@ -2,13 +2,16 @@ import { alerts, setAlertsLogLevel } from "../../lib/core";
 
 describe("alerts", () => {
   let logSpy: jest.SpyInstance;
+  let warnSpy: jest.SpyInstance;
 
   beforeEach(() => {
     logSpy = jest.spyOn(console, "log").mockImplementation();
+    warnSpy = jest.spyOn(console, "warn").mockImplementation();
   });
 
   afterEach(() => {
     logSpy.mockRestore();
+    warnSpy.mockRestore();
   });
 
   const TEST_ALERT_MSG = "TEST ALERT MESSAGE";
@@ -20,74 +23,74 @@ describe("alerts", () => {
 
     alerts.error(TEST_ALERT_MSG);
 
-    expect(console.log).toHaveBeenLastCalledWith(EXPECTED);
+    expect(console.warn).toHaveBeenLastCalledWith(EXPECTED);
     //make sure each alert only calls console.log once
-    expect(console.log).toHaveBeenCalledTimes(1);
+    expect(console.warn).toHaveBeenCalledTimes(1);
 
     alerts.warn(TEST_ALERT_MSG);
 
-    expect(console.log).toHaveBeenLastCalledWith(EXPECTED);
-    expect(console.log).toHaveBeenCalledTimes(2);
+    expect(console.warn).toHaveBeenLastCalledWith(EXPECTED);
+    expect(console.warn).toHaveBeenCalledTimes(2);
 
     alerts.notice(TEST_ALERT_MSG);
 
     expect(console.log).toHaveBeenLastCalledWith(EXPECTED);
-    expect(console.log).toHaveBeenCalledTimes(3);
+    expect(console.log).toHaveBeenCalledTimes(1);
 
     alerts.info(TEST_ALERT_MSG);
 
     expect(console.log).toHaveBeenLastCalledWith(EXPECTED);
-    expect(console.log).toHaveBeenCalledTimes(4);
+    expect(console.log).toHaveBeenCalledTimes(2);
 
     alerts.success(TEST_ALERT_MSG);
 
     expect(console.log).toHaveBeenLastCalledWith(EXPECTED);
-    expect(console.log).toHaveBeenCalledTimes(5);
+    expect(console.log).toHaveBeenCalledTimes(3);
   });
 
   it("should only print error messages with error log level", () => {
     setAlertsLogLevel("error");
 
     alerts.error(TEST_ALERT_MSG);
 
-    expect(console.log).toHaveBeenLastCalledWith(EXPECTED);
-    expect(console.log).toHaveBeenCalledTimes(1);
+    expect(console.warn).toHaveBeenLastCalledWith(EXPECTED);
+    expect(console.warn).toHaveBeenCalledTimes(1);
 
     alerts.warn(TEST_ALERT_MSG);
     alerts.notice(TEST_ALERT_MSG);
     alerts.info(TEST_ALERT_MSG);
     alerts.success(TEST_ALERT_MSG);
 
     //shouldn't change
-    expect(console.log).toHaveBeenCalledTimes(1);
+    expect(console.warn).toHaveBeenCalledTimes(1);
   });
 
   it("should print all but warning messages with info log level", () => {
     setAlertsLogLevel("info");
 
     alerts.error(TEST_ALERT_MSG);
 
-    expect(console.log).toHaveBeenLastCalledWith(EXPECTED);
-    expect(console.log).toHaveBeenCalledTimes(1);
+    expect(console.warn).toHaveBeenLastCalledWith(EXPECTED);
+    expect(console.warn).toHaveBeenCalledTimes(1);
 
     alerts.notice(TEST_ALERT_MSG);
 
     expect(console.log).toHaveBeenLastCalledWith(EXPECTED);
-    expect(console.log).toHaveBeenCalledTimes(2);
+    expect(console.log).toHaveBeenCalledTimes(1);
 
     alerts.info(TEST_ALERT_MSG);
 
     expect(console.log).toHaveBeenLastCalledWith(EXPECTED);
-    expect(console.log).toHaveBeenCalledTimes(3);
+    expect(console.log).toHaveBeenCalledTimes(2);
 
     alerts.success(TEST_ALERT_MSG);
 
     expect(console.log).toHaveBeenLastCalledWith(EXPECTED);
-    expect(console.log).toHaveBeenCalledTimes(4);
+    expect(console.log).toHaveBeenCalledTimes(3);
 
     alerts.warn(TEST_ALERT_MSG);
 
-    expect(console.log).toHaveBeenCalledTimes(4);
+    expect(console.warn).toHaveBeenCalledTimes(1);
   });
 
   it("should print no messages with silent log level", () => {
@@ -100,5 +103,6 @@ describe("alerts", () => {
     alerts.success(TEST_ALERT_MSG);
 
     expect(console.log).not.toHaveBeenCalled();
+    expect(console.warn).not.toHaveBeenCalled();
   });
 });

__tests__/core/generate.test.ts

@@ -27,9 +27,16 @@ describeAllImplementations((implementation) => {
         updateStaleOnly: false,
         logLevel: "verbose",
         outputFolder: null,
+        aliases: {
+          "~fancy-import": "complex",
+          "~another": "style",
+        },
+        aliasPrefixes: {
+          "~": "nested-styles/",
+        },
       });
 
-      expect(fs.writeFileSync).toHaveBeenCalledTimes(6);
+      expect(fs.writeFileSync).toHaveBeenCalledTimes(9);
     });
   });
 });

__tests__/core/list-different.test.ts

@@ -7,6 +7,7 @@ describeAllImplementations((implementation) => {
 
     beforeEach(() => {
       console.log = jest.fn();
+      console.warn = jest.fn();
       exit = jest.spyOn(process, "exit").mockImplementation();
     });
 
@@ -41,10 +42,10 @@ describeAllImplementations((implementation) => {
       });
 
       expect(exit).toHaveBeenCalledWith(1);
-      expect(console.log).toHaveBeenCalledWith(
+      expect(console.warn).toHaveBeenCalledWith(
         expect.stringContaining(`[INVALID TYPES] Check type definitions for`)
       );
-      expect(console.log).toHaveBeenCalledWith(
+      expect(console.warn).toHaveBeenCalledWith(
         expect.stringContaining(`invalid.scss`)
       );
     });
@@ -69,8 +70,8 @@ describeAllImplementations((implementation) => {
         outputFolder: null,
       });
 
-      expect(console.log).toHaveBeenCalledTimes(1);
-      expect(console.log).toHaveBeenCalledWith(
+      expect(console.warn).toHaveBeenCalledTimes(1);
+      expect(console.warn).toHaveBeenCalledWith(
         expect.stringContaining(`Only 1 file found for`)
       );
       expect(exit).not.toHaveBeenCalled();
@@ -96,6 +97,7 @@ describeAllImplementations((implementation) => {
       });
 
       expect(exit).not.toHaveBeenCalled();
+      expect(console.warn).not.toHaveBeenCalled();
       expect(console.log).not.toHaveBeenCalled();
     });
 
@@ -119,12 +121,12 @@ describeAllImplementations((implementation) => {
       });
 
       expect(exit).toHaveBeenCalledWith(1);
-      expect(console.log).toHaveBeenCalledWith(
+      expect(console.warn).toHaveBeenCalledWith(
         expect.stringContaining(
           `[INVALID TYPES] Type file needs to be generated for`
         )
       );
-      expect(console.log).toHaveBeenCalledWith(
+      expect(console.warn).toHaveBeenCalledWith(
         expect.stringContaining(`no-generated.scss`)
       );
     });
@@ -149,8 +151,8 @@ describeAllImplementations((implementation) => {
       });
 
       expect(exit).not.toHaveBeenCalled();
-      expect(console.log).toHaveBeenCalledTimes(1);
-      expect(console.log).toHaveBeenCalledWith(
+      expect(console.warn).toHaveBeenCalledTimes(1);
+      expect(console.warn).toHaveBeenCalledWith(
         expect.stringContaining(`No files found`)
       );
     });

__tests__/core/list-files-and-perform-sanity-check.test.ts

@@ -19,15 +19,15 @@ const options: ConfigOptions = {
 
 describe("listAllFilesAndPerformSanityCheck", () => {
   beforeEach(() => {
-    console.log = jest.fn();
+    console.warn = jest.fn();
   });
 
   it("prints a warning if the pattern matches 0 files", () => {
     const pattern = `${__dirname}/list-different/test.txt`;
 
     listFilesAndPerformSanityChecks(pattern, options);
 
-    expect(console.log).toHaveBeenCalledWith(
+    expect(console.warn).toHaveBeenCalledWith(
       expect.stringContaining("No files found.")
     );
   });
@@ -37,7 +37,7 @@ describe("listAllFilesAndPerformSanityCheck", () => {
 
     listFilesAndPerformSanityChecks(pattern, options);
 
-    expect(console.log).toHaveBeenCalledWith(
+    expect(console.warn).toHaveBeenCalledWith(
       expect.stringContaining("Only 1 file found for")
     );
   });

__tests__/dummy-styles/global-variables.scss

@@ -1,3 +1,5 @@
+$global-red: #ff0000;
+
 .globalStyle {
   background-color: $global-red;
 }

__tests__/typescript/class-names-to-type-definitions.test.ts

@@ -7,7 +7,7 @@ jest.mock("../../lib/prettier/can-resolve", () => ({
 
 describe("classNamesToTypeDefinitions (without Prettier)", () => {
   beforeEach(() => {
-    console.log = jest.fn();
+    console.warn = jest.fn();
   });
 
   describe("named", () => {
@@ -41,7 +41,7 @@ describe("classNamesToTypeDefinitions (without Prettier)", () => {
       });
 
       expect(definition).toEqual("export declare const myClass: string;\n");
-      expect(console.log).toHaveBeenCalledWith(
+      expect(console.warn).toHaveBeenCalledWith(
         expect.stringContaining(`[SKIPPING] 'if' is a reserved keyword`)
       );
     });
@@ -54,7 +54,7 @@ describe("classNamesToTypeDefinitions (without Prettier)", () => {
       });
 
       expect(definition).toEqual("export declare const myClass: string;\n");
-      expect(console.log).toHaveBeenCalledWith(
+      expect(console.warn).toHaveBeenCalledWith(
         expect.stringContaining(`[SKIPPING] 'invalid-variable' contains dashes`)
       );
     });

lib/cli.ts

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 
 import yargs from "yargs";
+import { alerts } from "./core";
 import { IMPLEMENTATIONS } from "./implementations";
 import { main } from "./main";
 import { Aliases, NAME_FORMATS } from "./sass";
@@ -145,4 +146,8 @@
   .parseSync();
 
 // eslint-disable-next-line @typescript-eslint/no-floating-promises
-main(patterns[0] as string, { ...rest });
+main(patterns[0] as string, { ...rest }).catch((error) => {
+  alerts.error("Encountered an error while generating type definitions.");
+  alerts.error(error);
+  process.exitCode = 1;
+});

lib/core/alerts.ts

@@ -1,4 +1,5 @@
 import chalk from "chalk";
+import { SassError } from "node-sass";
 
 export const LOG_LEVELS = ["verbose", "error", "info", "silent"] as const;
 export type LogLevel = (typeof LOG_LEVELS)[number];
@@ -32,12 +33,35 @@ const withLogLevelsRestriction =
     }
   };
 
+const normalizeErrorMessage = (error: string | Error) => {
+  if (error && error instanceof Error) {
+    if ("file" in error) {
+      const { message, file, line, column } = error as SassError;
+      const location = file ? ` (${file}[${line}:${column}])` : "";
+      const wrappedError = new Error(`SASS Error ${location}\n${message}`, {
+        cause: error,
+      });
+
+      wrappedError.stack = chalk.red(wrappedError.stack);
+
+      return wrappedError;
+    }
+
+    const wrappedError = new Error(error.message);
+    wrappedError.stack = chalk.red(error.stack);
+    return wrappedError;
+  }
+
+  return chalk.red(error);
+};
 const error = withLogLevelsRestriction(
   ["verbose", "error", "info"],
-  (message: string) => console.log(chalk.red(message))
+  (message: string | Error) => {
+    console.warn(normalizeErrorMessage(message));
+  }
 );
 const warn = withLogLevelsRestriction(["verbose"], (message: string) =>
-  console.log(chalk.yellowBright(message))
+  console.warn(chalk.yellowBright(message))
 );
 const notice = withLogLevelsRestriction(
   ["verbose", "info"],

lib/core/types.ts

@@ -1,9 +1,10 @@
+import type PostCSSModulesPlugin from "postcss-modules";
 import { SASSOptions } from "../sass";
 import { ExportType, LogLevel, QuoteType } from "../typescript";
 
-type CLIOnlyOptions = Extract<keyof SASSOptions, "importer">;
+type NonCLIOptions = "importer";
 
-export interface CLIOptions extends Exclude<SASSOptions, CLIOnlyOptions> {
+export interface CLIOptions extends Exclude<SASSOptions, NonCLIOptions> {
   banner: string;
   ignore: string[];
   ignoreInitial: boolean;
@@ -18,4 +19,7 @@ export interface CLIOptions extends Exclude<SASSOptions, CLIOnlyOptions> {
   outputFolder: string | null;
 }
 
-export interface ConfigOptions extends CLIOptions, SASSOptions {}
+type PostCSSModulesOptions = Parameters<PostCSSModulesPlugin>[0];
+export interface ConfigOptions extends CLIOptions, SASSOptions {
+  modules?: PostCSSModulesOptions;
+}