@bfra.me/eslint-config 0.44.1 → 0.44.2

package/lib/index.d.ts

@@ -17416,32 +17416,6 @@ declare function defineConfig<C extends Config = Config, CN extends ConfigNames
  */
 declare const composeConfig: <C extends Config = Config, CN extends ConfigNames = ConfigNames>(...configs: ResolvableFlatConfig<Config extends C ? C : Config>[]) => FlatConfigComposer<Config extends C ? C : Config, CN>;
 
-/**
- * Check if the process is running in a Git hook or under lint-staged.
- *
- * @example
- * ```ts
- * import {isInGitLifecycle} from '@bfra.me/eslint-config'
- *
- * if (isInGitLifecycle) {
- *   console.log('Running in a Git hook or under lint-staged')
- * }
- * ```
- */
-declare const isInGitLifecycle: boolean;
-/**
- * Check if the process is running in an editor.
- *
- * @example
- * ```ts
- * import {isInEditor} from '@bfra.me/eslint-config'
- *
- * if (isInEditor) {
- *   console.log('Running in an editor')
- * }
- */
-declare const isInEditor: boolean;
-
 declare const GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
 declare const GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
 declare const GLOB_JS = "**/*.?([cm])js";
@@ -17472,4 +17446,4 @@ declare const GLOB_EXCLUDE: string[];
 
 declare const config: eslint_flat_config_utils.FlatConfigComposer<Config, ConfigNames>;
 
-export { type AstroOptions, type Config, type ConfigNames, type FallbackOptions, type Flatten, GLOB_ASTRO, GLOB_ASTRO_TS, GLOB_CODE_IN_MARKDOWN_FILES, GLOB_EXCLUDE, GLOB_EXT_IN_MARKDOWN_FILES, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSON_FILES, GLOB_JSX, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_FILES, GLOB_MARKDOWN_IN_MARKDOWN, GLOB_PACKAGE_JSON_FILES, GLOB_RENOVATE_CONFIG, GLOB_SRC, GLOB_SRC_EXT, GLOB_TESTS, GLOB_TOML, GLOB_TOML_FILES, GLOB_TS, GLOB_TSX, GLOB_TS_CONFIG, GLOB_YAML, GLOB_YAML_FILES, type ImportsOptions, type JSDocOptions, type JavaScriptOptions, type JsoncOptions, type MarkdownCodeBlockOptions, type MarkdownFrontmatterOptions, type MarkdownLanguage, type MarkdownOptions, type NextjsOptions, type Options, type OptionsFiles, type OptionsIsInEditor, type OptionsOverrides, type OptionsPerfectionist, type OptionsStylistic, type OptionsTypeScript, type OptionsTypeScriptErasableSyntaxOnly, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type PackageJsonOptions, type PerfectionistOptions, type PrettierOptions, type ReactOptions, type RegexpOptions, type Rules, type StylisticConfig, StylisticConfigDefaults, type StylisticOptions, type TomlOptions, type TypeScriptOptions, type UnicornOptions, type VitestOptions, type YamlOptions, astro, command, composeConfig, config, config as default, defineConfig, epilogue, eslintComments, fallback, gitignore, ignores, imports, isInEditor, isInGitLifecycle, javascript, jsdoc, jsonc, markdown, nextjs, node, packageJson, perfectionist, pnpm, prettier, react, regexp, sortPackageJson, sortRenovateConfig, sortTsconfig, stylistic, toml, typescript, unicorn, vitest, yaml };
+export { type AstroOptions, type Config, type ConfigNames, type FallbackOptions, type Flatten, GLOB_ASTRO, GLOB_ASTRO_TS, GLOB_CODE_IN_MARKDOWN_FILES, GLOB_EXCLUDE, GLOB_EXT_IN_MARKDOWN_FILES, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSON_FILES, GLOB_JSX, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_FILES, GLOB_MARKDOWN_IN_MARKDOWN, GLOB_PACKAGE_JSON_FILES, GLOB_RENOVATE_CONFIG, GLOB_SRC, GLOB_SRC_EXT, GLOB_TESTS, GLOB_TOML, GLOB_TOML_FILES, GLOB_TS, GLOB_TSX, GLOB_TS_CONFIG, GLOB_YAML, GLOB_YAML_FILES, type ImportsOptions, type JSDocOptions, type JavaScriptOptions, type JsoncOptions, type MarkdownCodeBlockOptions, type MarkdownFrontmatterOptions, type MarkdownLanguage, type MarkdownOptions, type NextjsOptions, type Options, type OptionsFiles, type OptionsIsInEditor, type OptionsOverrides, type OptionsPerfectionist, type OptionsStylistic, type OptionsTypeScript, type OptionsTypeScriptErasableSyntaxOnly, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type PackageJsonOptions, type PerfectionistOptions, type PrettierOptions, type ReactOptions, type RegexpOptions, type Rules, type StylisticConfig, StylisticConfigDefaults, type StylisticOptions, type TomlOptions, type TypeScriptOptions, type UnicornOptions, type VitestOptions, type YamlOptions, astro, command, composeConfig, config, config as default, defineConfig, epilogue, eslintComments, fallback, gitignore, ignores, imports, javascript, jsdoc, jsonc, markdown, nextjs, node, packageJson, perfectionist, pnpm, prettier, react, regexp, sortPackageJson, sortRenovateConfig, sortTsconfig, stylistic, toml, typescript, unicorn, vitest, yaml };

package/lib/index.js

@@ -1,3 +1,6 @@
+// src/define-config.ts
+import { isPackageExists as isPackageExists4 } from "local-pkg";
+
 // src/compose-config.ts
 import { composer } from "eslint-flat-config-utils";
 var composeConfig = (...configs) => composer(...configs);
@@ -109,7 +112,7 @@ var GLOB_EXCLUDE = [
 import { fileURLToPath } from "url";
 
 // package.json
-var version = "0.44.1";
+var version = "0.44.2";
 
 // src/parsers/any-parser.ts
 var lineBreakPattern = /\r\n|[\n\r\u2028\u2029]/u;
@@ -143,7 +146,9 @@ function parseForESLint(text) {
 var anyParser = { meta, parseForESLint };
 
 // src/utils.ts
+import process from "process";
 import { fileURLToPath as fileURLToPath2 } from "url";
+import isInCI from "is-in-ci";
 import { isPackageExists } from "local-pkg";
 var scopeUrl = fileURLToPath2(new URL(".", import.meta.url));
 // @__NO_SIDE_EFFECTS__
@@ -154,6 +159,14 @@ async function interopDefault(m) {
 function isPackageInScope(name) {
   return isPackageExists(name, { paths: [scopeUrl] });
 }
+function isInGitLifecycle() {
+  return !!(typeof process.env.GIT_PARAMS === "string" && process.env.GIT_PARAMS.length > 0 || typeof process.env.VSCODE_GIT_COMMAND === "string" && process.env.VSCODE_GIT_COMMAND.length > 0 || process.env.npm_lifecycle_script?.startsWith("lint-staged") || process.env.npm_lifecycle_script?.startsWith("nano-staged"));
+}
+function isInEditorEnv() {
+  if (isInCI) return false;
+  if (isInGitLifecycle()) return false;
+  return !!(typeof process.env.VSCODE_PID === "string" && process.env.VSCODE_PID.length > 0 || typeof process.env.VSCODE_CWD === "string" && process.env.VSCODE_CWD.length > 0 || typeof process.env.JETBRAINS_IDE === "string" && process.env.JETBRAINS_IDE.length > 0 || typeof process.env.VIM === "string" && process.env.VIM.length > 0 || typeof process.env.NVIM === "string" && process.env.NVIM.length > 0);
+}
 
 // src/require-of.ts
 var packageExistsCache = /* @__PURE__ */ new Map();
@@ -384,7 +397,7 @@ function imports(options = {}) {
 // src/configs/javascript.ts
 import globals from "globals";
 async function javascript(options = {}) {
-  const { isInEditor: isInEditor2 = false, jsx = true, overrides = {} } = options;
+  const { isInEditor = false, jsx = true, overrides = {} } = options;
   const pluginUnusedImports = await interopDefault(import("eslint-plugin-unused-imports"));
   return [
     {
@@ -573,7 +586,7 @@ async function javascript(options = {}) {
         "prefer-template": "error",
         "symbol-description": "error",
         "unicode-bom": ["error", "never"],
-        "unused-imports/no-unused-imports": isInEditor2 ? "off" : "error",
+        "unused-imports/no-unused-imports": isInEditor ? "off" : "error",
         "unused-imports/no-unused-vars": [
           "error",
           {
@@ -1056,7 +1069,7 @@ async function packageJson(options = {}) {
 // src/configs/perfectionist.ts
 async function perfectionist(options = {}) {
   const {
-    isInEditor: isInEditor2 = false,
+    isInEditor = false,
     overrides = {},
     sortExports = true,
     sortImports = true,
@@ -1073,22 +1086,22 @@ async function perfectionist(options = {}) {
       rules: {
         ...sortNamedExports && {
           "perfectionist/sort-named-exports": [
-            isInEditor2 ? "warn" : "error",
+            isInEditor ? "warn" : "error",
             { groupKind: "values-first", type: "natural" }
           ]
         },
         ...sortNamedImports && {
           "perfectionist/sort-named-imports": [
-            isInEditor2 ? "warn" : "error",
+            isInEditor ? "warn" : "error",
             { groupKind: "values-first", type: "natural" }
           ]
         },
         ...sortExports && {
-          "perfectionist/sort-exports": [isInEditor2 ? "warn" : "error", { type: "natural" }]
+          "perfectionist/sort-exports": [isInEditor ? "warn" : "error", { type: "natural" }]
         },
         ...sortImports && {
           "perfectionist/sort-imports": [
-            isInEditor2 ? "warn" : "error",
+            isInEditor ? "warn" : "error",
             {
               groups: [
                 "type",
@@ -1156,14 +1169,14 @@ async function pnpm() {
 }
 
 // src/configs/prettier.ts
-import process from "process";
+import process2 from "process";
 import { isPackageExists as isPackageExists2 } from "local-pkg";
 async function prettier(options = {}) {
-  const { isInEditor: isInEditor2, overrides } = options;
+  const { isInEditor, overrides } = options;
   return requireOf(
     ["eslint-config-prettier", "eslint-plugin-prettier", "prettier"],
     async () => {
-      process.env.ESLINT_CONFIG_PRETTIER_NO_DEPRECATED ??= "true";
+      process2.env.ESLINT_CONFIG_PRETTIER_NO_DEPRECATED ??= "true";
       const [configPrettier, pluginPrettier, pluginJsonc, pluginYaml] = await Promise.all([
         interopDefault(import("eslint-config-prettier")),
         interopDefault(import("eslint-plugin-prettier")),
@@ -1177,7 +1190,7 @@ async function prettier(options = {}) {
             prettier: pluginPrettier
           },
           rules: {
-            "prettier/prettier": isInEditor2 ? "warn" : "error",
+            "prettier/prettier": isInEditor ? "warn" : "error",
             ...configPrettier.rules,
             ...pluginJsonc?.configs.prettier.rules,
             "toml/array-bracket-newline": "off",
@@ -1739,7 +1752,7 @@ async function toml(options = {}) {
 }
 
 // src/configs/typescript.ts
-import process2 from "process";
+import process3 from "process";
 var TypeAwareRules = {
   "@typescript-eslint/await-thenable": "error",
   "@typescript-eslint/dot-notation": ["error", { allowKeywords: true }],
@@ -1830,7 +1843,7 @@ async function typescript(options = {}) {
             allowDefaultProject: ["./*.js"],
             defaultProject: tsconfigPath
           },
-          tsconfigRootDir: process2.cwd()
+          tsconfigRootDir: process3.cwd()
         } : {},
         ...parserOptions
       }
@@ -2034,7 +2047,7 @@ async function unicorn(options = {}) {
 
 // src/configs/vitest.ts
 async function vitest(options = {}) {
-  const { files = GLOB_TESTS, isInEditor: isInEditor2 = false, overrides = {}, tsconfigPath } = options;
+  const { files = GLOB_TESTS, isInEditor = false, overrides = {}, tsconfigPath } = options;
   const isTypeAware = typeof tsconfigPath === "string" && tsconfigPath.trim().length > 0;
   return requireOf(
     ["@vitest/eslint-plugin"],
@@ -2062,7 +2075,7 @@ async function vitest(options = {}) {
           rules: {
             ...vitest2.configs?.recommended.rules ?? {},
             "vitest/consistent-test-it": ["error", { fn: "it", withinDescribe: "it" }],
-            "vitest/no-focused-tests": isInEditor2 ? "off" : ["error", { fixable: true }],
+            "vitest/no-focused-tests": isInEditor ? "off" : ["error", { fixable: true }],
             "vitest/no-import-node-test": "error",
             "vitest/prefer-hooks-in-order": "error",
             "vitest/prefer-lowercase-title": "error",
@@ -2135,14 +2148,6 @@ async function yaml(options = {}) {
   ];
 }
 
-// src/env.ts
-import { env } from "process";
-import isInCI from "is-in-ci";
-var isInGitLifecycle = !!(typeof env.GIT_PARAMS === "string" && env.GIT_PARAMS.length > 0 || typeof env.VSCODE_GIT_COMMAND === "string" && env.VSCODE_GIT_COMMAND.length > 0 || env.npm_lifecycle_script?.startsWith("lint-staged") || env.npm_lifecycle_script?.startsWith("nano-staged"));
-var isInEditor = !isInCI && !isInGitLifecycle && Boolean(
-  typeof env.VSCODE_PID === "string" && env.VSCODE_PID.length > 0 || typeof env.VSCODE_CWD === "string" && env.VSCODE_CWD.length > 0 || typeof env.JETBRAINS_IDE === "string" && env.JETBRAINS_IDE.length > 0 || typeof env.VIM === "string" && env.VIM.length > 0 || typeof env.NVIM === "string" && env.NVIM.length > 0
-);
-
 // src/define-config.ts
 var AllowedConfigPropertiesForOptions = [
   "name",
@@ -2165,17 +2170,21 @@ async function defineConfig(options = {}, ...userConfigs) {
     packageJson: enablePackageJson = false,
     perfectionist: enablePerfectionist = true,
     pnpm: enableCatalogs = false,
-    prettier: enablePrettier = isPackageInScope("prettier"),
+    prettier: enablePrettier = isPackageExists4("prettier"),
     react: enableReact = false,
     regexp: enableRegexp = true,
-    typescript: enableTypeScript = isPackageInScope("typescript"),
+    typescript: enableTypeScript = isPackageExists4("typescript"),
     unicorn: enableUnicorn = true
   } = options;
-  const isInEditor2 = options.isInEditor ?? isInEditor;
-  if (isInEditor2)
-    console.log(
-      "[@bfra.me/eslint-config] Editor specific config is enabled. Some rules may be disabled."
-    );
+  let isInEditor = options.isInEditor;
+  if (isInEditor == null) {
+    isInEditor = isInEditorEnv();
+    if (isInEditor) {
+      console.log(
+        "[@bfra.me/eslint-config] Editor specific config is enabled. Some rules may be disabled."
+      );
+    }
+  }
   const stylisticOptions = options.stylistic === false || enablePrettier ? false : typeof options.stylistic === "object" ? options.stylistic : {};
   if (stylisticOptions && !("jsx" in stylisticOptions)) {
     stylisticOptions.jsx = typeof enableJsx === "object" ? true : enableJsx;
@@ -2186,7 +2195,7 @@ async function defineConfig(options = {}, ...userConfigs) {
   }
   configs.push(
     ignores(options.ignores),
-    javascript({ isInEditor: isInEditor2, jsx: enableJsx, overrides: getOverrides(options, "javascript") }),
+    javascript({ isInEditor, jsx: enableJsx, overrides: getOverrides(options, "javascript") }),
     eslintComments(),
     node(),
     jsdoc({ stylistic: stylisticOptions }),
@@ -2199,7 +2208,7 @@ async function defineConfig(options = {}, ...userConfigs) {
   if (enablePerfectionist) {
     configs.push(
       perfectionist({
-        isInEditor: isInEditor2,
+        isInEditor,
         overrides: getOverrides(options, "perfectionist"),
         ...resolveSubOptions(options, "perfectionist")
       })
@@ -2240,7 +2249,7 @@ async function defineConfig(options = {}, ...userConfigs) {
   if (options.vitest) {
     configs.push(
       vitest({
-        isInEditor: isInEditor2,
+        isInEditor,
         overrides: getOverrides(options, "vitest"),
         tsconfigPath
       })
@@ -2309,7 +2318,7 @@ async function defineConfig(options = {}, ...userConfigs) {
   if (enablePrettier) {
     configs.push(
       prettier({
-        isInEditor: isInEditor2,
+        isInEditor,
         overrides: getOverrides(options, "prettier")
       })
     );
@@ -2379,8 +2388,6 @@ export {
   gitignore,
   ignores,
   imports,
-  isInEditor,
-  isInGitLifecycle,
   javascript,
   jsdoc,
   jsonc,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bfra.me/eslint-config",
-  "version": "0.44.1",
+  "version": "0.44.2",
   "description": "Shared ESLint configuration for bfra.me",
   "keywords": [
     "bfra.me",

package/src/define-config.ts

@@ -1,5 +1,6 @@
 import type {Config, ConfigNames, FlatConfigComposer, ResolvableFlatConfig} from './config'
 import type {Options} from './options'
+import {isPackageExists} from 'local-pkg'
 import {composeConfig} from './compose-config'
 import {
   astro,
@@ -31,8 +32,7 @@ import {
   vitest,
   yaml,
 } from './configs'
-import * as Env from './env'
-import {isPackageInScope} from './utils'
+import {isInEditorEnv} from './utils'
 
 // These are merged into the Options interface
 type AllowedConfigForOptions = Omit<Config, 'files'>
@@ -71,19 +71,23 @@ export async function defineConfig<C extends Config = Config, CN extends ConfigN
     packageJson: enablePackageJson = false,
     perfectionist: enablePerfectionist = true,
     pnpm: enableCatalogs = false,
-    prettier: enablePrettier = isPackageInScope('prettier'),
+    prettier: enablePrettier = isPackageExists('prettier'),
     react: enableReact = false,
     regexp: enableRegexp = true,
-    typescript: enableTypeScript = isPackageInScope('typescript'),
+    typescript: enableTypeScript = isPackageExists('typescript'),
     unicorn: enableUnicorn = true,
   } = options
 
-  const isInEditor = options.isInEditor ?? Env.isInEditor
-  if (isInEditor)
-    // eslint-disable-next-line no-console
-    console.log(
-      '[@bfra.me/eslint-config] Editor specific config is enabled. Some rules may be disabled.',
-    )
+  let isInEditor = options.isInEditor
+  if (isInEditor == null) {
+    isInEditor = isInEditorEnv()
+    if (isInEditor) {
+      // eslint-disable-next-line no-console
+      console.log(
+        '[@bfra.me/eslint-config] Editor specific config is enabled. Some rules may be disabled.',
+      )
+    }
+  }
 
   const stylisticOptions =
     options.stylistic === false || enablePrettier

package/src/index.ts

@@ -4,7 +4,6 @@ export * from './compose-config'
 export * from './config.d'
 export * from './configs'
 export * from './define-config'
-export * from './env'
 export * from './globs'
 export * from './options'
 export * from './rules.d'

package/src/utils.ts

@@ -1,5 +1,7 @@
 import type {Awaitable} from 'eslint-flat-config-utils'
+import process from 'node:process'
 import {fileURLToPath} from 'node:url'
+import isInCI from 'is-in-ci'
 import {isPackageExists} from 'local-pkg'
 
 const scopeUrl = fileURLToPath(new URL('.', import.meta.url))
@@ -17,3 +19,51 @@ export async function interopDefault<T>(
 export function isPackageInScope(name: string): boolean {
   return isPackageExists(name, {paths: [scopeUrl]})
 }
+
+/**
+ * Check if the process is running in a Git hook or under lint-staged.
+ *
+ * @example
+ * ```ts
+ * import {isInGitLifecycle} from '@bfra.me/eslint-config'
+ *
+ * if (isInGitLifecycle) {
+ *   console.log('Running in a Git hook or under lint-staged')
+ * }
+ * ```
+ */
+export function isInGitLifecycle(): boolean {
+  return !!(
+    false ||
+    (typeof process.env.GIT_PARAMS === 'string' && process.env.GIT_PARAMS.length > 0) ||
+    (typeof process.env.VSCODE_GIT_COMMAND === 'string' &&
+      process.env.VSCODE_GIT_COMMAND.length > 0) ||
+    process.env.npm_lifecycle_script?.startsWith('lint-staged') ||
+    process.env.npm_lifecycle_script?.startsWith('nano-staged')
+  )
+}
+
+/**
+ * Check if the process is running in an editor.
+ *
+ * @example
+ * ```ts
+ * import {isInEditor} from '@bfra.me/eslint-config'
+ *
+ * if (isInEditor) {
+ *   console.log('Running in an editor')
+ * }
+ */
+export function isInEditorEnv(): boolean {
+  if (isInCI) return false
+  if (isInGitLifecycle()) return false
+
+  return !!(
+    false ||
+    (typeof process.env.VSCODE_PID === 'string' && process.env.VSCODE_PID.length > 0) ||
+    (typeof process.env.VSCODE_CWD === 'string' && process.env.VSCODE_CWD.length > 0) ||
+    (typeof process.env.JETBRAINS_IDE === 'string' && process.env.JETBRAINS_IDE.length > 0) ||
+    (typeof process.env.VIM === 'string' && process.env.VIM.length > 0) ||
+    (typeof process.env.NVIM === 'string' && process.env.NVIM.length > 0)
+  )
+}

package/src/env.ts

@@ -1,43 +0,0 @@
-import {env} from 'node:process'
-import isInCI from 'is-in-ci'
-
-/**
- * Check if the process is running in a Git hook or under lint-staged.
- *
- * @example
- * ```ts
- * import {isInGitLifecycle} from '@bfra.me/eslint-config'
- *
- * if (isInGitLifecycle) {
- *   console.log('Running in a Git hook or under lint-staged')
- * }
- * ```
- */
-export const isInGitLifecycle = !!(
-  (typeof env.GIT_PARAMS === 'string' && env.GIT_PARAMS.length > 0) ||
-  (typeof env.VSCODE_GIT_COMMAND === 'string' && env.VSCODE_GIT_COMMAND.length > 0) ||
-  env.npm_lifecycle_script?.startsWith('lint-staged') ||
-  env.npm_lifecycle_script?.startsWith('nano-staged')
-)
-
-/**
- * Check if the process is running in an editor.
- *
- * @example
- * ```ts
- * import {isInEditor} from '@bfra.me/eslint-config'
- *
- * if (isInEditor) {
- *   console.log('Running in an editor')
- * }
- */
-export const isInEditor =
-  !isInCI &&
-  !isInGitLifecycle &&
-  Boolean(
-    (typeof env.VSCODE_PID === 'string' && env.VSCODE_PID.length > 0) ||
-      (typeof env.VSCODE_CWD === 'string' && env.VSCODE_CWD.length > 0) ||
-      (typeof env.JETBRAINS_IDE === 'string' && env.JETBRAINS_IDE.length > 0) ||
-      (typeof env.VIM === 'string' && env.VIM.length > 0) ||
-      (typeof env.NVIM === 'string' && env.NVIM.length > 0),
-  )