v6.1.6 - disable no-unpublished-import, fix tsconfig, fix package.json config

Author: balupton

HISTORY.md

@@ -1,19 +1,27 @@
 # History
 
-## v6.1.5 2025 August 8
+## v6.1.6 2025 August 13
+
+- Disable `n/no-unpublished-import` completely, as it is broken in general, not just in TypeScript environments
+- Fix loading of your `tsconfig` files
+- Fix loading of your `package.json` eslint configuration
+- Updated dependencies, [base files](https://github.com/bevry/base), and [editions](https://editions.bevry.me) using [boundation](https://github.com/bevry/boundation)
+- Thank you to the sponsors: [Andrew Nesbitt](https://nesbitt.io), [Divinci ™](https://divinci.ai), [Mr. Henry](https://mrhenry.be), [Poonacha Medappa](https://poonachamedappa.com), [Roboflow](https://roboflow.com), [Square](https://github.com/square)
+
+## v6.1.5 2025 August 12
 
 - Renamed the rule extensions for brevity and clarity
 - Add `eslint-config-bevry/typescript/es5` configuration for TypeScript ES5 targets, which ignores the `@typescript-eslint/prefer-for-of` rule, as it is not supported in ES5
 - Updated dependencies, [base files](https://github.com/bevry/base), and [editions](https://editions.bevry.me) using [boundation](https://github.com/bevry/boundation)
 - Thank you to the sponsors: [Andrew Nesbitt](https://nesbitt.io), [Divinci ™](https://divinci.ai), [Mr. Henry](https://mrhenry.be), [Poonacha Medappa](https://poonachamedappa.com), [Roboflow](https://roboflow.com), [Square](https://github.com/square)
 
-## v6.1.4 2025 August 8
+## v6.1.4 2025 August 12
 
 - Disable potentially useful but broken `n/no-unsupported-features/es-syntax` rule, as it does not respect the `ecmaVersion` setting, and instead prefers to use the Node.js engine version, which is not what we want when using a transpiler, and is disrespectful as our configuration knows better, hence why there is even an `ecmaVersion` setting in the first place, they should rename this rule to `n/no-unsupported-features/node-syntax` as that it what it actually is
     - In a future version, we could use [editions](https://editions.bevry.me) to get the highest compatible Node.js version, and configure it for that, as a workaround for this silly behaviour
 - Thank you to the sponsors: [Andrew Nesbitt](https://nesbitt.io), [Divinci ™](https://divinci.ai), [Mr. Henry](https://mrhenry.be), [Poonacha Medappa](https://poonachamedappa.com), [Roboflow](https://roboflow.com), [Square](https://github.com/square)
 
-## v6.1.3 2025 August 8
+## v6.1.3 2025 August 12
 
 - ECMAScript version handling is now more robust, handling both target and source ecmascript versions
 - Our rule customisations are now extensions themselves injected at the appropriate time to better avoid conflicts and redundancies with other plugin rules

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-bevry",
-  "version": "6.1.5",
+  "version": "6.1.6",
   "license": "Artistic-2.0",
   "description": "Intelligent, self-configuring ESLint configuration that automatically analyzes your project structure, dependencies, and metadata to apply optimal linting rules for JavaScript, TypeScript, React, Node.js, and more.",
   "homepage": "https://github.com/bevry/eslint-config-bevry",

package.json

@@ -14,51 +14,70 @@ import eslintJSDoc from 'eslint-plugin-jsdoc'
 import babelParser from '@babel/eslint-parser'
 import babelPlugin from '@babel/eslint-plugin'
 
-// @ts-ignore
+// Our dependencies
 import versionClean from 'version-clean'
+
+// Node.js dependencies
 import { join } from 'node:path'
 import { cwd } from 'node:process'
-import { readJSON } from '@bevry/json'
 
+// Local imports
+import * as rules from './rules.js'
+
+// Local paths
+import { readJSON } from '@bevry/json'
 import filedirname from 'filedirname'
 const [, dirname] = filedirname()
-const root = dirname.endsWith('source') ? join(dirname, '..') : dirname // on CI dirname is: /home/runner/work/eslint-config-bevry/eslint-config-bevry/source
-const pwd = cwd()
-
-import * as rules from './rules.js'
-const { IGNORE } = rules
+const bevryRootPath = join(dirname, '..')
+const userRootPath = cwd()
+const bevryPackagePath = join(bevryRootPath, 'package.json')
+const userPackagePath = join(userRootPath, 'package.json')
 
 // ------------------------------------
 // Prepare
 
+/**
+ * Error thrown when a dependency that should be inlined is found in the user's package.json
+ */
 class InlinedError extends Error {
+	/**
+	 * Creates an InlinedError instance
+	 * @param {string} dependency - The name of the dependency that is now inlined
+	 */
 	constructor(dependency) {
 		super(
 			`the development dependency ${dependency} is now inlined within eslint-config-bevry\nrun: npm uninstall --save-dev ${dependency}`,
 		)
 	}
 }
 
-const bevryPackage = await readJSON(join(root, 'package.json'))
-const pkg = {}
-try {
-	Object.assign(pkg, await readJSON(join(pwd, 'package.json')))
-} catch (err) {} // eslint-disable-line
+/**
+ * Reads a JSON file, returning an empty object if reading failed.
+ * @param {string} path - The path to the JSON file to read
+ * @param {object} [fallback] - The fallback value to return if reading fails
+ * @returns {Promise<object>} The parsed JSON object or the fallback value
+ */
+function readJSONFallback(path, fallback = {}) {
+	return readJSON(path).catch(() => fallback)
+}
+
+const bevryPackage = await readJSON(bevryPackagePath)
+const userPackage = await readJSONFallback(userPackagePath)
 
 // https://eslint.org/docs/latest/use/configure/configuration-files#configuration-objects
 /** @type {import('eslint').Linter.Config} */
 const config = {
 	name: bevryPackage.name,
 	// version: bevryPackage.version,
-	files: pkg.eslintConfig?.files || [],
+	files: userPackage.eslintConfig?.files || [],
 	// don't use ignores, as it doesn't help us with matched patterns from extended configurations, instead use globalIgnores
 	extends: [
 		globalIgnores([
 			// '**/*.d.ts', <-- now that we fixed the rules that conflict with typescript with v6.1.1, ignoring these isn't necessary anymore
 			'**/vendor/',
 			'**/node_modules/',
 			'**/edition-*/',
-			...(pkg.eslintConfig?.ignores || []),
+			...(userPackage.eslintConfig?.ignores || []),
 		]),
 		rules.jsBefore,
 		eslintJS.configs.recommended,
@@ -107,7 +126,7 @@ function hasDep(name) {
  * @throws {InlinedError} if any of the specified dependencies are present
  */
 function inlinedDeps(...names) {
-	if (pkg.name === 'eslint-config-bevry') return
+	if (userPackage.name === 'eslint-config-bevry') return
 	for (const name of names) {
 		if (hasDep(name)) {
 			throw new InlinedError(name)
@@ -116,15 +135,19 @@ function inlinedDeps(...names) {
 }
 
 // Load the dependencies and versions
-Object.assign(deps, pkg.dependencies || {}, pkg.devDependencies || {})
+Object.assign(
+	deps,
+	userPackage.dependencies || {},
+	userPackage.devDependencies || {},
+)
 Object.keys(deps).forEach((name) => {
 	const range = deps[name]
 	const version = versionClean(range) || null // resolve to null in case of github references
 	versions[name] = version
 })
 
 // extract some common items
-const keywords = pkg.keywords || []
+const keywords = userPackage.keywords || []
 
 // ------------------------------------
 // Deprecations
@@ -188,9 +211,9 @@ let sourceType = 'script',
 	typescript = hasDep('typescript'),
 	babel = hasDep('@babel/core'),
 	jsx = false
-const prettier = Boolean(pkg.prettier) || hasDep('prettier'),
-	browser = Boolean(pkg.browser) || keywords.includes('browser'),
-	node = Boolean(pkg.engines?.node) || keywords.includes('node'),
+const prettier = Boolean(userPackage.prettier) || hasDep('prettier'),
+	browser = Boolean(userPackage.browser) || keywords.includes('browser'),
+	node = Boolean(userPackage.engines?.node) || keywords.includes('node'),
 	worker =
 		keywords.includes('worker') ||
 		keywords.includes('workers') ||
@@ -201,7 +224,8 @@ const prettier = Boolean(pkg.prettier) || hasDep('prettier'),
 
 /**
  * Ensure the ecmascript version is coerced to an eslint valid ecmascript version
- * @param version
+ * @param {string} [version] - The version string to coerce (e.g., 'esnext', 'latest', '2020')
+ * @returns {string|number} The coerced version as a string or number, or empty string if invalid
  */
 function coerceEcmascriptVersion(version = '') {
 	if (version === 'esnext' || version === 'latest' || version === 'next') {
@@ -221,14 +245,14 @@ function coerceEcmascriptVersion(version = '') {
 }
 
 // editions
-if (pkg.editions) {
-	const sourceEdition = pkg.editions[0]
+if (userPackage.editions) {
+	const sourceEdition = userPackage.editions[0]
 	const sourceEditionTags = sourceEdition.tags || sourceEdition.syntaxes || []
 	const ecmascriptVersionTag = coerceEcmascriptVersion(
 		sourceEditionTags.find((tag) => tag.startsWith('es')),
 	)
 	const ecmascriptVersionEngine = coerceEcmascriptVersion(
-		pkg.engines?.ecmascript,
+		userPackage.engines?.ecmascript,
 	)
 	ecmascriptVersionSource =
 		ecmascriptVersionTag || ecmascriptVersionEngine || ecmascriptNextVersion
@@ -323,12 +347,6 @@ if (node) {
 	// https://github.com/eslint-community/eslint-plugin-n#-configs
 	if (sourceType === 'module') {
 		config.extends.push(eslintNode.configs['flat/recommended-module'])
-		if (typescript) {
-			Object.assign(config.rules, {
-				// This result is broken for TypeScript projects, as in TypeScript you do `import thing from file.js` instead of `file.ts`, as it is about the resultant file, not the source file; TypeScript handles this correctly, however this rule does not
-				'n/no-unpublished-import': IGNORE,
-			})
-		}
 	} else {
 		config.extends.push(eslintNode.configs['flat/recommended-script'])
 	}
@@ -370,7 +388,7 @@ if (babel) {
 if (typescript) {
 	Object.assign(config.languageOptions.parserOptions, {
 		projectService: true,
-		tsconfigRootDir: root,
+		tsconfigRootDir: userRootPath,
 	})
 	config.extends.push(
 		// https://typescript-eslint.io/users/configs
@@ -422,10 +440,10 @@ if (ecmascriptVersionSource <= 5) {
 }
 
 // user rules overrides
-if (pkg.eslintConfig?.rules) {
-	Object.extends.push({
+if (userPackage.eslintConfig?.rules) {
+	config.extends.push({
 		name: 'eslint-config-bevry/package-json',
-		rules: pkg.eslintConfig.rules,
+		rules: userPackage.eslintConfig.rules,
 	})
 }
 

source/index.js

@@ -1,12 +1,17 @@
+/** ESLint rule severity level for ignoring/disabling a rule */
 export const IGNORE = 0
+/** ESLint rule severity level for warnings */
 export const WARN = 1
+/** ESLint rule severity level for errors */
 export const ERROR = 2
+/** Maximum number of parameters allowed in functions */
 export const MAX_PARAMS = 4
 
 // ============================================================================
 // Rules intended to be overwrote by ESLint Recommended
 // https://unpkg.com/@eslint/js@9/src/configs/eslint-recommended.js
 
+/** ESLint configuration for JavaScript rules that will be overridden by ESLint recommended */
 export const jsBefore = {
 	name: 'eslint-config-bevry/js/before',
 	rules: {
@@ -200,6 +205,7 @@ export const jsBefore = {
 // Rules intended to overwrite ESLint Recommended
 // https://unpkg.com/@eslint/js@9/src/configs/eslint-recommended.js
 
+/** ESLint configuration for JavaScript rules that override ESLint recommended */
 export const jsAfter = {
 	name: 'eslint-config-bevry/js/after',
 	rules: {
@@ -1070,7 +1076,7 @@ export const jsAfter = {
 // ============================================================================
 // Adjustments
 
-// These are adjustments based on the source ecmascript version, as the transpiler handles them
+/** ESLint configuration adjustments for ES5 compatibility - transpiler handles these features */
 export const es5 = {
 	name: 'eslint-config-bevry/es5',
 	rules: {
@@ -1082,6 +1088,7 @@ export const es5 = {
 	},
 }
 
+/** ESLint configuration for import plugin rules */
 export const importAfter = {
 	name: 'eslint-config-bevry/import/after',
 	rules: {
@@ -1095,6 +1102,7 @@ export const importAfter = {
 // https://github.com/eslint-community/eslint-plugin-n?tab=readme-ov-file#-rules
 // https://github.com/eslint-community/eslint-plugin-n/blob/master/lib/all-rules.js
 // None of these should be set by the recommended configs
+/** ESLint configuration for Node.js plugin rules */
 export const nodeAfter = {
 	name: 'eslint-config-bevry/node/after',
 	rules: {
@@ -1142,9 +1150,15 @@ export const nodeAfter = {
 		// https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/no-sync.md
 		// Sometimes sync methods are useful, so warn but don't error
 		'n/no-sync': WARN,
+
+		// https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/no-unpublished-import.md
+		// This result is broken for TypeScript projects, as in TypeScript you do `import thing from file.js` instead of `file.ts`, as it is about the resultant file, not the source file; TypeScript handles this correctly, however this rule does not
+		// However, it is also broken for this very project too, which is a JavaScript only project, so it is just broken in general...
+		'n/no-unpublished-import': IGNORE,
 	},
 }
 
+/** ESLint configuration for Node.js projects that use compilation/transpilation */
 export const nodeCompiled = {
 	name: 'eslint-config-bevry/node/compiled',
 	rules: {
@@ -1154,6 +1168,7 @@ export const nodeCompiled = {
 	},
 }
 
+/** ESLint configuration for TypeScript projects - rules that override default configs */
 export const typescriptAfter = {
 	name: 'eslint-config-bevry/typescript/after',
 	rules: {
@@ -1185,21 +1200,22 @@ export const typescriptAfter = {
 	},
 }
 
-// These are adjustments based on the target ecmascript version, as the transpiler does not handle them
+/** ESLint configuration for TypeScript projects targeting ES5 - transpiler limitations */
 export const typescriptEs5 = {
 	name: 'eslint-config-bevry/typescript/es5',
 	rules: {
 		'@typescript-eslint/prefer-for-of': IGNORE, // came in ES2015
 	},
 }
+/** ESLint configuration for TypeScript projects targeting ES2015 - transpiler limitations */
 export const typescriptEs2015 = {
 	name: 'eslint-config-bevry/typescript/es2015',
 	rules: {
 		'@typescript-eslint/prefer-includes': IGNORE, // came in ES2016
 	},
 }
 
-// allow unsafe types in our test files, as how else are we meant to test that unsafe inputs will be handled correctly?
+/** ESLint configuration for TypeScript test files - allows unsafe types for testing */
 export const typescriptTests = {
 	name: 'eslint-config-bevry/typescript/tests',
 	files: ['**/test.{js,cjs,mjs,jsx,mjsx,ts,cts,mts,tsx,mtsx}'],