@najemi-software/typed-scss-modules 10.8.0 → 10.9.0

package/README.md

@@ -14,11 +14,11 @@ For example, given the following SCSS:
 @use "variables";
 
 .text {
-  color: variables.$blue;
+    color: variables.$blue;
 
-  &-highlighted {
-    color: variables.$yellow;
-  }
+    &-highlighted {
+        color: variables.$yellow;
+    }
 }
 ```
 
@@ -129,8 +129,8 @@ This matches the common use-case for importing scss files from node_modules when
 - **Type**: `"all" | "camel" | "kebab" | "param" | "snake" | "dashes" | "none"`
 - **Default**: `"camel"`
 - **Examples**:
-  - `typed-scss-modules src --nameFormat camel`
-  - `typed-scss-modules src --nameFormat kebab --nameFormat dashes --exportType default`. In order to use multiple formatters, you must use `--exportType default`.
+    - `typed-scss-modules src --nameFormat camel`
+    - `typed-scss-modules src --nameFormat kebab --nameFormat dashes --exportType default`. In order to use multiple formatters, you must use `--exportType default`.
 
 The class naming format to use when converting the classes to type definitions.
 
@@ -164,11 +164,11 @@ Given the following SCSS:
 
 ```scss
 .text {
-  color: blue;
+    color: blue;
 
-  &-highlighted {
-    color: yellow;
-  }
+    &-highlighted {
+        color: yellow;
+    }
 }
 ```
 
@@ -185,11 +185,11 @@ Given the following SCSS:
 
 ```scss
 .text {
-  color: blue;
+    color: blue;
 
-  &-highlighted {
-    color: yellow;
-  }
+    &-highlighted {
+        color: yellow;
+    }
 }
 ```
 
@@ -197,8 +197,8 @@ The following type definitions will be generated:
 
 ```typescript
 export type Styles = {
-  text: string;
-  textHighlighted: string;
+    text: string;
+    textHighlighted: string;
 };
 
 export type ClassNames = keyof Styles;
@@ -234,7 +234,7 @@ Only default exports are affected by this command. This example will change the
 
 ```typescript
 export type IStyles = {
-  // ...
+    // ...
 };
 ```
 
@@ -291,7 +291,7 @@ Will prepend a string to the top of your output files
 ```typescript
 // This is an example banner
 export type Styles = {
-  // ...
+    // ...
 };
 ```
 
@@ -309,9 +309,9 @@ It will use the relative path to the SCSS module from where this tool is execute
 
 ```json
 {
-  "compilerOptions": {
-    "rootDirs": [".", "__generated__"]
-  }
+    "compilerOptions": {
+        "rootDirs": [".", "__generated__"]
+    }
 }
 ```
 
@@ -335,19 +335,19 @@ The file can provide either a named `config` export or a default export.
 ```js
 // Example of a named export with some of the options sets.
 export const config = {
-  banner: "// customer banner",
-  exportType: "default",
-  exportTypeName: "TheClasses",
-  logLevel: "error",
+    banner: "// customer banner",
+    exportType: "default",
+    exportTypeName: "TheClasses",
+    logLevel: "error",
 };
 
 // Example of a default export with some of the options sets.
 export default {
-  banner: "// customer banner",
-  exportType: "default",
-  exportTypeName: "TheClasses",
-  logLevel: "error",
-  silenceDeprecations: ["import"],
+    banner: "// customer banner",
+    exportType: "default",
+    exportTypeName: "TheClasses",
+    logLevel: "error",
+    silenceDeprecations: ["import"],
 };
 ```
 

package/dist/core/list-different.js

@@ -1,6 +1,6 @@
 import fs from "fs";
 import { fileToClassNames } from "../sass/file-to-class-names.js";
-import { classNamesToTypeDefinitions, getTypeDefinitionPath, } from "../typescript/index.js";
+import { classNamesToTypeDefinitions, getTypeDefinitionPath } from "../typescript/index.js";
 import { alerts } from "./alerts.js";
 import { listFilesAndPerformSanityChecks } from "./list-files-and-perform-sanity-checks.js";
 export const listDifferent = async (pattern, options) => {

package/dist/core/write-file.js

@@ -1,7 +1,7 @@
 import fs from "fs";
 import path from "path";
 import { fileToClassNames } from "../sass/file-to-class-names.js";
-import { classNamesToTypeDefinitions, getTypeDefinitionPath, } from "../typescript/index.js";
+import { classNamesToTypeDefinitions, getTypeDefinitionPath } from "../typescript/index.js";
 import { alerts } from "./alerts.js";
 import { removeSCSSTypeDefinitionFile } from "./remove-file.js";
 /**

package/dist/implementations/compilers.js

@@ -16,7 +16,7 @@ process.on("SIGINT", async () => {
 });
 export const getSyncCompiler = ({ root, implementation, }) => {
     /* When calling the compile functions multiple times, using a compiler instance with the sass-embedded npm package
-    is much faster than using the top-level compilation methods or the sass npm package */
+  is much faster than using the top-level compilation methods or the sass npm package */
     const useCompilerInstance = implementation === "sass-embedded";
     if (!useCompilerInstance) {
         return root;
@@ -35,7 +35,7 @@ export const getSyncCompiler = ({ root, implementation, }) => {
  */
 export const getAsyncCompiler = ({ root, implementation, }) => {
     /* When calling the compile functions multiple times, using a compiler instance with the sass-embedded npm package
-    is much faster than using the top-level compilation methods or the sass npm package */
+  is much faster than using the top-level compilation methods or the sass npm package */
     const useCompilerInstance = implementation === "sass-embedded";
     if (!useCompilerInstance) {
         return Promise.resolve(root);

package/dist/implementations/implementations.js

@@ -1,4 +1,4 @@
-import sass, { AsyncCompiler as SassAsyncCompiler, Compiler as SassCompiler, } from "sass";
+import sass, { AsyncCompiler as SassAsyncCompiler, Compiler as SassCompiler } from "sass";
 import sassEmbedded, { AsyncCompiler as SassEmbeddedAsyncCompiler, Compiler as SassEmbeddedCompiler, } from "sass-embedded";
 /**
  * A list of all possible SASS package implementations that can be used to

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export type { ConfigOptions } from "./core/types.js";
-export { IMPLEMENTATIONS, type Implementations, } from "./implementations/implementations.js";
+export { IMPLEMENTATIONS, type Implementations } from "./implementations/implementations.js";
 export { main as default } from "./main.js";

package/dist/index.js

@@ -1,2 +1,2 @@
-export { IMPLEMENTATIONS, } from "./implementations/implementations.js";
+export { IMPLEMENTATIONS } from "./implementations/implementations.js";
 export { main as default } from "./main.js";

package/dist/load.js

@@ -1,6 +1,6 @@
+import path from "path";
 import { bundleRequire } from "bundle-require";
 import JoyCon from "joycon";
-import path from "path";
 import { alerts } from "./core/alerts.js";
 import {} from "./core/types.js";
 import { getDefaultImplementation } from "./implementations/implementations.js";

package/dist/main.js

@@ -1,7 +1,7 @@
 import fs from "fs";
 import path from "path";
 import slash from "slash";
-import { generate, listDifferent, setAlertsLogLevel, watch, } from "./core/index.js";
+import { generate, listDifferent, setAlertsLogLevel, watch } from "./core/index.js";
 import { disposeAllCompilers } from "./implementations/compilers.js";
 import { loadConfig, mergeOptions } from "./load.js";
 export const main = async (pattern, cliOptions) => {

package/dist/prettier/can-resolve.js

@@ -2,7 +2,7 @@
 // https://github.com/facebook/jest/issues/9543
 export function canResolvePrettier() {
     try {
-        import("prettier");
+        import.meta.resolve("prettier");
         return true;
     }
     catch (_error) {

package/dist/prettier/index.js

@@ -1,4 +1,3 @@
-import { format, resolveConfig } from "prettier";
 import { alerts } from "../core/alerts.js";
 import { canResolvePrettier } from "./can-resolve.js";
 const isPrettier = (t) => !!t &&
@@ -19,7 +18,17 @@ export const attemptPrettier = async (file, input) => {
     if (!canResolvePrettier()) {
         return input;
     }
-    const prettier = await import("prettier");
+    // Non-literal specifier: resolved against the consuming project at
+    // runtime; must not become a compile-time dependency of this package.
+    const prettierSpecifier = "prettier";
+    let prettier;
+    try {
+        prettier = await import(prettierSpecifier);
+    }
+    catch (_error) {
+        // prettier is not installed in the consuming project
+        return input;
+    }
     if (!isPrettier(prettier)) {
         // doesn't look like prettier
         return input;

package/dist/sass/file-to-class-names.js

@@ -1,11 +1,11 @@
-import { camelCase, camelCaseTransformMerge, paramCase, snakeCase, } from "change-case";
+import { camelCase, camelCaseTransformMerge, paramCase, snakeCase } from "change-case";
 import {} from "sass";
 import { getAsyncCompiler, getImplementation, getSyncCompiler, } from "../implementations/index.js";
 import { customImporters, } from "./importer.js";
 import { sourceToClassNames } from "./source-to-class-names.js";
 const transformersMap = {
     camel: (className) => camelCase(className, { transform: camelCaseTransformMerge }),
-    dashes: (className) => /-/.test(className) ? camelCase(className) : className,
+    dashes: (className) => (/-/.test(className) ? camelCase(className) : className),
     kebab: (className) => transformersMap.param(className),
     none: (className) => className,
     param: (className) => paramCase(className),

package/dist/sass/importer.js

@@ -30,8 +30,6 @@ export const aliasImporter = ({ aliases, aliasPrefixes, }) => {
  *  - Given custom SASS importer(s), append to the list of importers.
  */
 export const customImporters = ({ aliases = {}, aliasPrefixes = {}, importers = [], }) => {
-    const bundled = [
-        aliasImporter({ aliases, aliasPrefixes }),
-    ];
+    const bundled = [aliasImporter({ aliases, aliasPrefixes })];
     return bundled.concat(importers);
 };

package/dist/typescript/class-names-to-type-definition.js

@@ -13,8 +13,7 @@ const classNameToType = (className, quoteType) => {
     const quote = quoteType === "single" ? "'" : '"';
     return `  ${quote}${className}${quote}: string;`;
 };
-const isReservedKeyword = (className) => reserved.check(className, "es5", true) ||
-    reserved.check(className, "es6", true);
+const isReservedKeyword = (className) => reserved.check(className, "es5", true) || reserved.check(className, "es6", true);
 const isValidName = (className) => {
     if (isReservedKeyword(className)) {
         alerts.warn(`[SKIPPING] '${className}' is a reserved keyword (consider renaming or using --exportType default).`);
@@ -44,9 +43,7 @@ export const classNamesToTypeDefinitions = async (options) => {
             case "named":
                 if (options.banner)
                     lines.push(options.banner);
-                lines.push(...options.classNames
-                    .filter(isValidName)
-                    .map(classNameToNamedTypeDefinition));
+                lines.push(...options.classNames.filter(isValidName).map(classNameToNamedTypeDefinition));
                 break;
         }
         if (lines.length) {

package/package.json

@@ -1,114 +1,113 @@
 {
-  "name": "@najemi-software/typed-scss-modules",
-  "version": "10.8.0",
-  "private": false,
-  "publishConfig": {
-    "access": "public"
-  },
-  "description": "TypeScript type definition generator for SCSS CSS Modules",
-  "type": "module",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.js",
-      "default": "./dist/index.js"
-    }
-  },
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "author": "Martin Najemi <martin@najemi.cz>",
-  "contributors": [
-    {
-      "name": "am0wa",
-      "email": "am0wa.it@gmail.com"
+    "name": "@najemi-software/typed-scss-modules",
+    "version": "10.9.0",
+    "private": false,
+    "description": "TypeScript type definition generator for SCSS CSS Modules",
+    "keywords": [
+        "cli",
+        "css modules",
+        "scss",
+        "scss modules",
+        "type generator",
+        "typescript"
+    ],
+    "homepage": "https://github.com/Najemi-Software/typed-scss-modules#readme",
+    "license": "MIT",
+    "author": "Martin Najemi <martin@najemi.cz>",
+    "contributors": [
+        {
+            "name": "am0wa",
+            "email": "am0wa.it@gmail.com"
+        },
+        {
+            "name": "Spencer Miskoviak",
+            "email": "smiskoviak@gmail.com"
+        }
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/Najemi-Software/typed-scss-modules.git"
     },
-    {
-      "name": "Spencer Miskoviak",
-      "email": "smiskoviak@gmail.com"
-    }
-  ],
-  "license": "MIT",
-  "engines": {
-    "node": ">=22.19",
-    "npm": ">=10.9"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Najemi-Software/typed-scss-modules.git"
-  },
-  "homepage": "https://github.com/Najemi-Software/typed-scss-modules#readme",
-  "keywords": [
-    "scss",
-    "css modules",
-    "cli",
-    "typescript",
-    "type generator",
-    "scss modules"
-  ],
-  "files": [
-    "dist"
-  ],
-  "bin": {
-    "typed-scss-modules": "./dist/cli.js"
-  },
-  "scripts": {
-    "test": "vitest run --silent",
-    "test:watch": "vitest",
-    "typed-scss-modules": "node ./dist/cli.js",
-    "clean": "rm -rf ./dist",
-    "build": "npm run clean && tsc -p tsconfig.build.json && chmod +x dist/cli.js",
-    "check:types": "tsc --noEmit",
-    "check:formatting": "prettier --check '**/*.{js,json,css,md,scss,tsx,ts}'",
-    "check:linting": "eslint .",
-    "prepare": "npm run build && husky"
-  },
-  "devDependencies": {
-    "@tsjam/eslint-config-recommended": "^0.2.4",
-    "@types/node": "^22.19.3",
-    "@types/reserved-words": "^0.1.0",
-    "@types/yargs": "^17.0.35",
-    "@vitest/eslint-plugin": "^1.6.23",
-    "eslint": "^9.34.0",
-    "husky": "^9.1.7",
-    "lint-staged": "^16.2.7",
-    "prettier": "^3.6.2",
-    "prettier-plugin-organize-imports": "^3.2.4",
-    "sass": "^1.97.1",
-    "sass-embedded": "^1.97.1",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.8.3",
-    "vitest": "^4.1.10"
-  },
-  "peerDependencies": {
-    "sass": "^1.97.1",
-    "sass-embedded": "^1.97.1"
-  },
-  "peerDependenciesMeta": {
-    "sass": {
-      "optional": true
+    "bin": {
+        "typed-scss-modules": "./dist/cli.js"
+    },
+    "files": [
+        "dist"
+    ],
+    "type": "module",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js",
+            "require": "./dist/index.js",
+            "default": "./dist/index.js"
+        }
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "scripts": {
+        "build": "npm run clean && tsc -p tsconfig.build.json && chmod +x dist/cli.js",
+        "check:formatting": "oxfmt --check",
+        "check:linting": "eslint .",
+        "check:types": "tsc --noEmit",
+        "clean": "rm -rf ./dist",
+        "prepare": "npm run build && husky",
+        "test": "vitest run --silent",
+        "test:watch": "vitest",
+        "typed-scss-modules": "node ./dist/cli.js"
+    },
+    "dependencies": {
+        "bundle-require": "^5.1.0",
+        "chalk": "4.1.2",
+        "change-case": "^4.1.2",
+        "chokidar": "^3.6.0",
+        "esbuild": "^0.27.2",
+        "glob": "^13.0.0",
+        "joycon": "^3.1.1",
+        "postcss": "^8.4.49",
+        "postcss-modules": "^6.0.1",
+        "reserved-words": "^0.1.2",
+        "slash": "^3.0.0",
+        "yargs": "^17.7.2"
+    },
+    "devDependencies": {
+        "@tsjam/eslint-config-recommended": "^0.2.4",
+        "@types/node": "^22.19.3",
+        "@types/reserved-words": "^0.1.0",
+        "@types/yargs": "^17.0.35",
+        "@vitest/eslint-plugin": "^1.6.23",
+        "eslint": "^9.34.0",
+        "husky": "^9.1.7",
+        "lint-staged": "^16.2.7",
+        "oxfmt": "^0.52.0",
+        "sass": "^1.97.1",
+        "sass-embedded": "^1.97.1",
+        "ts-node": "^10.9.2",
+        "typescript": "^5.8.3",
+        "vitest": "^4.1.10"
+    },
+    "peerDependencies": {
+        "sass": "^1.97.1",
+        "sass-embedded": "^1.97.1"
+    },
+    "peerDependenciesMeta": {
+        "sass": {
+            "optional": true
+        },
+        "sass-embedded": {
+            "optional": true
+        }
+    },
+    "lint-staged": {
+        "*.{js,mjs,cjs,ts,tsx,jsx,json}": [
+            "oxfmt"
+        ]
     },
-    "sass-embedded": {
-      "optional": true
+    "engines": {
+        "node": ">=22.19",
+        "npm": ">=10.9"
     }
-  },
-  "dependencies": {
-    "bundle-require": "^5.1.0",
-    "chalk": "4.1.2",
-    "change-case": "^4.1.2",
-    "chokidar": "^3.6.0",
-    "esbuild": "^0.27.2",
-    "glob": "^13.0.0",
-    "joycon": "^3.1.1",
-    "postcss": "^8.4.49",
-    "postcss-modules": "^6.0.1",
-    "reserved-words": "^0.1.2",
-    "slash": "^3.0.0",
-    "yargs": "^17.7.2"
-  },
-  "lint-staged": {
-    "*.{js,json,css,md,scss,tsx,ts}": [
-      "prettier --write"
-    ]
-  }
 }