This repository has been archived on 2024-09-09 . You can view files and clone it, but cannot push or open issues or pull requests.
46 lines
1.4 KiB
TypeScript
46 lines
1.4 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 { TSESTree } from '@typescript-eslint/experimental-utils';
|
|||
|
|||
export = new class ApiProviderNaming implements eslint.Rule.RuleModule {
|
|||
|
|||
readonly meta: eslint.Rule.RuleMetaData = {
|
|||
messages: {
|
|||
naming: 'A provider should only have functions like provideXYZ or resolveXYZ',
|
|||
}
|
|||
};
|
|||
|
|||
private static _providerFunctionNames = /^(provide|resolve|prepare).+/;
|
|||
|
|||
create(context: eslint.Rule.RuleContext): eslint.Rule.RuleListener {
|
|||
|
|||
const config = <{ allowed: string[] }>context.options[0];
|
|||
const allowed = new Set(config.allowed);
|
|||
|
|||
return {
|
|||
['TSInterfaceDeclaration[id.name=/.+Provider/] TSMethodSignature']: (node: any) => {
|
|||
|
|||
|
|||
const interfaceName = (<TSESTree.TSInterfaceDeclaration>(<TSESTree.Identifier>node).parent?.parent).id.name;
|
|||
if (allowed.has(interfaceName)) {
|
|||
// allowed
|
|||
return;
|
|||
}
|
|||
|
|||
const methodName = (<any>(<TSESTree.TSMethodSignatureNonComputedName>node).key).name;
|
|||
|
|||
if (!ApiProviderNaming._providerFunctionNames.test(methodName)) {
|
|||
context.report({
|
|||
node,
|
|||
messageId: 'naming'
|
|||
});
|
|||
}
|
|||
}
|
|||
};
|
|||
}
|
|||
};
|