js-style-kit 0.2.11 → 0.3.0

package/dist/index.d.ts

@@ -1,9 +1,130 @@
-export { EslintConfigOptions, eslintConfig } from './eslint/index.js';
-export { EslintConfigObject, EslintRuleConfig, EslintSeverity, FunctionStyle } from './eslint/types.js';
-export { PrettierConfigOptions, PrettierConfigWithPlugins, prettierConfig } from './prettier/index.js';
-import 'eslint';
-import './eslint/testing/config.js';
-import './eslint/constants.js';
-import 'prettier';
-import 'prettier-plugin-sort-json';
-import 'prettier-plugin-tailwindcss';
+import { Linter } from 'eslint';
+import { Config } from 'prettier';
+import { SortJsonOptions } from 'prettier-plugin-sort-json';
+import { PluginOptions } from 'prettier-plugin-tailwindcss';
+
+/**
+ * Debug names for ESLint configuration objects.
+ * These names help identify different configuration sections in ESLint's debug output
+ * and error messages, making it easier to track which rules come from which config.
+ */
+declare const configNames: {
+    readonly base: "base";
+    readonly disableTypeChecked: "typescript-eslint/disable-type-checked";
+    readonly ignores: "ignores";
+    readonly import: "import";
+    readonly jsdoc: "jsdoc";
+    readonly markdown: "markdown";
+    readonly nextjs: "nextjs";
+    readonly perfectionist: "perfectionist";
+    readonly preferArrowFunction: "prefer-arrow-function";
+    readonly react: "react";
+    readonly reactCompiler: "react-compiler";
+    readonly reactRefresh: "react-refresh";
+    readonly storybook: "storybook:stories";
+    readonly storybookConfig: "storybook:config";
+    readonly testing: "testing";
+    readonly turbo: "turbo";
+    readonly typescript: "tseslint";
+    readonly typescriptTesting: "tseslint-testing";
+    readonly unicorn: "unicorn";
+};
+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;
+}
+
+interface TestingConfig {
+    filenamePattern?: "spec" | "test";
+    files?: string[];
+    formattingRules?: boolean;
+    framework?: "bun" | "jest" | "node" | "vitest";
+    itOrTest?: "it" | "test";
+}
+
+interface EslintConfigOptions {
+    functionStyle?: "off" | FunctionStyle;
+    ignores?: string[];
+    importPlugin?: boolean;
+    jsdoc?: false | {
+        requireJsdoc?: boolean;
+    };
+    react?: boolean | {
+        framework?: "next" | "none" | "vite";
+        reactCompiler?: boolean;
+        reactRefresh?: boolean;
+    };
+    rules?: Record<string, EslintRuleConfig>;
+    sorting?: boolean;
+    storybook?: boolean;
+    testing?: false | TestingConfig;
+    turbo?: boolean;
+    typescript?: boolean | string;
+    unicorn?: boolean;
+}
+/**
+ * Configures ESLint based on provided options.
+ *
+ * @param options - The optional configuration object.
+ * @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.
+ * @param options.jsdoc - Whether to include JSDoc rules. Set to false to disable, or provide an object to configure.
+ * @param options.react - Whether to include React rules. When true, reactCompiler is enabled by default.
+ *                        Can be configured with an object to control next.js support and reactCompiler.
+ *                        Also controls reactRefresh, which is enabled by default when react is true.
+ *                        Can specify framework as "next", "none", or "vite" to control related configs:
+ *                        - "next": Includes Next.js config, excludes React Refresh.
+ *                        - "vite" or "none": Includes React Refresh, excludes Next.js.
+ *                        - The reactRefresh property can override this framework-based behavior.
+ * @param options.sorting - Whether to include sorting rules from Perfectionist. Defaults to true.
+ * @param options.storybook - Whether to include Storybook rules. Defaults to false.
+ * @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.
+ *                          - `formattingRules`: Whether to include formatting rules like padding around blocks.
+ *                          - `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.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, react, rules, sorting, storybook, testing, turbo, typescript, unicorn, }?: EslintConfigOptions, ...additionalConfigs: Linter.Config[]) => Linter.Config[];
+
+interface PrettierConfigOptions extends Config {
+    cssOrderPlugin?: boolean;
+    curlyPlugin?: boolean;
+    jsonSortPlugin?: boolean | SortJsonOptions;
+    packageJsonPlugin?: boolean;
+    tailwindPlugin?: boolean | string | PluginOptions;
+}
+interface PrettierConfigWithPlugins extends Config, SortJsonOptions, PluginOptions {
+}
+/**
+ * Creates a Prettier configuration object with optional Tailwind support
+ *
+ * @param options - Configuration options for Prettier
+ * @param options.cssOrderPlugin CSS order sorting support
+ * @param options.curlyPlugin Enforce curly braces for all control statements
+ * @param options.jsonSortPlugin JSON sorting support
+ * @param options.packageJsonPlugin Package.json sorting support
+ * @param options.tailwindPlugin Tailwind CSS formatting support
+ * @returns Prettier configuration object with:
+ * - Default Prettier configuration
+ * - Experimental ternaries enabled
+ * - CSS order plugin
+ * - Curly braces plugin
+ * - JSON sorting plugin
+ * - Package.json sorting plugin
+ * - Optional Tailwind plugin and functions
+ */
+declare const prettierConfig: (options?: PrettierConfigOptions) => PrettierConfigWithPlugins;
+
+export { type EslintConfigObject, type EslintConfigOptions, type EslintRuleConfig, type EslintSeverity, type FunctionStyle, type PrettierConfigOptions, type PrettierConfigWithPlugins, eslintConfig, prettierConfig };