55 lines
1.7 KiB
TypeScript
55 lines
1.7 KiB
TypeScript
|
/*---------------------------------------------------------------------------------------------
|
||
|
|
* 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 type * as estree from 'estree';
|
||
|
|
|
||
|
|
export = new class ApiVsCodeInComments implements eslint.Rule.RuleModule {
|
||
|
|
|
||
|
|
readonly meta: eslint.Rule.RuleMetaData = {
|
||
|
|
messages: {
|
||
|
|
comment: `Don't use the term 'vs code' in comments`
|
||
|
|
},
|
||
|
|
schema: false,
|
||
|
|
};
|
||
|
|
|
||
|
|
create(context: eslint.Rule.RuleContext): eslint.Rule.RuleListener {
|
||
|
|
|
||
|
|
const sourceCode = context.getSourceCode();
|
||
|
|
|
||
|
|
return {
|
||
|
|
['Program']: (_node: any) => {
|
||
|
|
|
||
|
|
for (const comment of sourceCode.getAllComments()) {
|
||
|
|
if (comment.type !== 'Block') {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
if (!comment.range) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
const startIndex = comment.range[0] + '/*'.length;
|
||
|
|
const re = /vs code/ig;
|
||
|
|
let match: RegExpExecArray | null;
|
||
|
|
while ((match = re.exec(comment.value))) {
|
||
|
|
// Allow using 'VS Code' in quotes
|
||
|
|
if (comment.value[match.index - 1] === `'` && comment.value[match.index + match[0].length] === `'`) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Types for eslint seem incorrect
|
||
|
|
const start = sourceCode.getLocFromIndex(startIndex + match.index) as any as estree.Position;
|
||
|
|
const end = sourceCode.getLocFromIndex(startIndex + match.index + match[0].length) as any as estree.Position;
|
||
|
|
context.report({
|
||
|
|
messageId: 'comment',
|
||
|
|
loc: { start, end }
|
||
|
|
});
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
};
|
||
|
|
}
|
||
|
|
};
|