mirror of
https://github.com/microsoft/vscode.git
synced 2026-04-25 02:58:56 +01:00
migrate no-unexternalized-strings rule (have two variants)
This commit is contained in:
Johannes Rieken
255
build/lib/eslint/code-no-unexternalized-strings.ts
Normal file
255
build/lib/eslint/code-no-unexternalized-strings.ts
Normal file
@@ -0,0 +1,255 @@
|
||||
/*---------------------------------------------------------------------------------------------
|
||||
* Copyright (c) Microsoft Corporation. All rights reserved.
|
||||
* Licensed under the MIT License. See License.txt in the project root for license information.
|
||||
*--------------------------------------------------------------------------------------------*/
|
||||
|
||||
import * as eslint from 'eslint';
|
||||
import { TSESTree, AST_NODE_TYPES } from '@typescript-eslint/experimental-utils';
|
||||
|
||||
interface Map<V> {
|
||||
[key: string]: V;
|
||||
}
|
||||
|
||||
interface UnexternalizedStringsOptions {
|
||||
signatures?: string[];
|
||||
messageIndex?: number;
|
||||
keyIndex?: number;
|
||||
ignores?: string[];
|
||||
}
|
||||
|
||||
function isStringLiteral(node: TSESTree.Node | null | undefined): node is TSESTree.StringLiteral {
|
||||
return !!node && node.type === AST_NODE_TYPES.Literal && typeof node.value === 'string';
|
||||
}
|
||||
|
||||
function isObjectLiteral(node: TSESTree.Node | null | undefined): node is TSESTree.ObjectExpression {
|
||||
return !!node && node.type === AST_NODE_TYPES.ObjectExpression;
|
||||
}
|
||||
|
||||
function isPropertyAssignment(node: TSESTree.Node | null | undefined): node is TSESTree.Property {
|
||||
return !!node && node.type === AST_NODE_TYPES.Property;
|
||||
}
|
||||
|
||||
interface KeyMessagePair {
|
||||
key: TSESTree.StringLiteral;
|
||||
message: TSESTree.Node | undefined;
|
||||
}
|
||||
|
||||
export = new class NoUnexternalizedStringsRuleWalker implements eslint.Rule.RuleModule {
|
||||
|
||||
private static DOUBLE_QUOTE: string = '"';
|
||||
private static IDENTIFIER = /^[_a-zA-Z0-9][ .\-_a-zA-Z0-9]*$/;
|
||||
|
||||
private signatures: Map<boolean> = Object.create(null);
|
||||
private messageIndex: number | undefined;
|
||||
private keyIndex: number | undefined;
|
||||
private ignores: Map<boolean> = Object.create(null);
|
||||
|
||||
private usedKeys: Map<KeyMessagePair[]> = Object.create(null);
|
||||
|
||||
readonly meta = {
|
||||
type: 'problem',
|
||||
schema: {},
|
||||
messages: {
|
||||
badQuotes: 'Do not use double quotes for imports.',
|
||||
unexternalized: 'Unexternalized string.',
|
||||
duplicateKey: `Duplicate key '{{key}}' with different message value.`,
|
||||
badKey: `The key {{key}} doesn't conform to a valid localize identifier`,
|
||||
emptyKey: 'Key is empty.',
|
||||
whitespaceKey: 'Key is only whitespace.',
|
||||
badMessage: `Message argument to '{{message}}' must be a string literal.`
|
||||
}
|
||||
};
|
||||
|
||||
create(context: eslint.Rule.RuleContext): eslint.Rule.RuleListener {
|
||||
|
||||
const first = <UnexternalizedStringsOptions>context.options[0];
|
||||
if (first) {
|
||||
if (Array.isArray(first.signatures)) {
|
||||
first.signatures.forEach((signature: string) => this.signatures[signature] = true);
|
||||
}
|
||||
if (Array.isArray(first.ignores)) {
|
||||
first.ignores.forEach((ignore: string) => this.ignores[ignore] = true);
|
||||
}
|
||||
if (typeof first.messageIndex !== 'undefined') {
|
||||
this.messageIndex = first.messageIndex;
|
||||
}
|
||||
if (typeof first.keyIndex !== 'undefined') {
|
||||
this.keyIndex = first.keyIndex;
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
['Program:exit']: () => {
|
||||
this._checkProgramEnd(context);
|
||||
},
|
||||
['Literal']: (node: any) => {
|
||||
if (typeof (<TSESTree.Literal>node).value === 'string') {
|
||||
this._checkStringLiteral(context, node);
|
||||
}
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
protected _checkProgramEnd(context: eslint.Rule.RuleContext): void {
|
||||
Object.keys(this.usedKeys).forEach(key => {
|
||||
// Keys are quoted.
|
||||
const identifier = key.substr(1, key.length - 2);
|
||||
const occurrences = this.usedKeys[key];
|
||||
|
||||
// bad key
|
||||
if (!NoUnexternalizedStringsRuleWalker.IDENTIFIER.test(identifier)) {
|
||||
context.report({
|
||||
loc: occurrences[0].key.loc,
|
||||
messageId: 'badKey',
|
||||
data: { key: occurrences[0].key.value }
|
||||
});
|
||||
}
|
||||
|
||||
// duplicates key
|
||||
if (occurrences.length > 1) {
|
||||
occurrences.forEach(occurrence => {
|
||||
context.report({
|
||||
loc: occurrence.key.loc,
|
||||
messageId: 'duplicateKey',
|
||||
data: { key: occurrence.key.value }
|
||||
});
|
||||
});
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
private _checkStringLiteral(context: eslint.Rule.RuleContext, node: TSESTree.StringLiteral): void {
|
||||
const text = node.raw;
|
||||
const doubleQuoted = text.length >= 2 && text[0] === NoUnexternalizedStringsRuleWalker.DOUBLE_QUOTE && text[text.length - 1] === NoUnexternalizedStringsRuleWalker.DOUBLE_QUOTE;
|
||||
const info = this._findDescribingParent(node);
|
||||
|
||||
// Ignore strings in import and export nodes.
|
||||
if (info && info.isImport && doubleQuoted) {
|
||||
context.report({
|
||||
loc: node.loc,
|
||||
messageId: 'badQuotes'
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
const callInfo = info ? info.callInfo : null;
|
||||
const functionName = callInfo && isStringLiteral(callInfo.callExpression.callee)
|
||||
? callInfo.callExpression.callee.value
|
||||
: null;
|
||||
|
||||
if (functionName && this.ignores[functionName]) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (doubleQuoted && (!callInfo || callInfo.argIndex === -1 || !this.signatures[functionName!])) {
|
||||
context.report({
|
||||
loc: node.loc,
|
||||
messageId: 'unexternalized'
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
// We have a single quoted string outside a localize function name.
|
||||
if (!doubleQuoted && !this.signatures[functionName!]) {
|
||||
return;
|
||||
}
|
||||
// We have a string that is a direct argument into the localize call.
|
||||
const keyArg: TSESTree.Expression | null = callInfo && callInfo.argIndex === this.keyIndex
|
||||
? callInfo.callExpression.arguments[this.keyIndex]
|
||||
: null;
|
||||
|
||||
if (keyArg) {
|
||||
if (isStringLiteral(keyArg)) {
|
||||
this.recordKey(context, keyArg, this.messageIndex && callInfo ? callInfo.callExpression.arguments[this.messageIndex] : undefined);
|
||||
|
||||
} else if (isObjectLiteral(keyArg)) {
|
||||
for (const property of keyArg.properties) {
|
||||
if (isPropertyAssignment(property)) {
|
||||
const name = NoUnexternalizedStringsRuleWalker._getText(context.getSourceCode(), property.key);
|
||||
if (name === 'key') {
|
||||
const initializer = property.value;
|
||||
if (isStringLiteral(initializer)) {
|
||||
this.recordKey(context, initializer, this.messageIndex && callInfo ? callInfo.callExpression.arguments[this.messageIndex] : undefined);
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const messageArg = callInfo!.callExpression.arguments[this.messageIndex!];
|
||||
|
||||
if (messageArg && !isStringLiteral(messageArg)) {
|
||||
context.report({
|
||||
loc: messageArg.loc,
|
||||
messageId: 'badMessage',
|
||||
data: { message: NoUnexternalizedStringsRuleWalker._getText(context.getSourceCode(), callInfo?.callExpression.callee!) }
|
||||
});
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
private recordKey(context: eslint.Rule.RuleContext, keyNode: TSESTree.StringLiteral, messageNode: TSESTree.Node | undefined) {
|
||||
const text = keyNode.raw;
|
||||
// We have an empty key
|
||||
if (text.match(/(['"]) *\1/)) {
|
||||
if (messageNode) {
|
||||
context.report({
|
||||
loc: keyNode.loc,
|
||||
messageId: 'whitespaceKey'
|
||||
});
|
||||
} else {
|
||||
context.report({
|
||||
loc: keyNode.loc,
|
||||
messageId: 'emptyKey'
|
||||
});
|
||||
}
|
||||
return;
|
||||
}
|
||||
let occurrences: KeyMessagePair[] = this.usedKeys[text];
|
||||
if (!occurrences) {
|
||||
occurrences = [];
|
||||
this.usedKeys[text] = occurrences;
|
||||
}
|
||||
if (messageNode) {
|
||||
if (occurrences.some(pair => pair.message ? NoUnexternalizedStringsRuleWalker._getText(context.getSourceCode(), pair.message) === NoUnexternalizedStringsRuleWalker._getText(context.getSourceCode(), messageNode) : false)) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
occurrences.push({ key: keyNode, message: messageNode });
|
||||
}
|
||||
|
||||
private _findDescribingParent(node: TSESTree.Node): { callInfo?: { callExpression: TSESTree.CallExpression, argIndex: number }, isImport?: boolean; } | null {
|
||||
let parent: TSESTree.Node | undefined;
|
||||
while ((parent = node.parent)) {
|
||||
const kind = parent.type;
|
||||
if (kind === AST_NODE_TYPES.CallExpression) {
|
||||
const callExpression = parent as TSESTree.CallExpression;
|
||||
return { callInfo: { callExpression: callExpression, argIndex: callExpression.arguments.indexOf(<any>node) } };
|
||||
|
||||
} else if (kind === AST_NODE_TYPES.TSImportEqualsDeclaration || kind === AST_NODE_TYPES.ImportDeclaration || kind === AST_NODE_TYPES.ExportNamedDeclaration) {
|
||||
return { isImport: true };
|
||||
|
||||
} else if (kind === AST_NODE_TYPES.VariableDeclaration || kind === AST_NODE_TYPES.FunctionDeclaration || kind === AST_NODE_TYPES.TSPropertySignature
|
||||
|| kind === AST_NODE_TYPES.TSMethodSignature || kind === AST_NODE_TYPES.TSInterfaceDeclaration
|
||||
|| kind === AST_NODE_TYPES.ClassDeclaration || kind === AST_NODE_TYPES.TSEnumDeclaration || kind === AST_NODE_TYPES.TSModuleDeclaration
|
||||
|| kind === AST_NODE_TYPES.TSTypeAliasDeclaration || kind === AST_NODE_TYPES.Program) {
|
||||
return null;
|
||||
}
|
||||
node = parent;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
private static _getText(source: eslint.SourceCode, node: TSESTree.Node): string {
|
||||
if (node.type === AST_NODE_TYPES.Literal) {
|
||||
return String(node.value);
|
||||
}
|
||||
const start = source.getIndexFromLoc(node.loc.start);
|
||||
const end = source.getIndexFromLoc(node.loc.end);
|
||||
return source.getText().substring(start, end);
|
||||
}
|
||||
|
||||
};
|
||||
|
||||
Reference in New Issue
Block a user