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

feat(typescipt-package): capture the original module name for re-exports 

This change adds the original module name, for items that have been re-exported
to the current module, as the `originalModule` property on the `exportDoc`.
This commit is contained in:
Peter Bacon Darwin 2015-09-18 12:11:54 +01:00 committed by Jay Traband
parent a6b88063f2
commit 4813e9e172
4 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
public/api-builder/typescript-package/mocks/readTypeScriptModules/privateModule.ts Normal file
View File

@ -0,0 +1 @@
export var x = 10;

1
public/api-builder/typescript-package/mocks/readTypeScriptModules/publicModule.ts Normal file
View File

@ -0,0 +1 @@
export { x as y} from './privateModule';

5
public/api-builder/typescript-package/processors/readTypeScriptModules.js
View File

@ -223,6 +223,11 @@ module.exports = function readTypeScriptModules(tsParser, modules, getFileInfo,
if (exportSymbol.flags & ts.SymbolFlags.TypeAlias) {
exportDoc.typeDefinition = typeDefinition;
}
// Compute the original module name from the relative file path
exportDoc.originalModule = exportDoc.fileInfo.relativePath
.replace(new RegExp('\.' + exportDoc.fileInfo.extension + '$'), '');
return exportDoc;
}

11
public/api-builder/typescript-package/processors/readTypeScriptModules.spec.js
View File

@ -13,6 +13,17 @@ describe('readTypeScriptModules', function() {
processor.basePath = path.resolve(__dirname, '../mocks/readTypeScriptModules');
});
describe('exportDocs', function() {
it('should provide the original module if the export is re-exported', function() {
processor.sourceFiles = [ 'publicModule.ts' ];
var docs = [];
processor.$process(docs);
var exportedDoc = docs[1];
expect(exportedDoc.originalModule).toEqual('privateModule');
});
});
describe('ignoreExportsMatching', function() {
it('should ignore exports that match items in the `ignoreExportsMatching` property', function() {