js-style-kit 0.7.0 → 0.8.0

package/dist/index.d.ts

@@ -39,13 +39,22 @@ interface EslintConfigObject<Rules extends Linter.RulesRecord = Linter.RulesReco
 }
 type FilenameCase = "camelCase" | "kebabCase" | "pascalCase" | "snakeCase";
 type FunctionStyle = "arrow" | "declaration" | "expression";
+type ReactFramework = "next" | "none" | "react-router" | "remix" | "vite";
 
 interface TestingConfig {
     filenamePattern?: "spec" | "test";
     files?: string[];
     formattingRules?: boolean;
     framework?: "bun" | "jest" | "node" | "vitest";
+    /**
+     * Whether to enforce imports from the correct testing framework.
+     * Uses the built-in ESLint `no-restricted-imports` rule.
+     *
+     * @default true
+     */
+    importRestrictions?: boolean;
     itOrTest?: "it" | "test";
+    typescript?: boolean;
 }
 
 interface EslintConfigOptions {
@@ -58,7 +67,7 @@ interface EslintConfigOptions {
     };
     query?: boolean;
     react?: boolean | {
-        framework?: "next" | "none" | "react-router" | "remix" | "vite";
+        framework?: ReactFramework;
         reactCompiler?: boolean;
         reactRefresh?: boolean;
     };
@@ -93,8 +102,9 @@ interface EslintConfigOptions {
  * @param options.testing - An object with the following properties:
  *                          - `filenamePattern`: One of "spec" or "test" to determine which filename pattern to use.
  *                          - `files`: Array of file patterns to include in the configuration.
- *                          - `framework`: One of "vitest" or "jest" to determine which testing library to use.
+ *                          - `framework`: One of "vitest" or "jest" or "bun" or "node" to determine which testing library to use.
  *                          - `formattingRules`: Whether to include formatting rules like padding around blocks.
+ *                          - `importRestrictions`: Whether to enforce imports from the correct testing framework.
  *                          - `itOrTest`: One of "it" or "test" to determine which test function to use.
  * @param options.typescript - Whether to include TypeScript rules. Can be a boolean or a string with path to tsconfig.
  * @param options.turbo - Whether to include Turborepo rules. Defaults to false.
@@ -137,4 +147,4 @@ interface PrettierConfigWithPlugins extends Config, SortJsonOptions, PluginOptio
  */
 declare const prettierConfig: (options?: PrettierConfigOptions) => PrettierConfigWithPlugins;
 
-export { type EslintConfigObject, type EslintConfigOptions, type EslintRuleConfig, type EslintSeverity, type FilenameCase, type FunctionStyle, type PrettierConfigOptions, type PrettierConfigWithPlugins, eslintConfig, prettierConfig };
+export { type EslintConfigObject, type EslintConfigOptions, type EslintRuleConfig, type EslintSeverity, type FilenameCase, type FunctionStyle, type PrettierConfigOptions, type PrettierConfigWithPlugins, type ReactFramework, eslintConfig, prettierConfig };

package/dist/index.js

@@ -514,13 +514,14 @@ var convexConfig = (customRules) => ({
 
 // src/eslint/ignores.ts
 var ignoresConfig = ({
-  next = false,
-  storybook = false,
-  userIgnores = []
-} = {}) => ({
+  reactFramework,
+  storybook,
+  userIgnores
+}) => ({
   ignores: [
     "**/dist/",
-    ...next ? [".next"] : [],
+    ...reactFramework === "next" ? [".next"] : [],
+    ...reactFramework === "react-router" ? [".react-router"] : [],
     ...storybook ? ["!.storybook"] : [],
     ...userIgnores
   ],
@@ -1158,6 +1159,56 @@ var storybookConfig = (customRules) => [
 import jest from "eslint-plugin-jest";
 import vitest from "eslint-plugin-vitest";
 
+// src/eslint/testing/get-import-restrictions.ts
+var commonTestImports = [
+  "describe",
+  "it",
+  "test",
+  "expect",
+  "beforeAll",
+  "beforeEach",
+  "afterAll",
+  "afterEach",
+  "vi",
+  "mock",
+  "spyOn"
+];
+var frameworkConfig = {
+  bun: {
+    allowed: "'bun:test'",
+    restricted: ["vitest", "jest", "@jest/globals", "node:test"]
+  },
+  jest: {
+    allowed: "'jest' or '@jest/globals'",
+    restricted: ["vitest", "bun:test", "node:test"]
+  },
+  node: {
+    allowed: "'node:test'",
+    restricted: ["vitest", "jest", "@jest/globals", "bun:test"]
+  },
+  vitest: {
+    allowed: "'vitest'",
+    restricted: ["jest", "@jest/globals", "bun:test", "node:test"]
+  }
+};
+var getRestrictionMessage = (allowedFramework) => `This project is setup to use ${allowedFramework} for testing. Importing from other testing frameworks is not allowed. Change this setting in eslint.config.js under testing.framework`;
+var getImportRestrictions = (framework) => {
+  const config = frameworkConfig[framework];
+  const message = getRestrictionMessage(config.allowed);
+  return {
+    "no-restricted-imports": [
+      "warn",
+      {
+        paths: config.restricted.map((name) => ({
+          importNames: commonTestImports,
+          message,
+          name
+        }))
+      }
+    ]
+  };
+};
+
 // src/eslint/testing/jest-rules.ts
 var jestRules = (itOrTest = "test") => ({
   "jest/consistent-test-it": [
@@ -1248,17 +1299,14 @@ var vitestRules = (itOrTest = "test") => ({
 
 // src/eslint/testing/config.ts
 var testingConfig = ({
-  filenamePattern,
+  filenamePattern = "test",
   files,
-  formattingRules,
-  framework,
-  itOrTest
-} = {
-  filenamePattern: "test",
-  formattingRules: true,
-  framework: "vitest",
-  itOrTest: "test"
-}, customRules) => ({
+  formattingRules = true,
+  framework = "vitest",
+  importRestrictions = true,
+  itOrTest = "test",
+  typescript = true
+} = {}, customRules) => ({
   files: files ?? ["**/*.{test,spec}.{ts,tsx,js,jsx}"],
   languageOptions: {
     globals: framework === "vitest" ? { ...vitest.environments.env.globals } : jest.environments.globals.globals
@@ -1269,8 +1317,8 @@ var testingConfig = ({
     vitest
   },
   rules: {
+    ...typescript ? { "@typescript-eslint/unbound-method": "off" } : {},
     // jest doesn't have a file name rule, so we'll use this one for both
-    "@typescript-eslint/unbound-method": "off",
     "vitest/consistent-test-filename": [
       "warn",
       {
@@ -1288,6 +1336,7 @@ var testingConfig = ({
       "jest/padding-around-expect-groups": "warn",
       "jest/padding-around-test-blocks": "warn"
     } : {},
+    ...importRestrictions ? getImportRestrictions(framework) : {},
     ...customRules ?? {}
   },
   ...framework !== "jest" && framework !== "vitest" ? {
@@ -1576,13 +1625,6 @@ var unicornConfig = ({
 });
 
 // src/eslint/index.ts
-var defaultTestingConfig = {
-  filenamePattern: "test",
-  files: ["**/*.{test,spec}.{ts,tsx,js,jsx}"],
-  formattingRules: true,
-  framework: "vitest",
-  itOrTest: "it"
-};
 var eslintConfig = ({
   convex = false,
   functionStyle = "arrow",
@@ -1594,16 +1636,15 @@ var eslintConfig = ({
   rules: rules2,
   sorting = true,
   storybook = false,
-  testing = defaultTestingConfig,
+  testing,
   turbo: turbo2 = false,
   typescript = true,
   unicorn: unicorn2 = { filenameCase: "kebabCase" }
 } = {}, ...additionalConfigs) => {
   const categorizedRules = rules2 === void 0 ? {} : processCustomRules(rules2);
-  const usingNextjs = isObject(react2) && react2.framework === "next";
   const configs = [
     ignoresConfig({
-      next: usingNextjs,
+      reactFramework: isObject(react2) && react2.framework ? react2.framework : "none",
       storybook,
       userIgnores: ignores
     }),
@@ -1654,7 +1695,7 @@ var eslintConfig = ({
         typescript: Boolean(typescript)
       })
     );
-    if (usingNextjs) {
+    if (isObject(react2) && react2.framework === "next") {
       configs.push(nextjsConfig(categorizedRules[configNames.nextjs]));
     }
   }
@@ -1665,8 +1706,23 @@ var eslintConfig = ({
     configs.push(convexConfig(categorizedRules[configNames.convex]));
   }
   if (testing !== false) {
+    const defaultTestingConfig = {
+      filenamePattern: "test",
+      files: ["**/*.{test,spec}.{ts,tsx,js,jsx}"],
+      formattingRules: true,
+      framework: "vitest",
+      importRestrictions: true,
+      itOrTest: "it"
+    };
     const mergedTestingConfig = isObject(testing) ? { ...defaultTestingConfig, ...testing } : defaultTestingConfig;
-    const { filenamePattern, files, formattingRules, framework, itOrTest } = mergedTestingConfig;
+    const {
+      filenamePattern,
+      files,
+      formattingRules,
+      framework,
+      importRestrictions,
+      itOrTest
+    } = mergedTestingConfig;
     configs.push(
       testingConfig(
         {
@@ -1674,7 +1730,9 @@ var eslintConfig = ({
           files,
           formattingRules,
           framework,
-          itOrTest
+          importRestrictions,
+          itOrTest,
+          typescript: Boolean(typescript)
         },
         categorizedRules[configNames.testing]
       )