1 | "use strict";
|
2 | var __extends = (this && this.__extends) || (function () {
|
3 | var extendStatics = Object.setPrototypeOf ||
|
4 | ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
5 | function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
|
6 | return function (d, b) {
|
7 | extendStatics(d, b);
|
8 | function __() { this.constructor = d; }
|
9 | d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
10 | };
|
11 | })();
|
12 | Object.defineProperty(exports, "__esModule", { value: true });
|
13 | var ts = require("typescript");
|
14 | var Lint = require("tslint");
|
15 | var ErrorTolerantWalker_1 = require("./utils/ErrorTolerantWalker");
|
16 | var Utils_1 = require("./utils/Utils");
|
17 | var Rule = (function (_super) {
|
18 | __extends(Rule, _super);
|
19 | function Rule() {
|
20 | return _super !== null && _super.apply(this, arguments) || this;
|
21 | }
|
22 | Rule.prototype.apply = function (sourceFile) {
|
23 | return this.applyWithWalker(new ImportNameRuleWalker(sourceFile, this.getOptions()));
|
24 | };
|
25 | Rule.metadata = {
|
26 | ruleName: 'import-name',
|
27 | type: 'maintainability',
|
28 | description: 'The name of the imported module must match the name of the thing being imported',
|
29 | hasFix: true,
|
30 | options: null,
|
31 | optionsDescription: '',
|
32 | typescriptOnly: true,
|
33 | issueClass: 'Ignored',
|
34 | issueType: 'Warning',
|
35 | severity: 'Low',
|
36 | level: 'Opportunity for Excellence',
|
37 | group: 'Clarity',
|
38 | commonWeaknessEnumeration: '710'
|
39 | };
|
40 | return Rule;
|
41 | }(Lint.Rules.AbstractRule));
|
42 | exports.Rule = Rule;
|
43 | var ImportNameRuleWalker = (function (_super) {
|
44 | __extends(ImportNameRuleWalker, _super);
|
45 | function ImportNameRuleWalker(sourceFile, options) {
|
46 | var _this = _super.call(this, sourceFile, options) || this;
|
47 | _this.replacements = _this.extractOptions();
|
48 | return _this;
|
49 | }
|
50 | ImportNameRuleWalker.prototype.extractOptions = function () {
|
51 | var result = {};
|
52 | this.getOptions().forEach(function (opt) {
|
53 | if (typeof (opt) === 'object') {
|
54 | Object.keys(opt).forEach(function (key) {
|
55 | var value = opt[key];
|
56 | if (typeof value === 'string') {
|
57 | result[key] = value;
|
58 | }
|
59 | });
|
60 | }
|
61 | });
|
62 | return result;
|
63 | };
|
64 | ImportNameRuleWalker.prototype.visitImportEqualsDeclaration = function (node) {
|
65 | var name = node.name.text;
|
66 | if (node.moduleReference.kind === ts.SyntaxKind.ExternalModuleReference) {
|
67 | var moduleRef = node.moduleReference;
|
68 | if (moduleRef.expression.kind === ts.SyntaxKind.StringLiteral) {
|
69 | var moduleName = moduleRef.expression.text;
|
70 | this.validateImport(node, name, moduleName);
|
71 | }
|
72 | }
|
73 | else if (node.moduleReference.kind === ts.SyntaxKind.QualifiedName) {
|
74 | var moduleName = node.moduleReference.getText();
|
75 | moduleName = moduleName.replace(/.*\./, '');
|
76 | this.validateImport(node, name, moduleName);
|
77 | }
|
78 | _super.prototype.visitImportEqualsDeclaration.call(this, node);
|
79 | };
|
80 | ImportNameRuleWalker.prototype.visitImportDeclaration = function (node) {
|
81 | if (node.importClause.name != null) {
|
82 | var name_1 = node.importClause.name.text;
|
83 | if (node.moduleSpecifier.kind === ts.SyntaxKind.StringLiteral) {
|
84 | var moduleName = node.moduleSpecifier.text;
|
85 | this.validateImport(node, name_1, moduleName);
|
86 | }
|
87 | }
|
88 | _super.prototype.visitImportDeclaration.call(this, node);
|
89 | };
|
90 | ImportNameRuleWalker.prototype.validateImport = function (node, importedName, moduleName) {
|
91 | moduleName = moduleName.replace(/.*\//, '');
|
92 | moduleName = this.makeCamelCase(moduleName);
|
93 | if (this.isImportNameValid(importedName, moduleName) === false) {
|
94 | var message = "Misnamed import. Import should be named '" + moduleName + "' but found '" + importedName + "'";
|
95 | var nameNode = node.kind === ts.SyntaxKind.ImportEqualsDeclaration ?
|
96 | node.name : node.importClause.name;
|
97 | var nameNodeStartPos = nameNode.getStart();
|
98 | var fix = new Lint.Replacement(nameNodeStartPos, nameNode.end - nameNodeStartPos, moduleName);
|
99 | this.addFailureAt(node.getStart(), node.getWidth(), message, fix);
|
100 | }
|
101 | };
|
102 | ImportNameRuleWalker.prototype.makeCamelCase = function (input) {
|
103 | return input.replace(/[-|\.](.)/g, function (_match, group1) {
|
104 | return group1.toUpperCase();
|
105 | });
|
106 | };
|
107 | ImportNameRuleWalker.prototype.isImportNameValid = function (importedName, moduleName) {
|
108 | var _this = this;
|
109 | if (moduleName === importedName) {
|
110 | return true;
|
111 | }
|
112 | return Utils_1.Utils.exists(Object.keys(this.replacements), function (replacementKey) {
|
113 | if (new RegExp(replacementKey).test(moduleName)) {
|
114 | return importedName === _this.replacements[replacementKey];
|
115 | }
|
116 | return false;
|
117 | });
|
118 | };
|
119 | return ImportNameRuleWalker;
|
120 | }(ErrorTolerantWalker_1.ErrorTolerantWalker));
|
121 |
|
\ | No newline at end of file |