type2docfx
Version:
A tool to convert json format output from TypeDoc to universal reference model for DocFx to consume.
88 lines (87 loc) • 3.68 kB
JavaScript
;
var __extends = (this && this.__extends) || (function () {
var extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
return function (d, b) {
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
var Lint = require("tslint");
var ts = require("typescript");
var sprintf_js_1 = require("sprintf-js");
var ngWalker_1 = require("./angular/ngWalker");
var getInterfaceName = function (t) {
if (!t.expression) {
return '';
}
if (t.expression.name) {
return t.expression.name.text;
}
return t.expression.text;
};
var ValidatorSuffix = 'Validator';
var Rule = (function (_super) {
__extends(Rule, _super);
function Rule() {
return _super !== null && _super.apply(this, arguments) || this;
}
Rule.validate = function (className, suffixes) {
return suffixes.some(function (s) { return className.endsWith(s); });
};
Rule.prototype.apply = function (sourceFile) {
return this.applyWithWalker(new ClassMetadataWalker(sourceFile, this.getOptions()));
};
Rule.metadata = {
ruleName: 'directive-class-suffix',
type: 'style',
description: 'Classes decorated with @Directive must have suffix "Directive" (or custom) in their name.',
descriptionDetails: 'See more at https://angular.io/styleguide#style-02-03.',
rationale: 'Consistent conventions make it easy to quickly identify and reference assets of different types.',
options: {
type: 'array',
items: {
type: 'string',
}
},
optionExamples: [
'true',
'[true, "Directive", "MySuffix"]',
],
optionsDescription: 'Supply a list of allowed component suffixes. Defaults to "Directive".',
typescriptOnly: true,
};
Rule.FAILURE = 'The name of the class %s should end with the suffix %s (https://angular.io/styleguide#style-02-03)';
return Rule;
}(Lint.Rules.AbstractRule));
exports.Rule = Rule;
var ClassMetadataWalker = (function (_super) {
__extends(ClassMetadataWalker, _super);
function ClassMetadataWalker() {
return _super !== null && _super.apply(this, arguments) || this;
}
ClassMetadataWalker.prototype.visitNgDirective = function (meta) {
var name = meta.controller.name;
var className = name.text;
var options = this.getOptions();
var suffixes = options.length ? options : ['Directive'];
var heritageClauses = meta.controller.heritageClauses;
if (heritageClauses) {
var i = heritageClauses.filter(function (h) { return h.token === ts.SyntaxKind.ImplementsKeyword; });
if (i.length !== 0 &&
i[0].types.map(getInterfaceName)
.filter(function (name) { return !!name; })
.some(function (name) { return name.endsWith(ValidatorSuffix); })) {
suffixes.push(ValidatorSuffix);
}
}
if (!Rule.validate(className, suffixes)) {
this.addFailure(this.createFailure(name.getStart(), name.getWidth(), sprintf_js_1.sprintf.apply(this, [Rule.FAILURE, className, suffixes.join(', ')])));
}
};
return ClassMetadataWalker;
}(ngWalker_1.NgWalker));
exports.ClassMetadataWalker = ClassMetadataWalker;