.eslintrc.json

{
	"root": true,
	"parser": "@typescript-eslint/parser",
	"parserOptions": {
		"ecmaVersion": 6,
		"sourceType": "module"
	},
	"plugins": [
		"@typescript-eslint",
		"jsdoc",
		"header"
	],
	"rules": {
		"constructor-super": "warn",
		"curly": "warn",
		"eqeqeq": "warn",
		"no-buffer-constructor": "warn",
		"no-caller": "warn",
		"no-case-declarations": "warn",
		"no-debugger": "warn",
		"no-duplicate-case": "warn",
		"no-duplicate-imports": "warn",
		"no-eval": "warn",
		"no-async-promise-executor": "warn",
		"no-extra-semi": "warn",
		"no-new-wrappers": "warn",
		"no-redeclare": "off",
		"no-sparse-arrays": "warn",
		"no-throw-literal": "warn",
		"no-unsafe-finally": "warn",
		"no-unused-labels": "warn",
		"no-restricted-globals": [
			"warn",
			"name",
			"length",
			"event",
			"closed",
			"external",
			"status",
			"origin",
			"orientation",
			"context"
		], // non-complete list of globals that are easy to access unintentionally
		"no-var": "warn",
		"jsdoc/no-types": "warn",
		"semi": "off",
		"@typescript-eslint/semi": "warn",
		"@typescript-eslint/naming-convention": [
			"warn",
			{
				"selector": "class",
				"format": [
					"PascalCase"
				]
			}
		],
		"code-no-unused-expressions": [
			"warn",
			{
				"allowTernary": true
			}
		],
		"code-translation-remind": "warn",
		"code-no-nls-in-standalone-editor": "warn",
		"code-no-standalone-editor": "warn",
		"code-no-unexternalized-strings": "warn",
		"code-layering": [
			"warn",
			{
				"common": [],
				"node": [
					"common"
				],
				"browser": [
					"common"
				],
				"electron-sandbox": [
					"common",
					"browser"
				],
				"electron-browser": [
					"common",
					"browser",
					"node",
					"electron-sandbox"
				],
				"electron-main": [
					"common",
					"node"
				]
			}
		],
		"code-import-patterns": [
			"warn",
			// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
			// !!! Do not relax these rules !!!
			// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
			//
			// A path ending in /~ has a special meaning. It indicates a template position
			// which will be substituted with one or more layers.
			//
			// When /~ is used in the target, the rule will be expanded to 14 distinct rules.
			// e.g. "src/vs/base/~" will be expanded to:
			//  - src/vs/base/common
			//  - src/vs/base/worker
			//  - src/vs/base/browser
			//  - src/vs/base/electron-sandbox
			//  - src/vs/base/node
			//  - src/vs/base/electron-browser
			//  - src/vs/base/electron-main
			//  - src/vs/base/test/common
			//  - src/vs/base/test/worker
			//  - src/vs/base/test/browser
			//  - src/vs/base/test/electron-sandbox
			//  - src/vs/base/test/node
			//  - src/vs/base/test/electron-browser
			//  - src/vs/base/test/electron-main
			//
			// When /~ is used in the restrictions, it will be replaced with the correct
			// layers that can be used e.g. "src/vs/base/electron-sandbox" will be able
			// to import "{common,browser,electron-sanbox}", etc.
			//
			// It is possible to use /~ in the restrictions property even without using it in
			// the target property by adding a layer property.
			{
				"target": "src/vs/base/~",
				"restrictions": [
					"vs/base/~"
				]
			},
			{
				"target": "src/vs/base/parts/*/~",
				"restrictions": [
					"vs/base/~",
					"vs/base/parts/*/~"
				]
			},
			{
				"target": "src/vs/platform/*/~",
				"restrictions": [
					"vs/base/~",
					"vs/base/parts/*/~",
					"vs/platform/*/~",
					"tas-client-umd" // node module allowed even in /common/
				]
			},
			{
				"target": "src/vs/editor/~",
				"restrictions": [
					"vs/base/~",
					"vs/base/parts/*/~",
					"vs/platform/*/~",
					"vs/editor/~"
				]
			},
			{
				"target": "src/vs/editor/standalone/~",
				"restrictions": [
					"vs/base/~",
					"vs/base/parts/*/~",
					"vs/platform/*/~",
					"vs/editor/~",
					"vs/editor/standalone/~",
					{ "when": "hasBrowser", "pattern": "vs/editor/contrib/*/!(test){,/**}" }
				]
			},
			{
				"target": "src/vs/editor/contrib/*/test/**",
				"layer": "browser",
				"test": true,
				"restrictions": [
					"vs/base/~",
					"vs/base/parts/*/~",
					"vs/platform/*/~",
					"vs/editor/~",
					"vs/editor/contrib/**"
				]
			},
			{
				"target": "src/vs/editor/contrib/*/!(test){,/**}",
				"layer": "browser",
				"restrictions": [
					"vs/base/~",
					"vs/base/parts/*/~",
					"vs/platform/*/~",
					"vs/editor/~",
					"vs/editor/contrib/*/!(test){,/**}"
				]
			},
			{
				"target": "src/vs/editor/editor.all.ts",
				"layer": "browser",
				"restrictions": [
					"vs/base/~",
					"vs/base/parts/*/~",
					"vs/platform/*/~",
					"vs/editor/~",
					"vs/editor/contrib/*/!(test){,/**}"
				]
			},
			{
				"target": "src/vs/editor/editor.worker.ts",
				"layer": "worker",
				"restrictions": [
					"vs/base/~",
					"vs/base/parts/*/~",
					"vs/platform/*/~",
					"vs/editor/~"
				]
			},
			{
				"target": "src/vs/editor/{editor.api.ts,editor.main.ts}",
				"layer": "browser",
				"restrictions": [
					"vs/base/~",
					"vs/base/parts/*/~",
					"vs/editor/~",
					"vs/editor/contrib/*/!(test){,/**}",
					"vs/editor/standalone/~",
					"vs/editor/*"
				]
			},
			{
				"target": "src/vs/workbench/~",
				"restrictions": [
					"vs/base/~",
					"vs/base/parts/*/~",
					"vs/platform/*/~",
					"vs/editor/~",
					"vs/workbench/~",
					"vs/workbench/services/*/~",
					"assert",
					{ "when": "hasBrowser", "pattern": "vs/editor/contrib/*/!(test){,/**}" },
					{ "when": "hasBrowser", "pattern": "vs/workbench/workbench.web.api" },
					{ "when": "test", "pattern": "vscode" }, // TODO@layers
					{ "when": "test", "pattern": "vs/workbench/api/~" }, // TODO@layers
					{ "when": "test", "pattern": "vs/workbench/contrib/*/~" }, // TODO@layers
					{ "when": "test", "pattern": "vs/workbench/workbench.desktop.main" } // TODO@layers
				]
			},
			{
				"target": "src/vs/workbench/api/~",
				"restrictions": [
					"vscode",
					"vs/base/~",
					"vs/base/parts/*/~",
					"vs/platform/*/~",
					"vs/editor/~",
					"vs/workbench/api/~",
					"vs/workbench/~",
					"vs/workbench/services/*/~",
					"vs/workbench/contrib/*/~",
					{ "when": "hasBrowser", "pattern": "vs/editor/contrib/*/!(test){,/**}" }
				]
			},
			{
				"target": "src/vs/workbench/services/*/~",
				"restrictions": [
					"vs/base/~",
					"vs/base/parts/*/~",
					"vs/platform/*/~",
					"vs/editor/~",
					"vs/workbench/~",
					"vs/workbench/api/~",
					"vs/workbench/services/*/~",
					{ "when": "hasBrowser", "pattern": "vs/editor/contrib/*/!(test){,/**}" },
					{ "when": "hasBrowser", "pattern": "vs/workbench/workbench.web.api" },
					{ "when": "test", "pattern": "vs/workbench/contrib/*/~" }, // TODO@layers
					"tas-client-umd", // node module allowed even in /common/
					"vscode-textmate", // node module allowed even in /common/
					"@vscode/vscode-languagedetection", // node module allowed even in /common/
					"@microsoft/applicationinsights-web" // node module allowed even in /common/
				]
			},
			{
				// TODO@layers `contrib/notebook` does its own special layering with an inner /contrib/ folder
				"target": "src/vs/workbench/contrib/notebook/browser/contrib/*/test/**",
				"layer": "browser",
				"test": true,
				"restrictions": [
					"vs/base/~",
					"vs/base/parts/*/~",
					"vs/platform/*/~",
					"vs/editor/~",
					"vs/editor/contrib/*/!(test){,/**}",
					"vs/workbench/~",
					"vs/workbench/api/~",
					"vs/workbench/services/*/~",
					"vs/workbench/{contrib,contrib/welcome}/*/~"
				]
			},
			{
				// TODO@layers `contrib/welcome` does its own special layering with sub-layers
				"target": "src/vs/workbench/{contrib,contrib/welcome}/*/~",
				"restrictions": [
					"vs/base/~",
					"vs/base/parts/*/~",
					"vs/platform/*/~",
					"vs/editor/~",
					"vs/workbench/~",
					"vs/workbench/api/~",
					"vs/workbench/services/*/~",
					"vs/workbench/{contrib,contrib/welcome}/*/~",
					{ "when": "hasBrowser", "pattern": "vs/editor/contrib/*/!(test){,/**}" },
					{ "when": "hasBrowser", "pattern": "xterm" }, // node module allowed even in /browser/
					{ "when": "hasBrowser", "pattern": "xterm-addon-*" }, // node module allowed even in /browser/
					{ "when": "hasBrowser", "pattern": "vscode-textmate" } // node module allowed even in /browser/
				]
			},
			{
				"target": "src/vs/code/~",
				"restrictions": [
					"vs/base/~",
					"vs/base/parts/*/~",
					"vs/platform/*/~",
					"vs/editor/~",
					"vs/code/~",
					{ "when": "hasBrowser", "pattern": "vs/editor/contrib/*/!(test){,/**}" },
					{ "when": "hasBrowser", "pattern": "vs/workbench/workbench.web.api" }
				]
			},
			{
				"target": "src/vs/server/**",
				"layer": "node",
				"restrictions": [
					"vs/base/~",
					"vs/base/parts/*/~",
					"vs/platform/*/~",
					"vs/workbench/~",
					"vs/workbench/api/~",
					"vs/workbench/services/*/~",
					"vs/workbench/{contrib,contrib/welcome}/*/~",
					"vs/server/**",
					"@vscode/*",
					"@parcel/*",
					"*" // node modules
				]
			},
			{
				"target": "src/vs/workbench/workbench.common.main.ts",
				"layer": "browser",
				"restrictions": [
					"vs/base/~",
					"vs/base/parts/*/~",
					"vs/platform/*/~",
					"vs/editor/~",
					"vs/editor/contrib/*/!(test){,/**}",
					"vs/editor/editor.all",
					"vs/workbench/~",
					"vs/workbench/api/~",
					"vs/workbench/services/*/~",
					"vs/workbench/{contrib,contrib/welcome}/*/~"
				]
			},
			{
				"target": "src/vs/workbench/workbench.web.main.ts",
				"layer": "browser",
				"restrictions": [
					"vs/base/~",
					"vs/base/parts/*/~",
					"vs/platform/*/~",
					"vs/editor/~",
					"vs/editor/contrib/*/!(test){,/**}",
					"vs/editor/editor.all",
					"vs/workbench/~",
					"vs/workbench/api/~",
					"vs/workbench/services/*/~",
					"vs/workbench/{contrib,contrib/welcome}/*/~",
					"vs/workbench/workbench.common.main"
				]
			},
			{
				"target": "src/vs/workbench/workbench.web.api.ts",
				"layer": "browser",
				"restrictions": [
					"vs/base/~",
					"vs/base/parts/*/~",
					"vs/platform/*/~",
					"vs/editor/~",
					"vs/editor/contrib/*/!(test){,/**}",
					"vs/editor/editor.all",
					"vs/workbench/~",
					"vs/workbench/api/~",
					"vs/workbench/services/*/~",
					"vs/workbench/{contrib,contrib/welcome}/*/~",
					"vs/workbench/workbench.web.main"
				]
			},
			{
				"target": "src/vs/workbench/{workbench.sandbox.main.ts,workbench.desktop.sandbox.main.ts}",
				"layer": "electron-sandbox",
				"restrictions": [
					"vs/base/*/~",
					"vs/base/parts/*/~",
					"vs/platform/*/~",
					"vs/editor/~",
					"vs/editor/contrib/*/!(test){,/**}",
					"vs/editor/editor.all",
					"vs/workbench/~",
					"vs/workbench/api/~",
					"vs/workbench/services/*/~",
					"vs/workbench/{contrib,contrib/welcome}/*/~",
					"vs/workbench/workbench.common.main",
					"vs/workbench/workbench.sandbox.main"
				]
			},
			{
				"target": "src/vs/workbench/workbench.desktop.main.ts",
				"layer": "electron-browser",
				"restrictions": [
					"vs/base/*/~",
					"vs/base/parts/*/~",
					"vs/platform/*/~",
					"vs/editor/~",
					"vs/editor/contrib/*/!(test){,/**}",
					"vs/editor/editor.all",
					"vs/workbench/~",
					"vs/workbench/api/~",
					"vs/workbench/services/*/~",
					"vs/workbench/{contrib,contrib/welcome}/*/~",
					"vs/workbench/workbench.common.main",
					"vs/workbench/workbench.sandbox.main"
				]
			},
			{
				"target": "src/vs/workbench/{workbench.desktop.main.nls.js,workbench.web.api.nls.js}",
				"restrictions": []
			},
			{
				"target": "src/vs/{css.d.ts,monaco.d.ts,nls.d.ts,nls.mock.ts}",
				"restrictions": []
			},
			{
				"target": "src/vscode-dts/**",
				"restrictions": []
			},
			{
				"target": "src/{bootstrap-amd.js,bootstrap-fork.js,bootstrap-node.js,bootstrap-window.js,bootstrap.js,cli.js,main.js}",
				"restrictions": []
			},
			{
				"target": "extensions/**",
				"restrictions": "**/*"
			},
			{
				"target": "test/smoke/**",
				"restrictions": [
					"test/automation",
					"test/smoke/**",
					"@vscode/*",
					"@parcel/*",
					"@playwright/*",
					"*" // node modules
				]
			},
			{
				"target": "test/automation/**",
				"restrictions": [
					"test/automation/**",
					"@vscode/*",
					"@parcel/*",
					"playwright-core/**",
					"@playwright/*",
					"*" // node modules
				]
			},
			{
				"target": "test/integration/**",
				"restrictions": [
					"test/integration/**",
					"@vscode/*",
					"@parcel/*",
					"@playwright/*",
					"*" // node modules
				]
			},
			{
				"target": "test/monaco/**",
				"restrictions": [
					"test/monaco/**",
					"@vscode/*",
					"@parcel/*",
					"@playwright/*",
					"*" // node modules
				]
			},
			{
				"target": "build/**",
				"restrictions": "**/*"
			},
			{
				"target": "**/{buildfile.js,buildfile.desktop.js,buildfile.web.js}",
				"restrictions": "**/*"
			}
		],
		"header/header": [
			2,
			"block",
			[
				"---------------------------------------------------------------------------------------------",
				" *  Copyright (c) Microsoft Corporation. All rights reserved.",
				" *  Licensed under the MIT License. See License.txt in the project root for license information.",
				" *--------------------------------------------------------------------------------------------"
			]
		]
	},
	"overrides": [
		{
			"files": [
				"*.js"
			],
			"rules": {
				"jsdoc/no-types": "off"
			}
		},
		{
			"files": [
				"**/*.test.ts"
			],
			"rules": {
				"code-no-test-only": "error"
			}
		},
		{
			"files": [
				"**/vscode.d.ts",
				"**/vscode.proposed.*.d.ts"
			],
			"rules": {
				"vscode-dts-create-func": "warn",
				"vscode-dts-literal-or-types": "warn",
				"vscode-dts-interface-naming": "warn",
				"vscode-dts-cancellation": "warn",
				"vscode-dts-use-thenable": "warn",
				"vscode-dts-region-comments": "warn",
				"vscode-dts-vscode-in-comments": "warn",
				"vscode-dts-provider-naming": [
					"warn",
					{
						"allowed": [
							"FileSystemProvider",
							"TreeDataProvider",
							"TestProvider",
							"CustomEditorProvider",
							"CustomReadonlyEditorProvider",
							"TerminalLinkProvider",
							"AuthenticationProvider",
							"NotebookContentProvider"
						]
					}
				],
				"vscode-dts-event-naming": [
					"warn",
					{
						"allowed": [
							"onCancellationRequested",
							"event"
						],
						"verbs": [
							"accept",
							"change",
							"close",
							"collapse",
							"create",
							"delete",
							"discover",
							"dispose",
							"edit",
							"end",
							"expand",
							"grant",
							"hide",
							"invalidate",
							"open",
							"override",
							"receive",
							"register",
							"remove",
							"rename",
							"save",
							"send",
							"start",
							"terminate",
							"trigger",
							"unregister",
							"write"
						]
					}
				]
			}
		}
	]
}