honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

build(aio): compute search title for certain API docs

This commit is contained in:
Peter Bacon Darwin 2017-05-03 22:45:36 +01:00 committed by Pete Bacon Darwin
parent 978376a46e
commit 4dabec6a48
2 changed files with 34 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
aio/tools/transforms/angular-api-package/processors/computeSearchTitle.js vendored
View File

@ -3,7 +3,16 @@ module.exports = function computeSearchTitleProcessor() {
$runAfter: ['ids-computed'], $runAfter: ['ids-computed'],
$runBefore: ['generateKeywordsProcessor'], $runBefore: ['generateKeywordsProcessor'],
$process(docs) { $process(docs) {
docs.forEach(doc => {
switch(doc.docType) {
case 'function':
doc.searchTitle = `${doc.name}()`;
break;
case 'module':
doc.searchTitle = `${doc.id} package`;
break;
}
});
} }
}; };
}; };

53
aio/tools/transforms/angular-api-package/processors/computeSearchTitle.spec.js
View File

@ -2,7 +2,7 @@ const testPackage = require('../../helpers/test-package');
const processorFactory = require('./computeSearchTitle'); const processorFactory = require('./computeSearchTitle');
const Dgeni = require('dgeni'); const Dgeni = require('dgeni');
fdescribe('computeSearchTitle processor', () => { describe('computeSearchTitle processor', () => {
it('should be available on the injector', () => { it('should be available on the injector', () => {
const dgeni = new Dgeni([testPackage('angular-api-package')]); const dgeni = new Dgeni([testPackage('angular-api-package')]);
@ -21,39 +21,34 @@ fdescribe('computeSearchTitle processor', () => {
expect(processor.$runBefore).toEqual(['generateKeywordsProcessor']); expect(processor.$runBefore).toEqual(['generateKeywordsProcessor']);
}); });
it('should compute a search title for class-like docs', () => { it('should compute a search title for API docs', () => {
const processor = processorFactory(); const processor = processorFactory();
const docs = [ const docs = [
{ docType: 'class', name: 'MyClass' }, { docType: 'class', name: 'MyClass' },
{ docType: 'interface', name: 'MyInterface' }, { docType: 'interface', name: 'MyInterface' },
{ docType: 'pipe', name: 'MyPipe', pipeOptions: { name: 'myPipe' } } { docType: 'enum', name: 'MyEnum' },
{ docType: 'function', name: 'myFunction' },
{ docType: 'pipe', name: 'MyPipe', pipeOptions: { name: 'myPipe' } },
{ docType: 'directive', name: 'MyDirective', directiveOptions: {} },
{ docType: 'decorator', name: 'MyDecorator' },
{ docType: 'module', name: 'myModule', id: 'some/myModule' },
{ docType: 'var', name: 'myVar' },
{ docType: 'let', name: 'myLet' },
{ docType: 'const', name: 'myConst' },
{ docType: 'type-alias', name: 'myType' },
]; ];
processor.$process(docs); processor.$process(docs);
expect(docs[0].searchTitle).toEqual('class MyClass'); expect(docs[0].searchTitle).toBeUndefined();
expect(docs[0].searchTitle).toEqual('interface MyInterface'); expect(docs[1].searchTitle).toBeUndefined();
expect(docs[0].searchTitle).toEqual('myPipe (pipe)'); expect(docs[2].searchTitle).toBeUndefined();
expect(docs[3].searchTitle).toEqual('myFunction()');
expect(docs[4].searchTitle).toBeUndefined();
expect(docs[5].searchTitle).toBeUndefined();
expect(docs[6].searchTitle).toBeUndefined();
expect(docs[7].searchTitle).toEqual('some/myModule package');
expect(docs[8].searchTitle).toBeUndefined();
expect(docs[9].searchTitle).toBeUndefined();
expect(docs[10].searchTitle).toBeUndefined();
expect(docs[11].searchTitle).toBeUndefined();
}); });
it('should compute a class search title', () => {
const processor = processorFactory();
const docs = [
{ docType: 'class', name: 'MyClass' }
];
processor.$process(docs);
expect(docs[0].searchTitle).toEqual('class MyClass');
});
}); });
// 'decorator',
// 'directive',
// 'module'
// 'function',
// 'var',
// 'const',
// 'let',
// 'enum',
// 'type-alias',
// 'value-module'