js-style-kit 0.6.1 → 0.7.0

package/README.md

@@ -120,6 +120,8 @@ export default eslintConfig(
     importPlugin: true, // Import/export validation
     sorting: true, // Auto-sort imports, objects, etc.
     unicorn: true, // Enforce file naming and best practices
+    // or configure filename case:
+    // unicorn: { filenameCase: "kebabCase" }, // "camelCase" | "kebabCase" | "pascalCase" | "snakeCase"
     jsdoc: { requireJsdoc: false }, // JSDoc validation
 
     // Framework & tools
@@ -127,6 +129,7 @@ export default eslintConfig(
     testing: { framework: "vitest" }, // Test framework config
     storybook: false, // Storybook rules
     turbo: false, // Turborepo rules
+    convex: false, // Convex backend rules
 
     // Advanced
     ignores: [], // Additional ignore patterns
@@ -164,6 +167,7 @@ Each configuration has detailed documentation:
   - [JSDoc](./src/eslint/jsdoc/README.md) - Documentation validation
   - [Storybook](./src/eslint/storybook/README.md) - Component story rules
   - [Turborepo](./src/eslint/turbo/README.md) - Monorepo rules
+  - [Convex](./src/eslint/convex/README.md) - Convex backend rules
 
 ### Prettier Options
 
@@ -281,6 +285,7 @@ export default eslintConfig(
 - [`eslint-plugin-turbo`](https://www.npmjs.com/package/eslint-plugin-turbo) - Turborepo rules
 - [`eslint-plugin-vitest`](https://www.npmjs.com/package/eslint-plugin-vitest) - Vitest rules
 - [`eslint-plugin-jest`](https://www.npmjs.com/package/eslint-plugin-jest) - Jest rules
+- [`@convex-dev/eslint-plugin`](https://docs.convex.dev/eslint) - Convex backend rules
 
 ### Prettier Plugins
 

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,10 +34,11 @@ 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";
 
 interface TestingConfig {
     filenamePattern?: "spec" | "test";
@@ -47,6 +49,7 @@ interface TestingConfig {
 }
 
 interface EslintConfigOptions {
+    convex?: boolean;
     functionStyle?: "off" | FunctionStyle;
     ignores?: string[];
     importPlugin?: boolean;
@@ -65,12 +68,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.
@@ -92,12 +98,12 @@ interface EslintConfigOptions {
  *                          - `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 +137,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, 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,6 +486,32 @@ 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,
@@ -1457,7 +1485,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 +1506,7 @@ var rules = {
   "unicorn/filename-case": [
     "warn",
     {
-      case: "kebabCase"
+      case: filenameCase
     }
   ],
   /**
@@ -1530,16 +1558,19 @@ 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 ?? {}
   }
 });
@@ -1553,6 +1584,7 @@ var defaultTestingConfig = {
   itOrTest: "it"
 };
 var eslintConfig = ({
+  convex = false,
   functionStyle = "arrow",
   ignores = [],
   importPlugin = true,
@@ -1565,7 +1597,7 @@ var eslintConfig = ({
   testing = defaultTestingConfig,
   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";
@@ -1629,6 +1661,9 @@ var eslintConfig = ({
   if (query) {
     configs.push(queryConfig(categorizedRules[configNames.query]));
   }
+  if (convex) {
+    configs.push(convexConfig(categorizedRules[configNames.convex]));
+  }
   if (testing !== false) {
     const mergedTestingConfig = isObject(testing) ? { ...defaultTestingConfig, ...testing } : defaultTestingConfig;
     const { filenamePattern, files, formattingRules, framework, itOrTest } = mergedTestingConfig;
@@ -1651,7 +1686,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(