chore(doc-gen): filter unwanted decorators from angular.io docs
Closes #3705
This commit is contained in:
parent
dad40751d4
commit
a588d4894b
|
@ -9,6 +9,7 @@ module.exports = new Package('angular.io', [basePackage])
|
||||||
|
|
||||||
.factory(require('./services/renderMarkdown'))
|
.factory(require('./services/renderMarkdown'))
|
||||||
.processor(require('./processors/addJadeDataDocsProcessor'))
|
.processor(require('./processors/addJadeDataDocsProcessor'))
|
||||||
|
.processor(require('./processors/filterUnwantedDecorators'))
|
||||||
|
|
||||||
// Configure rendering
|
// Configure rendering
|
||||||
.config(function(templateFinder, templateEngine) {
|
.config(function(templateFinder, templateEngine) {
|
||||||
|
@ -29,6 +30,14 @@ module.exports = new Package('angular.io', [basePackage])
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|
||||||
|
.config(function(filterUnwantedDecorators, log) {
|
||||||
|
log.level = 'info';
|
||||||
|
filterUnwantedDecorators.decoratorsToIgnore = [
|
||||||
|
'CONST',
|
||||||
|
'IMPLEMENTS',
|
||||||
|
'ABSTRACT'
|
||||||
|
];
|
||||||
|
})
|
||||||
|
|
||||||
|
|
||||||
.config(function(computeIdsProcessor, computePathsProcessor, EXPORT_DOC_TYPES) {
|
.config(function(computeIdsProcessor, computePathsProcessor, EXPORT_DOC_TYPES) {
|
||||||
|
|
|
@ -0,0 +1,20 @@
|
||||||
|
var _ = require('lodash');
|
||||||
|
|
||||||
|
module.exports = function filterUnwantedDecorators() {
|
||||||
|
return {
|
||||||
|
decoratorsToIgnore: [],
|
||||||
|
$runAfter: ['processing-docs'],
|
||||||
|
$runBefore: ['docs-processed'],
|
||||||
|
$process: function(docs) {
|
||||||
|
var decoratorsToIgnore = this.decoratorsToIgnore || [];
|
||||||
|
_.forEach(docs, function(doc) {
|
||||||
|
if (doc.decorators) {
|
||||||
|
doc.decorators = _.filter(doc.decorators, function(decorator) {
|
||||||
|
return decoratorsToIgnore.indexOf(decorator.name) === -1;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
return docs;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
|
@ -0,0 +1,46 @@
|
||||||
|
var mockPackage = require('../mocks/mockPackage');
|
||||||
|
var Dgeni = require('dgeni');
|
||||||
|
|
||||||
|
describe('filterUnwantedDecorators', function() {
|
||||||
|
var dgeni, injector, processor;
|
||||||
|
|
||||||
|
beforeEach(function() {
|
||||||
|
dgeni = new Dgeni([mockPackage()]);
|
||||||
|
injector = dgeni.configureInjector();
|
||||||
|
processor = injector.get('filterUnwantedDecorators');
|
||||||
|
});
|
||||||
|
|
||||||
|
|
||||||
|
it('should remove decorators specified by name', function() {
|
||||||
|
var docs = [
|
||||||
|
{ id: 'doc1', decorators: [ { name: 'A' }, { name: 'B' } ] },
|
||||||
|
{ id: 'doc2', decorators: [ { name: 'B' }, { name: 'C' } ] },
|
||||||
|
{ id: 'doc3', decorators: [ { name: 'A' }, { name: 'C' } ] }
|
||||||
|
];
|
||||||
|
processor.decoratorsToIgnore = ['D', 'B'];
|
||||||
|
docs = processor.$process(docs);
|
||||||
|
|
||||||
|
expect(docs).toEqual([
|
||||||
|
{ id: 'doc1', decorators: [ { name: 'A' } ] },
|
||||||
|
{ id: 'doc2', decorators: [ { name: 'C' } ] },
|
||||||
|
{ id: 'doc3', decorators: [ { name: 'A' }, { name: 'C' } ] }
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
|
||||||
|
it('should ignore docs that have no decorators', function() {
|
||||||
|
var docs = [
|
||||||
|
{ id: 'doc1', decorators: [ { name: 'A' }, { name: 'B' } ] },
|
||||||
|
{ id: 'doc2' },
|
||||||
|
{ id: 'doc3', decorators: [ { name: 'A' }, { name: 'C' } ] }
|
||||||
|
];
|
||||||
|
processor.decoratorsToIgnore = ['D', 'B'];
|
||||||
|
docs = processor.$process(docs);
|
||||||
|
|
||||||
|
expect(docs).toEqual([
|
||||||
|
{ id: 'doc1', decorators: [ { name: 'A' } ] },
|
||||||
|
{ id: 'doc2' },
|
||||||
|
{ id: 'doc3', decorators: [ { name: 'A' }, { name: 'C' } ] }
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
});
|
Loading…
Reference in New Issue