eslint.config.js

import js from '@eslint/js';
import globals from 'globals';
import mdcs from 'eslint-config-mdcs';
import compat from 'eslint-plugin-compat';
import html from 'eslint-plugin-html';
import jsdoc from 'eslint-plugin-jsdoc';

export default [
	// files to ignore
	{
		name: 'files to ignore',
		ignores: [
			'**/node_modules/**',
			'**/build/**',
			'examples/jsm/libs/**',
			'test/treeshake/*.bundle.js',
			'test/treeshake/*.bundle.min.js',
			'editor/js/libs/acorn/**',
			'editor/js/libs/codemirror/**',
			'editor/js/libs/tern-threejs/**',
			'editor/js/libs/ternjs/**',
			'editor/js/libs/esprima.js',
			'editor/js/libs/jsonlint.js',
			'editor/js/libs/signals.min.js',
			'**/ifc/**',
			'**/prettify.js',
			'**/prettify/**',
			'**/3rdparty/**',
			'**/shapefile.js',
			'**/vendor/**',
			'**/fuse/**',
			'**/template/static/**',
		]
	},

	// recommended
	js.configs.recommended,
	// jsdoc.configs['flat/recommended'],

	// base rules
	{
		name: 'base rules',
		files: [ '**/*.js', '**/*.html' ],
		plugins: {
			html,
			compat,
			jsdoc
		},
		languageOptions: {
			ecmaVersion: 2022,
			sourceType: 'module',
			globals: {
				...globals.browser,
				...globals.node,
				...globals.es2017,
				__THREE_DEVTOOLS__: 'readonly',
				potpack: 'readonly',
				fflate: 'readonly',
				Stats: 'readonly',
				XRWebGLBinding: 'readonly',
				XRWebGLLayer: 'readonly',
				GPUShaderStage: 'readonly',
				GPUBufferUsage: 'readonly',
				GPUTextureUsage: 'readonly',
				GPUTexture: 'readonly',
				GPUMapMode: 'readonly',
				QUnit: 'readonly',
				Ammo: 'readonly',
				XRRigidTransform: 'readonly',
				XRMediaBinding: 'readonly',
				CodeMirror: 'readonly',
				esprima: 'readonly',
				jsonlint: 'readonly',
				VideoFrame: 'readonly',
				VideoDecoder: 'readonly',
				Float16Array: 'readonly',
				BigInt: 'readonly',
				BigUint64Array: 'readonly'
			},
		},
		settings: {
			polyfills: [
				'WebGL2RenderingContext'
			],
			jsdoc: {
				preferredTypes: {
					Any: 'any',
					Boolean: 'boolean',
					Number: 'number',
					object: 'Object',
					String: 'string'
				},
				tagNamePreference: {
					returns: 'return',
					extends: 'augments'
				},
			},
		},
		rules: {
			...mdcs.rules,
			...compat.configs.recommended.rules,
			'no-throw-literal': 'error',
			'quotes': [ 'error', 'single' ],
			'prefer-const': [ 'error', {
				destructuring: 'any',
				ignoreReadBeforeAssign: false
			} ],
			'no-irregular-whitespace': 'error',
			'no-duplicate-imports': 'error',
			'prefer-spread': 'error',
			// 'eqeqeq': 'error',

			'no-useless-escape': 'off',
			'no-case-declarations': 'off',
			'no-cond-assign': 'off',
			'getter-return': 'off',
			'no-async-promise-executor': 'off',
			'no-empty': 'off',
			'no-fallthrough': 'off',
			'no-prototype-builtins': 'off',
			'no-loss-of-precision': 'off',
			'no-unused-vars': [ 'error', {
				caughtErrors: 'none',
			} ],
			'jsdoc/check-types': 'error',
			'jsdoc/require-returns': 'off',
			'jsdoc/require-returns-type': 'error',
			'jsdoc/require-param-description': 'off',
			'jsdoc/require-returns-description': 'off',
			'jsdoc/require-param-type': 'error'
		}
	},

	// editor rules
	{
		name: 'editor rules',
		files: [ 'editor/**/*.js' ],
		languageOptions: {
			ecmaVersion: 2022,
			sourceType: 'module'
		}
	},

	// tests must import from src, not build
	{
		name: 'unit test rules',
		files: [ 'test/unit/**/*.js' ],
		rules: {
			'no-restricted-imports': [ 'error', {
				patterns: [ {
					group: [ '**/build/*' ],
					message: 'Tests must import from /src, not /build as build is not guaranteed to be fresh.'
				} ]
			} ]
		}
	}
];