@agilebot/eslint-config 0.7.1 → 0.7.3

package/README.md

@@ -2,16 +2,116 @@
 
 [![npm](https://img.shields.io/npm/v/@agilebot/eslint-config?color=444&label=)](https://npmjs.com/package/@agilebot/eslint-config)
 
-### Usage
+## Usage
+
+### Manual Install
 
 ```bash
 npm install --save-dev eslint \
   @agilebot/eslint-config
 ```
 
+And create `eslint.config.mjs` in your project root:
+
+```js
+// eslint.config.mjs
+import { agilebot } from '@agilebot/eslint-config';
+
+export default agilebot(import.meta);
+```
+
+## Customization
+
+The `agilebot` preset provides a streamlined way to configure your ESLint setup. Here’s how you can use it and customize it based on your needs.
+
+### Basic Usage
+
+To get started, import the `agilebot` preset:
+
 ```js
-// eslint.config.js
-const { agilebot } = require('@agilebot/eslint-config');
+// eslint.config.mjs
+import { agilebot } from '@agilebot/eslint-config';
+
+export default agilebot(import.meta);
+```
+
+This will automatically apply the default configurations provided by `agilebot`.
+
+### Advanced Customization
+
+If you want more control, you can customize individual integrations using the `FactoryOptions` interface. For example:
+
+```js
+// eslint.config.mjs
+import { agilebot } from '@agilebot/eslint-config';
+
+export default agilebot(import.meta, {
+  // Replace `.eslintignore` with the `ignores` option
+  ignores: [
+    '**/fixtures'
+    // Add more glob patterns as needed
+  ],
+
+  // List of files or directories where development dependencies are allowed
+  // Accepts glob patterns, e.g., '**/scripts/**', '**/test/**'
+  devDependencies: ['**/scripts/**', '**/test/**'],
+
+  // List of modules to be treated as built-in
+  // Accepts an array of module names, e.g., ['electron']
+  coreModules: ['electron'],
+
+  // Enable React-specific linting rules
+  // Accepts `true`, `false`, or a specific version string, e.g., '17.0.0'
+  react: true,
+
+  // Specify the Vue.js version for linting
+  // Accepts a number, e.g., 2 or 3
+  vue: 3,
+
+  // Enable imports-related configurations
+  import: true,
+
+  // Specify the import resolver to use
+  // Accepts 'typescript' or 'oxc'
+  importResolver: 'typescript',
+
+  // Enable Lodash-specific linting rules
+  // Accepts `true` or `false`
+  lodash: true,
+
+  // Enable Prettier for code formatting
+  // Accepts `true` or `false`
+  prettier: true,
+
+  // Enable or disable JSDoc linting rules
+  // Accepts `true` or `false`
+  jsdoc: false,
+
+  // Enable ES module linting rules
+  // Accepts `true` or `false`
+  module: true,
+
+  // Apply specific monorepo configurations
+  // Accepts a string representing the monorepo scope, e.g., '@my-app'
+  monorepoScope: '@my-app',
+
+  // Custom spelling configurations for CSpell
+  // Accepts a configuration object or `false` to disable CSpell
+  cspell: {
+    words: ['agilebot', 'eslint'],
+    ignorePaths: ['**/node_modules']
+  },
+
+  // Enable GoDaddy-specific linting configurations
+  // Accepts `true`, `false`, or 'typescript' for TypeScript-specific rules
+  godaddy: 'typescript',
 
-module.exports = agilebot(__dirname);
+  // Custom ESLint configuration to override or extend defaults
+  config: {
+    rules: {
+      'no-console': 'warn',
+      'prefer-const': 'error'
+    }
+  }
+});
 ```

package/dist/{chunk-MQP5VK72.mjs → chunk-CGJVNMKG.mjs}

@@ -1,5 +1,5 @@
 /**
- * @license @agilebot/eslint-config v0.7.1
+ * @license @agilebot/eslint-config v0.7.3
  *
  * Copyright (c) Agilebot, Inc. and its affiliates.
  *

package/dist/cli.js

@@ -1,5 +1,5 @@
 /**
- * @license @agilebot/eslint-config v0.7.1
+ * @license @agilebot/eslint-config v0.7.3
  *
  * Copyright (c) Agilebot, Inc. and its affiliates.
  *
@@ -52,6 +52,17 @@ var CLI_NAME = "eslint-agilebot";
 
 // src/cli/stages/eslint.ts
 var import_node_path = __toESM(require("path"));
+function patch() {
+  if (console?.error) {
+    const origConsoleError = console.error;
+    console.error = (...args) => {
+      if (args?.[0]?.includes("React version not specified")) {
+        return;
+      }
+      origConsoleError(...args);
+    };
+  }
+}
 function runBinary() {
   const pkg = require.resolve("eslint/package.json");
   const bin = import_node_path.default.join(pkg, "..", "bin", "eslint.js");
@@ -60,6 +71,7 @@ function runBinary() {
 
 // src/cli/index.ts
 function cli() {
+  patch();
   const argv = (0, import_yargs.default)((0, import_helpers.hideBin)(process.argv)).scriptName(CLI_NAME).usage(`${CLI_NAME} [options] file.js [file.js] [dir]`).options({
     config: {
       alias: "c",

package/dist/cli.mjs

@@ -1,5 +1,5 @@
 /**
- * @license @agilebot/eslint-config v0.7.1
+ * @license @agilebot/eslint-config v0.7.3
  *
  * Copyright (c) Agilebot, Inc. and its affiliates.
  *
@@ -10,7 +10,7 @@
 import {
   CLI_NAME,
   __require
-} from "./chunk-MQP5VK72.mjs";
+} from "./chunk-CGJVNMKG.mjs";
 
 // src/cli/index.ts
 import { isCI } from "@agilebot/eslint-utils";
@@ -20,6 +20,17 @@ import pc from "picocolors";
 
 // src/cli/stages/eslint.ts
 import path from "node:path";
+function patch() {
+  if (console?.error) {
+    const origConsoleError = console.error;
+    console.error = (...args) => {
+      if (args?.[0]?.includes("React version not specified")) {
+        return;
+      }
+      origConsoleError(...args);
+    };
+  }
+}
 function runBinary() {
   const pkg = __require.resolve("eslint/package.json");
   const bin = path.join(pkg, "..", "bin", "eslint.js");
@@ -28,6 +39,7 @@ function runBinary() {
 
 // src/cli/index.ts
 function cli() {
+  patch();
   const argv = yargs(hideBin(process.argv)).scriptName(CLI_NAME).usage(`${CLI_NAME} [options] file.js [file.js] [dir]`).options({
     config: {
       alias: "c",

package/dist/index.d.mts

@@ -11,7 +11,7 @@ type Options = Options$1['cspell'];
 
 interface FactoryOptions {
     /**
-     * ESLint configuration
+     * Custom ESLint configuration to override or extend defaults
      * @default undefined
      */
     config?: Omit<FlatConfigItem, 'name' | 'files'>;
@@ -21,62 +21,62 @@ interface FactoryOptions {
      */
     ignores?: string[];
     /**
-     * List of development dependencies
+     * List of files or directories where development dependencies are allowed
      * @default undefined
      */
     devDependencies?: string[];
     /**
-     * List of core modules
+     * List of modules to be treated as built-in
      * @default undefined
      */
     coreModules?: string[];
     /**
-     * Monorepo scope
+     * Specific monorepo scope to apply configurations for
      * @default undefined
      */
     monorepoScope?: string;
     /**
-     * Flag indicating whether to enable React configurations
+     * Enable React-specific linting rules
      * @default undefined
      */
     react?: boolean | string;
     /**
-     * Version of Vue.js (optional)
+     * Specify the Vue.js version for linting
      * @default undefined
      */
     vue?: number;
     /**
-     * Flag indicating whether ES modules are used
+     * Enable ES module linting rules
      * @default undefined
      */
     module?: boolean;
     /**
-     * Flag indicating whether to enable GoDaddy configurations
+     * Enable GoDaddy-specific linting configurations
      * @default undefined
      */
     godaddy?: boolean | 'typescript';
     /**
-     * Flag indicating whether to enable JSDoc configurations
+     * Enable or disable JSDoc linting rules
      * @default true
      */
     jsdoc?: boolean;
     /**
-     * Flag indicating whether to enable Prettier configurations
+     * Enable Prettier for code formatting
      * @default true
      */
     prettier?: boolean;
     /**
-     * Flag indicating whether to enable Lodash configurations
+     * Enable Lodash-specific linting rules
      * @default true
      */
     lodash?: boolean;
     /**
-     * Flag indicating whether to enable CSpell configurations
+     * Custom spelling configurations for CSpell
      * @default {}
      */
     cspell?: Options | false;
     /**
-     * Flag indicating whether to enable imports configurations
+     * Enable imports-related linting configurations
      * @default true
      */
     import?: boolean;

package/dist/index.d.ts

@@ -11,7 +11,7 @@ type Options = Options$1['cspell'];
 
 interface FactoryOptions {
     /**
-     * ESLint configuration
+     * Custom ESLint configuration to override or extend defaults
      * @default undefined
      */
     config?: Omit<FlatConfigItem, 'name' | 'files'>;
@@ -21,62 +21,62 @@ interface FactoryOptions {
      */
     ignores?: string[];
     /**
-     * List of development dependencies
+     * List of files or directories where development dependencies are allowed
      * @default undefined
      */
     devDependencies?: string[];
     /**
-     * List of core modules
+     * List of modules to be treated as built-in
      * @default undefined
      */
     coreModules?: string[];
     /**
-     * Monorepo scope
+     * Specific monorepo scope to apply configurations for
      * @default undefined
      */
     monorepoScope?: string;
     /**
-     * Flag indicating whether to enable React configurations
+     * Enable React-specific linting rules
      * @default undefined
      */
     react?: boolean | string;
     /**
-     * Version of Vue.js (optional)
+     * Specify the Vue.js version for linting
      * @default undefined
      */
     vue?: number;
     /**
-     * Flag indicating whether ES modules are used
+     * Enable ES module linting rules
      * @default undefined
      */
     module?: boolean;
     /**
-     * Flag indicating whether to enable GoDaddy configurations
+     * Enable GoDaddy-specific linting configurations
      * @default undefined
      */
     godaddy?: boolean | 'typescript';
     /**
-     * Flag indicating whether to enable JSDoc configurations
+     * Enable or disable JSDoc linting rules
      * @default true
      */
     jsdoc?: boolean;
     /**
-     * Flag indicating whether to enable Prettier configurations
+     * Enable Prettier for code formatting
      * @default true
      */
     prettier?: boolean;
     /**
-     * Flag indicating whether to enable Lodash configurations
+     * Enable Lodash-specific linting rules
      * @default true
      */
     lodash?: boolean;
     /**
-     * Flag indicating whether to enable CSpell configurations
+     * Custom spelling configurations for CSpell
      * @default {}
      */
     cspell?: Options | false;
     /**
-     * Flag indicating whether to enable imports configurations
+     * Enable imports-related linting configurations
      * @default true
      */
     import?: boolean;

package/dist/index.js

@@ -1,5 +1,5 @@
 /**
- * @license @agilebot/eslint-config v0.7.1
+ * @license @agilebot/eslint-config v0.7.3
  *
  * Copyright (c) Agilebot, Inc. and its affiliates.
  *
@@ -618,6 +618,7 @@ function react(opts) {
       "@eslint-react/dom/no-dangerously-set-innerhtml-with-children": "error",
       "@eslint-react/dom/no-find-dom-node": "error",
       "@eslint-react/dom/no-render-return-value": "error",
+      "@eslint-react/dom/no-unknown-property": "error",
       // recommended rules from @eslint-react/hooks-extra
       "@eslint-react/hooks-extra/prefer-use-state-lazy-initialization": "warn",
       // recommended rules react-hooks
@@ -671,7 +672,6 @@ function reactJsOnly() {
       "react/jsx-no-undef": "error",
       "react/jsx-uses-react": "error",
       "react/no-unescaped-entities": "error",
-      "react/no-unknown-property": "error",
       "react/react-in-jsx-scope": "error",
       "react/require-render-return": "error"
     }
@@ -1016,8 +1016,10 @@ function factory(root, options) {
   let rootDir;
   if (typeof root === "string") {
     rootDir = root;
-  } else {
+  } else if (root?.url) {
     rootDir = import_node_path3.default.dirname((0, import_node_url.fileURLToPath)(root.url));
+  } else {
+    throw new Error("root must be a string or ImportMeta");
   }
   const tsconfigFiles = (0, import_eslint_utils3.findTsconfigFiles)(rootDir, {
     absolute: true

package/dist/index.mjs

@@ -1,5 +1,5 @@
 /**
- * @license @agilebot/eslint-config v0.7.1
+ * @license @agilebot/eslint-config v0.7.3
  *
  * Copyright (c) Agilebot, Inc. and its affiliates.
  *
@@ -16,7 +16,7 @@ import {
   VUE_GLOBS,
   __dirname,
   define_STANDARD_RULES_default
-} from "./chunk-MQP5VK72.mjs";
+} from "./chunk-CGJVNMKG.mjs";
 
 // src/factory/index.ts
 import assert from "node:assert";
@@ -543,6 +543,7 @@ function react(opts) {
       "@eslint-react/dom/no-dangerously-set-innerhtml-with-children": "error",
       "@eslint-react/dom/no-find-dom-node": "error",
       "@eslint-react/dom/no-render-return-value": "error",
+      "@eslint-react/dom/no-unknown-property": "error",
       // recommended rules from @eslint-react/hooks-extra
       "@eslint-react/hooks-extra/prefer-use-state-lazy-initialization": "warn",
       // recommended rules react-hooks
@@ -596,7 +597,6 @@ function reactJsOnly() {
       "react/jsx-no-undef": "error",
       "react/jsx-uses-react": "error",
       "react/no-unescaped-entities": "error",
-      "react/no-unknown-property": "error",
       "react/react-in-jsx-scope": "error",
       "react/require-render-return": "error"
     }
@@ -939,8 +939,10 @@ function factory(root, options) {
   let rootDir;
   if (typeof root === "string") {
     rootDir = root;
-  } else {
+  } else if (root?.url) {
     rootDir = path2.dirname(fileURLToPath(root.url));
+  } else {
+    throw new Error("root must be a string or ImportMeta");
   }
   const tsconfigFiles = findTsconfigFiles(rootDir, {
     absolute: true

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agilebot/eslint-config",
-  "version": "0.7.1",
+  "version": "0.7.3",
   "description": "Agilebot's ESLint config",
   "bin": {
     "eslint-agilebot": "bin/eslint-agilebot"
@@ -58,7 +58,7 @@
     "picocolors": "^1.1.0",
     "vue-eslint-parser": "^9.4.3",
     "yargs": "^17.7.2",
-    "@agilebot/eslint-utils": "0.7.1"
+    "@agilebot/eslint-utils": "0.7.3"
   },
   "devDependencies": {
     "@types/yargs": "^17.0.33",
@@ -66,7 +66,7 @@
   },
   "peerDependencies": {
     "eslint": "^8.57.0 || ^9.0.0",
-    "@agilebot/eslint-plugin": "0.7.1"
+    "@agilebot/eslint-plugin": "0.7.3"
   },
   "files": [
     "bin",