Skip to content

Use typed config.get #1519

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Sep 7, 2022
Merged

Use typed config.get #1519

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a732f0
Use typed config.get
MariaSolOs Aug 30, 2022
07c29f1
Merge branch 'main' into typed-config-get
dbaeumer Sep 7, 2022
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
34 changes: 17 additions & 17 deletions client/src/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import {

import { LegacyDirectoryItem, Migration, PatternItem, ValidateItem } from './settings';
import { ExitCalled, NoConfigRequest, NoESLintLibraryRequest, OpenESLintDocRequest, ProbeFailedRequest, ShowOutputChannel, Status, StatusNotification, StatusParams } from './shared/customMessages';
import { CodeActionsOnSaveMode, CodeActionsOnSaveRules, ConfigurationSettings, DirectoryItem, ESLintSeverity, ModeItem, RuleCustomization, Validate } from './shared/settings';
import { CodeActionSettings, CodeActionsOnSaveMode, CodeActionsOnSaveRules, ConfigurationSettings, DirectoryItem, ESLintOptions, ESLintSeverity, ModeItem, PackageManagers, RuleCustomization, RunValues, Validate } from './shared/settings';
import { convert2RegExp, Is, Semaphore, toOSPath, toPosixPath } from './node-utils';
import { pickFolder } from './vscode-utils';

Expand All @@ -37,7 +37,7 @@ export class Validator {

public check(textDocument: TextDocument): Validate {
const config = Workspace.getConfiguration('eslint', textDocument.uri);
if (!config.get('enable', true)) {
if (!config.get<boolean>('enable', true)) {
return Validate.off;
}
const languageId = textDocument.languageId;
Expand Down Expand Up @@ -355,7 +355,7 @@ export namespace ESLintClient {
const debug = sanitize(eslintConfig.get<boolean>('debug', false) ?? false, 'boolean', false);
const runtime = sanitize(eslintConfig.get<string | null>('runtime', null) ?? undefined, 'string', undefined);
const execArgv = sanitize(eslintConfig.get<string[] | null>('execArgv', null) ?? undefined, 'string', undefined);
const nodeEnv = sanitize(eslintConfig.get('nodeEnv', null) ?? undefined, 'string', undefined);
const nodeEnv = sanitize(eslintConfig.get<string | null>('nodeEnv', null) ?? undefined, 'string', undefined);

let env: { [key: string]: string | number | boolean } | undefined;
if (debug) {
Expand Down Expand Up @@ -602,37 +602,37 @@ export namespace ESLintClient {
});
const settings: ConfigurationSettings = {
validate: Validate.off,
packageManager: config.get('packageManager', 'npm'),
useESLintClass: config.get('useESLintClass', false),
packageManager: config.get<PackageManagers>('packageManager', 'npm'),
useESLintClass: config.get<boolean>('useESLintClass', false),
codeActionOnSave: {
mode: CodeActionsOnSaveMode.all
},
format: false,
quiet: config.get('quiet', false),
quiet: config.get<boolean>('quiet', false),
onIgnoredFiles: ESLintSeverity.from(config.get<string>('onIgnoredFiles', ESLintSeverity.off)),
options: config.get('options', {}),
options: config.get<ESLintOptions>('options', {}),
rulesCustomizations: getRuleCustomizations(config, resource),
run: config.get('run', 'onType'),
run: config.get<RunValues>('run', 'onType'),
nodePath: config.get<string | undefined>('nodePath', undefined) ?? null,
workingDirectory: undefined,
workspaceFolder: undefined,
codeAction: {
disableRuleComment: config.get('codeAction.disableRuleComment', { enable: true, location: 'separateLine' as const, commentStyle: 'line' as const }),
showDocumentation: config.get('codeAction.showDocumentation', { enable: true })
disableRuleComment: config.get<CodeActionSettings['disableRuleComment']>('codeAction.disableRuleComment', { enable: true, location: 'separateLine' as const }),
showDocumentation: config.get<CodeActionSettings['showDocumentation']>('codeAction.showDocumentation', { enable: true })
}
};
const document: TextDocument | undefined = syncedDocuments.get(item.scopeUri);
if (document === undefined) {
result.push(settings);
continue;
}
if (config.get('enabled', true)) {
if (config.get<boolean>('enabled', true)) {
settings.validate = validator.check(document);
}
if (settings.validate !== Validate.off) {
settings.format = !!config.get('format.enable', false);
settings.codeActionOnSave.mode = CodeActionsOnSaveMode.from(config.get('codeActionsOnSave.mode', CodeActionsOnSaveMode.all));
settings.codeActionOnSave.rules = CodeActionsOnSaveRules.from(config.get('codeActionsOnSave.rules', null));
settings.format = !!config.get<boolean>('format.enable', false);
settings.codeActionOnSave.mode = CodeActionsOnSaveMode.from(config.get<CodeActionsOnSaveMode>('codeActionsOnSave.mode', CodeActionsOnSaveMode.all));
settings.codeActionOnSave.rules = CodeActionsOnSaveRules.from(config.get<string[] | null>('codeActionsOnSave.rules', null));
}
if (workspaceFolder !== undefined) {
settings.workspaceFolder = {
Expand Down Expand Up @@ -736,12 +736,12 @@ export namespace ESLintClient {
}

function getRuleCustomizations(config: WorkspaceConfiguration, uri: Uri): RuleCustomization[] {
let customizations: any = undefined;
let customizations: RuleCustomization[] | undefined = undefined;
if (uri.scheme === 'vscode-notebook-cell') {
customizations = config.get('notebooks.rules.customizations', undefined);
customizations = config.get<RuleCustomization[] | undefined>('notebooks.rules.customizations', undefined);
}
if (customizations === undefined || customizations === null) {
customizations = config.get('rules.customizations');
customizations = config.get<RuleCustomization[] | undefined>('rules.customizations');
}
return parseRulesCustomizations(customizations);
}
Expand Down
2 changes: 1 addition & 1 deletion client/src/tasks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ class FolderTaskProvider {

const options: vscode.ShellExecutionOptions = { cwd: this.workspaceFolder.uri.fsPath };
const config = vscode.workspace.getConfiguration('eslint', this._workspaceFolder.uri);
const lintTaskOptions= config.get('lintTask.options', '.');
const lintTaskOptions= config.get<string>('lintTask.options', '.');
return new vscode.Task(
kind, this.workspaceFolder,
'lint whole folder', 'eslint', new vscode.ShellExecution(`${command} ${lintTaskOptions}`, options),
Expand Down