js-style-kit 0.6.1 → 0.8.0

package/dist/index.d.ts

@@ -10,6 +10,7 @@ import { PluginOptions } from 'prettier-plugin-tailwindcss';
  */
 declare const configNames: {
     readonly base: "base";
+    readonly convex: "convex";
     readonly disableTypeChecked: "UserConfig[1] > typescript-eslint/disable-type-checked";
     readonly ignores: "ignores";
     readonly import: "import";
@@ -33,20 +34,31 @@ type ConfigName = (typeof configNames)[keyof typeof configNames];
 
 type EslintSeverity = 0 | 1 | 2 | "error" | "off" | "warn";
 type EslintRuleConfig<TOptions = Record<string, unknown>, TOptions2 = Record<string, unknown>> = [EslintSeverity, string | TOptions | undefined] | [EslintSeverity, string | undefined, TOptions2 | undefined] | [EslintSeverity, TOptions | undefined, TOptions2 | undefined] | [EslintSeverity] | EslintSeverity;
-type FunctionStyle = "arrow" | "declaration" | "expression";
 interface EslintConfigObject<Rules extends Linter.RulesRecord = Linter.RulesRecord> extends Linter.Config<Rules> {
     name: ConfigName;
 }
+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 {
+    convex?: boolean;
     functionStyle?: "off" | FunctionStyle;
     ignores?: string[];
     importPlugin?: boolean;
@@ -55,7 +67,7 @@ interface EslintConfigOptions {
     };
     query?: boolean;
     react?: boolean | {
-        framework?: "next" | "none" | "react-router" | "remix" | "vite";
+        framework?: ReactFramework;
         reactCompiler?: boolean;
         reactRefresh?: boolean;
     };
@@ -65,12 +77,15 @@ interface EslintConfigOptions {
     testing?: false | TestingConfig;
     turbo?: boolean;
     typescript?: boolean | string;
-    unicorn?: boolean;
+    unicorn?: boolean | {
+        filenameCase?: FilenameCase;
+    };
 }
 /**
  * Configures ESLint based on provided options.
  *
  * @param options - The optional configuration object.
+ * @param options.convex - Whether to include Convex rules.
  * @param options.functionStyle - The function style to enforce. Defaults to "arrow".
  * @param options.ignores - Additional paths to ignore. Already excludes `node_modules` and `dist`.
  * @param options.importPlugin - Whether to include the import plugin. Defaults to true.
@@ -87,17 +102,18 @@ 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.
- * @param options.unicorn - Whether to include Unicorn rules. Defaults to true.
+ * @param options.unicorn - Whether to include Unicorn rules. Defaults to true. Can be an object with filenameCase property.
  * @param options.rules - This is for rules that you need to alter or turn off.
  * @param additionalConfigs - Additional ESLint config objects to be merged into the final configuration.
  * @returns An array of ESLint configuration objects.
  */
-declare const eslintConfig: ({ functionStyle, ignores, importPlugin, jsdoc, query, react, rules, sorting, storybook, testing, turbo, typescript, unicorn, }?: EslintConfigOptions, ...additionalConfigs: Linter.Config[]) => Linter.Config[];
+declare const eslintConfig: ({ convex, functionStyle, ignores, importPlugin, jsdoc, query, react, rules, sorting, storybook, testing, turbo, typescript, unicorn, }?: EslintConfigOptions, ...additionalConfigs: Linter.Config[]) => Linter.Config[];
 
 interface PrettierConfigOptions extends Config {
     cssOrderPlugin?: boolean;
@@ -131,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 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

@@ -9,6 +9,7 @@ var isObject = (value) => {
 // src/eslint/constants.ts
 var configNames = {
   base: "base",
+  convex: "convex",
   disableTypeChecked: "UserConfig[1] > typescript-eslint/disable-type-checked",
   ignores: "ignores",
   import: "import",
@@ -29,6 +30,7 @@ var configNames = {
   unicorn: "unicorn"
 };
 var pluginPrefixMap = /* @__PURE__ */ new Map([
+  ["@convex-dev", configNames.convex],
   ["@tanstack/query", configNames.query],
   ["@typescript-eslint", configNames.typescript],
   ["import", configNames.import],
@@ -484,15 +486,42 @@ var baseEslintConfig = (functionStyle, typescript, customRules) => ({
   }
 });
 
+// src/eslint/convex/config.ts
+import { createRequire } from "module";
+
+// src/eslint/convex/rules.ts
+var convexRules = {
+  "@convex-dev/import-wrong-runtime": "warn",
+  "@convex-dev/no-args-without-validator": "warn",
+  "@convex-dev/no-missing-args-validator": "warn",
+  "@convex-dev/no-old-registered-function-syntax": "warn"
+};
+
+// src/eslint/convex/config.ts
+var require2 = createRequire(import.meta.url);
+var convexPlugin = require2("@convex-dev/eslint-plugin");
+var convexConfig = (customRules) => ({
+  files: ["**/convex/**/*.{ts,js}"],
+  name: configNames.convex,
+  plugins: {
+    "@convex-dev": convexPlugin
+  },
+  rules: {
+    ...convexRules,
+    ...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
   ],
@@ -1130,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": [
@@ -1220,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
@@ -1241,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",
       {
@@ -1260,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" ? {
@@ -1457,7 +1534,7 @@ var tseslintConfig = (tsconfigPath, customRules) => {
 import unicorn from "eslint-plugin-unicorn";
 
 // src/eslint/unicorn/rules.ts
-var rules = {
+var rules = (filenameCase = "kebabCase") => ({
   /**
    * Enforce better string content.
    *
@@ -1478,7 +1555,7 @@ var rules = {
   "unicorn/filename-case": [
     "warn",
     {
-      case: "kebabCase"
+      case: filenameCase
     }
   ],
   /**
@@ -1530,29 +1607,26 @@ var rules = {
    * 🔧 Fixable - https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/text-encoding-identifier-case.md
    */
   "unicorn/text-encoding-identifier-case": "warn"
-};
+});
 
 // src/eslint/unicorn/config.ts
-var unicornConfig = (customRules) => ({
+var unicornConfig = ({
+  customRules,
+  filenameCase = "kebabCase"
+}) => ({
   name: configNames.unicorn,
   plugins: {
     unicorn
   },
   rules: {
-    ...rules,
+    ...rules(filenameCase),
     ...customRules ?? {}
   }
 });
 
 // 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",
   ignores = [],
   importPlugin = true,
@@ -1562,16 +1636,15 @@ var eslintConfig = ({
   rules: rules2,
   sorting = true,
   storybook = false,
-  testing = defaultTestingConfig,
+  testing,
   turbo: turbo2 = false,
   typescript = true,
-  unicorn: unicorn2 = 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
     }),
@@ -1622,16 +1695,34 @@ var eslintConfig = ({
         typescript: Boolean(typescript)
       })
     );
-    if (usingNextjs) {
+    if (isObject(react2) && react2.framework === "next") {
       configs.push(nextjsConfig(categorizedRules[configNames.nextjs]));
     }
   }
   if (query) {
     configs.push(queryConfig(categorizedRules[configNames.query]));
   }
+  if (convex) {
+    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(
         {
@@ -1639,7 +1730,9 @@ var eslintConfig = ({
           files,
           formattingRules,
           framework,
-          itOrTest
+          importRestrictions,
+          itOrTest,
+          typescript: Boolean(typescript)
         },
         categorizedRules[configNames.testing]
       )
@@ -1651,7 +1744,13 @@ var eslintConfig = ({
     );
   }
   if (unicorn2) {
-    configs.push(unicornConfig(categorizedRules[configNames.unicorn]));
+    const filenameCase = isObject(unicorn2) ? unicorn2.filenameCase : void 0;
+    configs.push(
+      unicornConfig({
+        customRules: categorizedRules[configNames.unicorn],
+        filenameCase
+      })
+    );
   }
   if (functionStyle === "arrow") {
     configs.push(