From 324764a4dfadb8be90fe9dd06bb3e8d9639b2cf5 Mon Sep 17 00:00:00 2001 From: Johannes Rieken Date: Tue, 31 Dec 2019 11:32:41 +0100 Subject: [PATCH] cleanup rule meta data, add links when possible --- build/lib/eslint/code-import-patterns.js | 7 ++++--- build/lib/eslint/code-import-patterns.ts | 9 +++++---- build/lib/eslint/code-layering.js | 5 +++-- build/lib/eslint/code-layering.ts | 7 ++++--- build/lib/eslint/code-no-nls-in-standalone-editor.js | 2 -- build/lib/eslint/code-no-nls-in-standalone-editor.ts | 4 +--- build/lib/eslint/code-no-standalone-editor.js | 7 ++++--- build/lib/eslint/code-no-standalone-editor.ts | 9 +++++---- build/lib/eslint/code-no-unexternalized-strings.js | 2 -- build/lib/eslint/code-no-unexternalized-strings.ts | 4 +--- build/lib/eslint/code-translation-remind.js | 2 -- build/lib/eslint/code-translation-remind.ts | 4 +--- 12 files changed, 28 insertions(+), 34 deletions(-) diff --git a/build/lib/eslint/code-import-patterns.js b/build/lib/eslint/code-import-patterns.js index 8292f7d46cf..0d508d1d00e 100644 --- a/build/lib/eslint/code-import-patterns.js +++ b/build/lib/eslint/code-import-patterns.js @@ -9,10 +9,11 @@ const utils_1 = require("./utils"); module.exports = new class { constructor() { this.meta = { - type: 'problem', - schema: {}, messages: { - badImport: 'Imports violates \'{{restrictions}}\' restrictions. See https://github.com/Microsoft/vscode/wiki/Code-Organization' + badImport: 'Imports violates \'{{restrictions}}\' restrictions. See https://github.com/microsoft/vscode/wiki/Source-Code-Organization' + }, + docs: { + url: 'https://github.com/microsoft/vscode/wiki/Source-Code-Organization' } }; } diff --git a/build/lib/eslint/code-import-patterns.ts b/build/lib/eslint/code-import-patterns.ts index ae29e471080..c3daadbf59a 100644 --- a/build/lib/eslint/code-import-patterns.ts +++ b/build/lib/eslint/code-import-patterns.ts @@ -16,11 +16,12 @@ interface ImportPatternsConfig { export = new class implements eslint.Rule.RuleModule { - readonly meta = { - type: 'problem', - schema: {}, + readonly meta: eslint.Rule.RuleMetaData = { messages: { - badImport: 'Imports violates \'{{restrictions}}\' restrictions. See https://github.com/Microsoft/vscode/wiki/Code-Organization' + badImport: 'Imports violates \'{{restrictions}}\' restrictions. See https://github.com/microsoft/vscode/wiki/Source-Code-Organization' + }, + docs: { + url: 'https://github.com/microsoft/vscode/wiki/Source-Code-Organization' } }; diff --git a/build/lib/eslint/code-layering.js b/build/lib/eslint/code-layering.js index 8c1ce8f80c4..db591f789c7 100644 --- a/build/lib/eslint/code-layering.js +++ b/build/lib/eslint/code-layering.js @@ -8,10 +8,11 @@ const utils_1 = require("./utils"); module.exports = new class { constructor() { this.meta = { - type: 'problem', - schema: {}, messages: { layerbreaker: 'Bad layering. You are not allowed to access {{from}} from here, allowed layers are: [{{allowed}}]' + }, + docs: { + url: 'https://github.com/microsoft/vscode/wiki/Source-Code-Organization' } }; } diff --git a/build/lib/eslint/code-layering.ts b/build/lib/eslint/code-layering.ts index 539d13f79f1..cca72eeec71 100644 --- a/build/lib/eslint/code-layering.ts +++ b/build/lib/eslint/code-layering.ts @@ -14,11 +14,12 @@ type Config = { export = new class implements eslint.Rule.RuleModule { - readonly meta = { - type: 'problem', - schema: {}, + readonly meta: eslint.Rule.RuleMetaData = { messages: { layerbreaker: 'Bad layering. You are not allowed to access {{from}} from here, allowed layers are: [{{allowed}}]' + }, + docs: { + url: 'https://github.com/microsoft/vscode/wiki/Source-Code-Organization' } }; diff --git a/build/lib/eslint/code-no-nls-in-standalone-editor.js b/build/lib/eslint/code-no-nls-in-standalone-editor.js index 735b87c3961..d8955507bed 100644 --- a/build/lib/eslint/code-no-nls-in-standalone-editor.js +++ b/build/lib/eslint/code-no-nls-in-standalone-editor.js @@ -8,8 +8,6 @@ const utils_1 = require("./utils"); module.exports = new class NoNlsInStandaloneEditorRule { constructor() { this.meta = { - type: 'problem', - schema: {}, messages: { noNls: 'Not allowed to import vs/nls in standalone editor modules. Use standaloneStrings.ts' } diff --git a/build/lib/eslint/code-no-nls-in-standalone-editor.ts b/build/lib/eslint/code-no-nls-in-standalone-editor.ts index 69063fe5842..90c80dee70c 100644 --- a/build/lib/eslint/code-no-nls-in-standalone-editor.ts +++ b/build/lib/eslint/code-no-nls-in-standalone-editor.ts @@ -9,9 +9,7 @@ import { createImportRuleListener } from './utils'; export = new class NoNlsInStandaloneEditorRule implements eslint.Rule.RuleModule { - readonly meta = { - type: 'problem', - schema: {}, + readonly meta: eslint.Rule.RuleMetaData = { messages: { noNls: 'Not allowed to import vs/nls in standalone editor modules. Use standaloneStrings.ts' } diff --git a/build/lib/eslint/code-no-standalone-editor.js b/build/lib/eslint/code-no-standalone-editor.js index 617b2483dd1..d9d6bb55b87 100644 --- a/build/lib/eslint/code-no-standalone-editor.js +++ b/build/lib/eslint/code-no-standalone-editor.js @@ -8,10 +8,11 @@ const utils_1 = require("./utils"); module.exports = new class NoNlsInStandaloneEditorRule { constructor() { this.meta = { - type: 'problem', - schema: {}, messages: { - badImport: 'Not allowed to import standalone editor modules. See https://github.com/Microsoft/vscode/wiki/Code-Organization' + badImport: 'Not allowed to import standalone editor modules.' + }, + docs: { + url: 'https://github.com/microsoft/vscode/wiki/Source-Code-Organization' } }; } diff --git a/build/lib/eslint/code-no-standalone-editor.ts b/build/lib/eslint/code-no-standalone-editor.ts index 52fbbea043f..898886d17d2 100644 --- a/build/lib/eslint/code-no-standalone-editor.ts +++ b/build/lib/eslint/code-no-standalone-editor.ts @@ -9,11 +9,12 @@ import { createImportRuleListener } from './utils'; export = new class NoNlsInStandaloneEditorRule implements eslint.Rule.RuleModule { - readonly meta = { - type: 'problem', - schema: {}, + readonly meta: eslint.Rule.RuleMetaData = { messages: { - badImport: 'Not allowed to import standalone editor modules. See https://github.com/Microsoft/vscode/wiki/Code-Organization' + badImport: 'Not allowed to import standalone editor modules.' + }, + docs: { + url: 'https://github.com/microsoft/vscode/wiki/Source-Code-Organization' } }; diff --git a/build/lib/eslint/code-no-unexternalized-strings.js b/build/lib/eslint/code-no-unexternalized-strings.js index c4cdbe597ba..1039890996c 100644 --- a/build/lib/eslint/code-no-unexternalized-strings.js +++ b/build/lib/eslint/code-no-unexternalized-strings.js @@ -14,8 +14,6 @@ function isDoubleQuoted(node) { module.exports = new (_a = class NoUnexternalizedStrings { constructor() { this.meta = { - type: 'problem', - schema: {}, messages: { doubleQuoted: 'Only use double-quoted strings for externalized strings.', badKey: 'The key \'{{key}}\' doesn\'t conform to a valid localize identifier.', diff --git a/build/lib/eslint/code-no-unexternalized-strings.ts b/build/lib/eslint/code-no-unexternalized-strings.ts index 3bc1156d397..b7a35d6471f 100644 --- a/build/lib/eslint/code-no-unexternalized-strings.ts +++ b/build/lib/eslint/code-no-unexternalized-strings.ts @@ -18,9 +18,7 @@ export = new class NoUnexternalizedStrings implements eslint.Rule.RuleModule { private static _rNlsKeys = /^[_a-zA-Z0-9][ .\-_a-zA-Z0-9]*$/; - readonly meta = { - type: 'problem', - schema: {}, + readonly meta: eslint.Rule.RuleMetaData = { messages: { doubleQuoted: 'Only use double-quoted strings for externalized strings.', badKey: 'The key \'{{key}}\' doesn\'t conform to a valid localize identifier.', diff --git a/build/lib/eslint/code-translation-remind.js b/build/lib/eslint/code-translation-remind.js index 34071d76ef0..a276e7c0028 100644 --- a/build/lib/eslint/code-translation-remind.js +++ b/build/lib/eslint/code-translation-remind.js @@ -9,8 +9,6 @@ const utils_1 = require("./utils"); module.exports = new (_a = class TranslationRemind { constructor() { this.meta = { - type: 'problem', - schema: {}, messages: { missing: 'Please add \'{{resource}}\' to ./build/lib/i18n.resources.json file to use translations here.' } diff --git a/build/lib/eslint/code-translation-remind.ts b/build/lib/eslint/code-translation-remind.ts index d482d3ff461..1ce01107a72 100644 --- a/build/lib/eslint/code-translation-remind.ts +++ b/build/lib/eslint/code-translation-remind.ts @@ -13,9 +13,7 @@ export = new class TranslationRemind implements eslint.Rule.RuleModule { private static NLS_MODULE = 'vs/nls'; - readonly meta = { - type: 'problem', - schema: {}, + readonly meta: eslint.Rule.RuleMetaData = { messages: { missing: 'Please add \'{{resource}}\' to ./build/lib/i18n.resources.json file to use translations here.' }