Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: correct language options for node js config #42

Merged
merged 1 commit into from
Jan 30, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions eslint.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@ import config from '@biscuittin/eslint-config'

export default config(
{
javascript: {
env: {
browser: false,
},
},
typescript: {
allowDefaultProject: [
'commitlint.config.mjs',
Expand Down
93 changes: 65 additions & 28 deletions packages/eslint-config/src/configs/node-js.ts
Original file line number Diff line number Diff line change
@@ -1,19 +1,39 @@
import type { Linter } from 'eslint'

import globals from 'globals'

import type { OptionsNodeJs } from '../options.js'
import type { TypedFlatConfigItem } from '../types.js'

import { GLOB_JS } from '../globs.js'
import { GLOB_JS, GLOB_TS } from '../globs.js'
import plugins from '../plugins.js'
import { getFlatConfigName, getPackageJson } from '../utils/index.js'

const name = getFlatConfigName('node-js')
const isModule = getPackageJson()?.type === 'module'

const globalsCommonJs: Linter.Globals = {
...globals.es2025,
...globals.node,
...globals.commonjs,
__dirname: 'readonly',
__filename: 'readonly',
}

const globalsModule: Linter.Globals = {
...globals.es2025,
...globals.node,
__dirname: 'off',
__filename: 'off',
exports: 'off',
module: 'off',
require: 'off',
}

export function nodeJs(options: OptionsNodeJs = {}): TypedFlatConfigItem[] {
const { module = isModule, extraFiles = [] } = options

const files: string[] = [GLOB_JS, ...extraFiles]
const files: string[] = [GLOB_JS, GLOB_TS, ...extraFiles]

return [
{
Expand All @@ -23,30 +43,12 @@ export function nodeJs(options: OptionsNodeJs = {}): TypedFlatConfigItem[] {
node: plugins['pluginNode'],
},
languageOptions: {
sourceType: module ? 'module' : 'commonjs',
ecmaVersion: 'latest',
parserOptions: {
ecmaFeatures: {
impliedStrict: true,
},
},
globals: {
...globals.es2025,
...globals.node,
...(module
? {
__dirname: 'off',
__filename: 'off',
exports: 'off',
module: 'off',
require: 'off',
}
: {
...globals.commonjs,
__dirname: 'readonly',
__filename: 'readonly',
}),
},
},
},
{
Expand All @@ -57,11 +59,7 @@ export function nodeJs(options: OptionsNodeJs = {}): TypedFlatConfigItem[] {
// pluginNode.configs.commons
// Ref: https://github.com/eslint-community/eslint-plugin-n/blob/ccf5f9e482c32f2fd2d5f78649d7f837a5db8870/lib/configs/_commons.js#L6
'node/no-deprecated-api': 'error',
'node/no-extraneous-import': 'error',
'node/no-extraneous-require': 'error',
'node/no-exports-assign': 'error',
'node/no-missing-import': 'error',
'node/no-missing-require': 'error',
'node/no-process-exit': 'error',
'node/no-unpublished-bin': 'error',
'node/no-unpublished-import': 'error',
Expand All @@ -72,6 +70,12 @@ export function nodeJs(options: OptionsNodeJs = {}): TypedFlatConfigItem[] {
'node/process-exit-as-throw': 'error',
'node/hashbang': 'error',

// Will handled by `eslint-plugin-import-x`
'node/no-extraneous-import': 'off',
'node/no-extraneous-require': 'off',
'node/no-missing-import': 'off',
'node/no-missing-require': 'off',

// Require error handling in callbacks
'node/handle-callback-err': ['error', '^error$'],
// Disallow `new` operators with calls to `require`
Expand All @@ -94,21 +98,54 @@ export function nodeJs(options: OptionsNodeJs = {}): TypedFlatConfigItem[] {
}),
},
},
{
name: name.script,
files: ['**/*.[jt]s'],
languageOptions: {
sourceType: module ? 'module' : 'commonjs',
parserOptions: {
ecmaFeatures: {
globalReturn: !module,
},
},
globals: {
...(module ? globalsModule : globalsCommonJs),
},
},
},
{
name: name.commonjs,
files: ['*.c[jt]s', '.*.c[jt]s'],
files: ['**/*.c[jt]s'],
languageOptions: {
sourceType: 'commonjs',
parserOptions: {
ecmaFeatures: {
globalReturn: true,
},
},
globals: {
...globals.commonjs,
__dirname: 'readonly',
__filename: 'readonly',
...globalsCommonJs,
},
},
rules: {
strict: ['error', 'global'],
'node/no-unsupported-features/es-syntax': ['error', { ignores: [] }],
},
},
{
name: name.module,
files: ['**/*.m[jt]s'],
languageOptions: {
sourceType: 'module',
parserOptions: {
ecmaFeatures: {
globalReturn: false,
},
},
globals: {
...globalsModule,
},
},
},
]
}