zeno-config 1.0.1 → 1.0.2

package/README.md

@@ -44,6 +44,7 @@ Create an `eslint.config.js` file in your project root:
 ```javascript
 import { defineZenoConfig } from 'zeno-config/eslint';
 
+// defineZenoConfig returns a Promise - ESLint 9+ flat config supports this natively
 export default defineZenoConfig({
 	ts: true, // Enable TypeScript support (default: false)
 	react: true, // Enable React support (default: false)
@@ -64,13 +65,13 @@ This is a workaround for a [known limitation](https://github.com/import-js/eslin
 
 Add an `engines` field to your `package.json` with your supported Node.js versions. Some rules for Node.js use this:
 
- ```json
- {
- 	"engines": {
- 		"node": ">=20"
- 	}
- }
- ```
+```json
+{
+	"engines": {
+		"node": ">=20"
+	}
+}
+```
 
 #### Advanced Configuration
 
@@ -213,13 +214,14 @@ import zenoInternals from 'zeno-config/eslint';
 
 const { configs, rules, extensions } = zenoInternals;
 
-export default [
+// Note: getReact() and getTypescript() are async (return Promises)
+export default (async () => [
 	...configs.getBase(),
 	...configs.getNode(),
-	...configs.getReact(),
-	...configs.getTypescript(),
+	...(await configs.getReact()),
+	...(await configs.getTypescript()),
 	// Your custom configs
-];
+])();
 ```
 
 ### Accessing Individual Rules

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zeno-config",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Preconfigured and opinionated ESLint, Prettier, and TypeScript setup",
   "author": "Rick Brenn <brenn.rick@gmail.com>",
   "license": "MIT",

package/src/eslint/index.d.ts

@@ -57,9 +57,9 @@ interface Extensions {
 
 interface Configs {
 	getBase: (options?: BaseConfigOptions) => Linter.Config[];
-	getReact: (options?: ReactConfigOptions) => Linter.Config[];
+	getReact: (options?: ReactConfigOptions) => Promise<Linter.Config[]>;
 	getNode: (options?: NodeConfigOptions) => Linter.Config[];
-	getTypescript: () => Linter.Config[];
+	getTypescript: () => Promise<Linter.Config[]>;
 }
 
 interface Rules {
@@ -89,26 +89,29 @@ declare const internals: Internals;
 /**
  * Defines a Zeno ESLint configuration.
  *
+ * This function is async because React and TypeScript dependencies are loaded
+ * dynamically (only when enabled) to avoid errors when optional deps aren't installed.
+ *
  * @param arg1 - Options object or additional config array. If an array, treated as additional config.
  * @param arg2 - Additional ESLint config objects to merge (only used if arg1 is options object).
- * @returns ESLint flat config array.
+ * @returns Promise that resolves to ESLint flat config array.
  *
  * @example
- * // With options object
- * defineZenoConfig({ react: true, ts: true })
+ * // With options object (using default export)
+ * export default defineZenoConfig({ react: true, ts: true })
  *
  * @example
  * // With additional config
- * defineZenoConfig({ react: true }, [customConfig])
+ * export default defineZenoConfig({ react: true }, [customConfig])
  *
  * @example
  * // With config array only
- * defineZenoConfig([customConfig])
+ * export default defineZenoConfig([customConfig])
  */
 declare function defineZenoConfig(
 	arg1?: DefineZenoConfigOptions | Linter.Config[],
 	arg2?: Linter.Config[]
-): Linter.Config[];
+): Promise<Linter.Config[]>;
 
 export {
 	type BaseConfigOptions,

package/src/eslint/index.js

@@ -2,15 +2,10 @@ import { defineConfig } from 'eslint/config';
 import js from '@eslint/js';
 import globals from 'globals';
 import importX from 'eslint-plugin-import-x';
-import reactPlugin from 'eslint-plugin-react';
-import reactHooksPlugin from 'eslint-plugin-react-hooks';
 import prettierPlugin from 'eslint-plugin-prettier/recommended';
 import stylisticPlugin from '@stylistic/eslint-plugin';
 import nodePlugin from 'eslint-plugin-n';
-import reactYouMightNotNeedAnEffectPlugin from 'eslint-plugin-react-you-might-not-need-an-effect';
-import jsxA11yPlugin from 'eslint-plugin-jsx-a11y';
 import unicornPlugin from 'eslint-plugin-unicorn';
-import typescriptEslint from 'typescript-eslint';
 import getBaseRules from './rules/baseRules.js';
 import getImportPluginRules from './rules/importPluginRules.js';
 import getReactPluginRules from './rules/reactPluginRules.js';
@@ -138,9 +133,22 @@ const nodeConfig = (options = {}) => {
  * @param {Object} [options={}] - Configuration options.
  * @param {string[]} [options.reactDirs] - Directories containing React files (for projects using .js for both React and Node).
  * @param {Object} [options.extensionsIgnorePattern] - Extension patterns to ignore for import rules.
- * @returns {Array} ESLint flat config array.
+ * @returns {Promise<Array>} ESLint flat config array.
  */
-const reactConfig = (options = {}) => {
+const reactConfig = async (options = {}) => {
+	// Dynamically import optional React dependencies
+	const [
+		{ default: reactPlugin },
+		{ default: reactHooksPlugin },
+		{ default: jsxA11yPlugin },
+		{ default: reactYouMightNotNeedAnEffectPlugin },
+	] = await Promise.all([
+		import('eslint-plugin-react'),
+		import('eslint-plugin-react-hooks'),
+		import('eslint-plugin-jsx-a11y'),
+		import('eslint-plugin-react-you-might-not-need-an-effect'),
+	]);
+
 	let files = [`**/*{${reactExtensionsString}}`];
 	let extensions = reactExtensions;
 
@@ -208,9 +216,12 @@ const reactConfig = (options = {}) => {
 /**
  * Creates the TypeScript-specific ESLint configuration.
  *
- * @returns {Array} ESLint flat config array.
+ * @returns {Promise<Array>} ESLint flat config array.
  */
-const typescriptConfig = () => {
+const typescriptConfig = async () => {
+	// Dynamically import optional TypeScript dependencies
+	const { default: typescriptEslint } = await import('typescript-eslint');
+
 	return [
 		{
 			name: 'zeno/typescript',
@@ -285,7 +296,7 @@ const internals = {
  * @param {Object} [arg1.extensionsIgnorePattern={}] - Extension patterns to ignore for import rules.
  * @param {string} [arg1.webpackConfig] - Path to webpack config for import resolver.
  * @param {Array} [arg2] - Additional ESLint config objects to merge (only used if arg1 is options object).
- * @returns {Array} ESLint flat config array.
+ * @returns {Promise<Array>} ESLint flat config array.
  *
  * @example
  * // With options object
@@ -299,7 +310,7 @@ const internals = {
  * // With config array only
  * defineZenoConfig([customConfig])
  */
-const defineZenoConfig = (arg1, arg2) => {
+const defineZenoConfig = async (arg1, arg2) => {
 	let options = {
 		react: false,
 		ts: false,
@@ -347,6 +358,17 @@ const defineZenoConfig = (arg1, arg2) => {
 		options.nodeIgnoreDirs = [...options.reactDirs];
 	}
 
+	// Load optional configs in parallel if needed
+	const [reactConfigResult, tsConfigResult] = await Promise.all([
+		options.react
+			? configs.getReact({
+					reactDirs: options.reactDirs,
+					extensionsIgnorePattern: options.extensionsIgnorePattern,
+				})
+			: Promise.resolve([]),
+		options.ts ? configs.getTypescript() : Promise.resolve([]),
+	]);
+
 	return defineConfig([
 		...configs.getBase({
 			ignoreExports: options.ignoreExports,
@@ -354,13 +376,8 @@ const defineZenoConfig = (arg1, arg2) => {
 			extensionsIgnorePattern: options.extensionsIgnorePattern,
 		}),
 		...configs.getNode({ ignoreDirs: options.nodeIgnoreDirs }),
-		...(options.react
-			? configs.getReact({
-					reactDirs: options.reactDirs,
-					extensionsIgnorePattern: options.extensionsIgnorePattern,
-				})
-			: []),
-		...(options.ts ? configs.getTypescript() : []),
+		...reactConfigResult,
+		...tsConfigResult,
 
 		...(config || []),