noReferenceRule.js 2.2KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. "use strict";
  2. /**
  3. * @license
  4. * Copyright 2016 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 Lint = require("../index");
  21. var Rule = /** @class */ (function (_super) {
  22. tslib_1.__extends(Rule, _super);
  23. function Rule() {
  24. return _super !== null && _super.apply(this, arguments) || this;
  25. }
  26. Rule.prototype.apply = function (sourceFile) {
  27. return this.applyWithFunction(sourceFile, walk);
  28. };
  29. /* tslint:disable:object-literal-sort-keys */
  30. Rule.metadata = {
  31. ruleName: "no-reference",
  32. description: "Disallows `/// <reference path=>` imports (use ES6-style imports instead).",
  33. rationale: Lint.Utils.dedent(templateObject_1 || (templateObject_1 = tslib_1.__makeTemplateObject(["\n Using `/// <reference path=>` comments to load other files is outdated.\n Use ES6-style imports to reference other files."], ["\n Using \\`/// <reference path=>\\` comments to load other files is outdated.\n Use ES6-style imports to reference other files."]))),
  34. optionsDescription: "Not configurable.",
  35. options: null,
  36. optionExamples: [true],
  37. type: "typescript",
  38. typescriptOnly: false,
  39. };
  40. /* tslint:enable:object-literal-sort-keys */
  41. Rule.FAILURE_STRING = "<reference> is not allowed, use imports";
  42. return Rule;
  43. }(Lint.Rules.AbstractRule));
  44. exports.Rule = Rule;
  45. function walk(ctx) {
  46. for (var _i = 0, _a = ctx.sourceFile.referencedFiles; _i < _a.length; _i++) {
  47. var ref = _a[_i];
  48. ctx.addFailure(ref.pos, ref.end, Rule.FAILURE_STRING);
  49. }
  50. }
  51. var templateObject_1;