minor

docs/rules/README.md

@@ -0,0 +1,11 @@
+# Be careful when you edit the docs
+
+## Each rule's documentation is partially generated
+
+Running `pnpm docs:init` will create new files if needed.
+
+Running `pnpm docs:update` will update the existing docs.
+
+## Generated sections
+
+The generated sections are surrounded by HTML comments mentioning "auto-generated".

jest.config.js

@@ -4,4 +4,7 @@ module.exports = {
   preset: "ts-jest",
   testEnvironment: "node",
   testMatch: ["**/*.spec.ts"],
+  // Jest running with imported vitest utils causes errors like:
+  // Vitest cannot be imported in a CommonJS module using require(). Please use "import" instead.
+  modulePathIgnorePatterns: ["<rootDir>/src/util/tailwindcss-api/worker/"],
 };

src/rules/index.ts

@@ -1,5 +1,5 @@
-import { myRule } from "./my-rule";
+import { myRule, RULE_NAME as MY_RULE } from "./my-rule";
 
 export const rules = {
-  "my-rule": myRule,
+  [MY_RULE]: myRule,
 };

src/util/tailwindcss-api/index.ts

@@ -5,12 +5,14 @@ import { type Theme } from "./types";
 export const loadThemeWorker: (cssConfigPath: string) => Theme = createSyncFn(
   require.resolve("./worker/load-theme.mjs")
 );
+
 export const getSortedClassNamesWorker: (
   cssConfigPath: string,
   unorderedClassNames: Array<string>
 ) => Array<string> = createSyncFn(
   require.resolve("./worker/get-sorted-class-names.mjs")
 );
+
 export const isValidClassNameWorker: (
   cssConfigPath: string,
   className: string

tsconfig.json

@@ -3,6 +3,7 @@
     "declaration": false,
     "declarationMap": false,
     "esModuleInterop": true,
+    "isolatedModules": true,
     "module": "nodenext",
     "moduleResolution": "nodenext",
     "noFallthroughCasesInSwitch": true,