matchDefaultExportNameRule.js 3.2KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. "use strict";
  2. /**
  3. * @license
  4. * Copyright 2017 Palantir Technologies, Inc.
  5. *
  6. * Licensed under the Apache License, Version 2.0 (the "License");
  7. * you may not use this file except in compliance with the License.
  8. * You may obtain a copy of the License at
  9. *
  10. * http://www.apache.org/licenses/LICENSE-2.0
  11. *
  12. * Unless required by applicable law or agreed to in writing, software
  13. * distributed under the License is distributed on an "AS IS" BASIS,
  14. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15. * See the License for the specific language governing permissions and
  16. * limitations under the License.
  17. */
  18. Object.defineProperty(exports, "__esModule", { value: true });
  19. var tslib_1 = require("tslib");
  20. var tsutils_1 = require("tsutils");
  21. var ts = require("typescript");
  22. var Lint = require("../index");
  23. var Rule = /** @class */ (function (_super) {
  24. tslib_1.__extends(Rule, _super);
  25. function Rule() {
  26. return _super !== null && _super.apply(this, arguments) || this;
  27. }
  28. /* tslint:enable:object-literal-sort-keys */
  29. Rule.FAILURE_STRING = function (importName, exportName) {
  30. return "Expected import '" + importName + "' to match the default export '" + exportName + "'.";
  31. };
  32. Rule.prototype.applyWithProgram = function (sourceFile, program) {
  33. return this.applyWithFunction(sourceFile, walk, undefined, program.getTypeChecker());
  34. };
  35. /* tslint:disable:object-literal-sort-keys */
  36. Rule.metadata = {
  37. ruleName: "match-default-export-name",
  38. description: Lint.Utils.dedent(templateObject_1 || (templateObject_1 = tslib_1.__makeTemplateObject(["\n Requires that a default import have the same name as the declaration it imports.\n Does nothing for anonymous default exports."], ["\n Requires that a default import have the same name as the declaration it imports.\n Does nothing for anonymous default exports."]))),
  39. optionsDescription: "Not configurable.",
  40. options: null,
  41. optionExamples: [true],
  42. type: "style",
  43. typescriptOnly: true,
  44. requiresTypeInfo: true,
  45. };
  46. return Rule;
  47. }(Lint.Rules.TypedRule));
  48. exports.Rule = Rule;
  49. function walk(ctx, tc) {
  50. for (var _i = 0, _a = ctx.sourceFile.statements; _i < _a.length; _i++) {
  51. var statement = _a[_i];
  52. if (!tsutils_1.isImportDeclaration(statement) ||
  53. statement.importClause === undefined || statement.importClause.name === undefined) {
  54. continue;
  55. }
  56. var defaultImport = statement.importClause.name;
  57. var symbol = tc.getSymbolAtLocation(defaultImport);
  58. if (symbol === undefined || !tsutils_1.isSymbolFlagSet(symbol, ts.SymbolFlags.Alias)) {
  59. continue;
  60. }
  61. var declarations = tc.getAliasedSymbol(symbol).declarations;
  62. if (declarations !== undefined && declarations.length !== 0) {
  63. var name = declarations[0].name;
  64. if (name !== undefined && name.kind === ts.SyntaxKind.Identifier && name.text !== defaultImport.text) {
  65. ctx.addFailureAtNode(defaultImport, Rule.FAILURE_STRING(defaultImport.text, name.text));
  66. }
  67. }
  68. }
  69. }
  70. var templateObject_1;