From fd4f66f90f6ac753286558c980e46a7996c0a4a1 Mon Sep 17 00:00:00 2001 From: Alec LaLonde Date: Tue, 1 Oct 2019 17:33:54 -0600 Subject: [PATCH] Fixed issue where nested object literals were getting skipped with --excludeNotExported --- src/lib/converter/factories/declaration.ts | 6 +- src/test/converter.test.ts | 16 + .../export-literals/export-literals.ts | 20 + .../specs-without-exported.json | 363 ++++++++++++++++++ src/test/converter/export-literals/specs.json | 355 +++++++++++++++++ 5 files changed, 759 insertions(+), 1 deletion(-) create mode 100644 src/test/converter/export-literals/export-literals.ts create mode 100644 src/test/converter/export-literals/specs-without-exported.json create mode 100644 src/test/converter/export-literals/specs.json diff --git a/src/lib/converter/factories/declaration.ts b/src/lib/converter/factories/declaration.ts index 3a99410f6..535cf51f5 100644 --- a/src/lib/converter/factories/declaration.ts +++ b/src/lib/converter/factories/declaration.ts @@ -56,6 +56,10 @@ export function createDeclaration(context: Context, node: ts.Declaration, kind: let isExported: boolean; if (container.kindOf([ReflectionKind.Module, ReflectionKind.ExternalModule])) { isExported = false; // Don't inherit exported state in modules and namespaces + } else if (container.kindOf([ReflectionKind.TypeLiteral]) && context.converter.excludeNotExported) { + // If the container for this is a type literal, it never had the + // isExported flag set on it. See https://github.com/TypeStrong/typedoc/issues/953 + isExported = true; } else { isExported = container.flags.isExported; } @@ -108,7 +112,7 @@ export function createDeclaration(context: Context, node: ts.Declaration, kind: child.setFlag(ReflectionFlag.Static, isStatic); child.setFlag(ReflectionFlag.Private, isPrivate); child.setFlag(ReflectionFlag.ConstructorProperty, isConstructorProperty); - child.setFlag(ReflectionFlag.Exported, isExported); + child.setFlag(ReflectionFlag.Exported, isExported); child = setupDeclaration(context, child, node); if (child) { diff --git a/src/test/converter.test.ts b/src/test/converter.test.ts index 112e45278..8546eb76c 100644 --- a/src/test/converter.test.ts +++ b/src/test/converter.test.ts @@ -156,6 +156,7 @@ describe('Converter with excludeNotExported=true', function() { const base = Path.join(__dirname, 'converter'); const exportWithLocalDir = Path.join(base, 'export-with-local'); const classDir = Path.join(base, 'class'); + const literalsDir = Path.join(base, 'export-literals'); let app: Application; before('constructs', function() { @@ -204,4 +205,19 @@ describe('Converter with excludeNotExported=true', function() { }); }); + describe('export-literals', () => { + it('converts fixtures', function() { + resetReflectionID(); + result = app.convert(app.expandInputFiles([literalsDir])); + Assert(result instanceof ProjectReflection, 'No reflection returned'); + }); + + it('matches specs', function() { + const specs = JSON.parse(FS.readFileSync(Path.join(literalsDir, 'specs-without-exported.json')).toString()); + let data = JSON.stringify(result!.toObject(), null, ' '); + data = data.split(normalizePath(base)).join('%BASE%'); + + compareReflections(JSON.parse(data), specs); + }); + }); }); diff --git a/src/test/converter/export-literals/export-literals.ts b/src/test/converter/export-literals/export-literals.ts new file mode 100644 index 000000000..e19281d20 --- /dev/null +++ b/src/test/converter/export-literals/export-literals.ts @@ -0,0 +1,20 @@ +export interface INestedInterface +{ + nestedOptional?: { + innerMember: string; + }; + + nested: { + isIncluded: boolean; + }; +} + +export function func(param: {nested: string}): boolean { + return param.nested === 'yes'; +} + +export function createSomething() { + return { + foo: 'bar' + }; +} diff --git a/src/test/converter/export-literals/specs-without-exported.json b/src/test/converter/export-literals/specs-without-exported.json new file mode 100644 index 000000000..e33f71145 --- /dev/null +++ b/src/test/converter/export-literals/specs-without-exported.json @@ -0,0 +1,363 @@ +{ + "id": 0, + "name": "typedoc", + "kind": 0, + "flags": {}, + "children": [ + { + "id": 1, + "name": "\"export-literals\"", + "kind": 1, + "kindString": "External module", + "flags": { + "isExported": true + }, + "originalName": "%BASE%/export-literals/export-literals.ts", + "children": [ + { + "id": 2, + "name": "INestedInterface", + "kind": 256, + "kindString": "Interface", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 6, + "name": "nested", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "export-literals.ts", + "line": 7, + "character": 10 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 7, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 8, + "name": "isIncluded", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "export-literals.ts", + "line": 8, + "character": 18 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 8 + ] + } + ], + "sources": [ + { + "fileName": "export-literals.ts", + "line": 7, + "character": 11 + } + ] + } + } + }, + { + "id": 3, + "name": "nestedOptional", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "export-literals.ts", + "line": 3, + "character": 18 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 4, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 5, + "name": "innerMember", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "export-literals.ts", + "line": 4, + "character": 19 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 5 + ] + } + ], + "sources": [ + { + "fileName": "export-literals.ts", + "line": 3, + "character": 20 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 6, + 3 + ] + } + ], + "sources": [ + { + "fileName": "export-literals.ts", + "line": 1, + "character": 33 + } + ] + }, + { + "id": 14, + "name": "createSomething", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 15, + "name": "createSomething", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 16, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 17, + "name": "foo", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "export-literals.ts", + "line": 18, + "character": 11 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"bar\"" + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 17 + ] + } + ] + } + } + } + ], + "sources": [ + { + "fileName": "export-literals.ts", + "line": 16, + "character": 31 + } + ] + }, + { + "id": 9, + "name": "func", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 10, + "name": "func", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 11, + "name": "param", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 12, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 13, + "name": "nested", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "export-literals.ts", + "line": 12, + "character": 35 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 13 + ] + } + ], + "sources": [ + { + "fileName": "export-literals.ts", + "line": 12, + "character": 27 + } + ] + } + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "sources": [ + { + "fileName": "export-literals.ts", + "line": 12, + "character": 20 + } + ] + } + ], + "groups": [ + { + "title": "Interfaces", + "kind": 256, + "children": [ + 2 + ] + }, + { + "title": "Functions", + "kind": 64, + "children": [ + 14, + 9 + ] + } + ], + "sources": [ + { + "fileName": "export-literals.ts", + "line": 1, + "character": 0 + } + ] + } + ], + "groups": [ + { + "title": "External modules", + "kind": 1, + "children": [ + 1 + ] + } + ] + } diff --git a/src/test/converter/export-literals/specs.json b/src/test/converter/export-literals/specs.json new file mode 100644 index 000000000..fb39e772d --- /dev/null +++ b/src/test/converter/export-literals/specs.json @@ -0,0 +1,355 @@ +{ + "id": 0, + "name": "typedoc", + "kind": 0, + "flags": {}, + "children": [ + { + "id": 1, + "name": "\"export-literals\"", + "kind": 1, + "kindString": "External module", + "flags": { + "isExported": true + }, + "originalName": "%BASE%/export-literals/export-literals.ts", + "children": [ + { + "id": 2, + "name": "INestedInterface", + "kind": 256, + "kindString": "Interface", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 6, + "name": "nested", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "export-literals.ts", + "line": 7, + "character": 10 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 7, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 8, + "name": "isIncluded", + "kind": 32, + "kindString": "Variable", + "flags": {}, + "sources": [ + { + "fileName": "export-literals.ts", + "line": 8, + "character": 18 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 8 + ] + } + ], + "sources": [ + { + "fileName": "export-literals.ts", + "line": 7, + "character": 11 + } + ] + } + } + }, + { + "id": 3, + "name": "nestedOptional", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "export-literals.ts", + "line": 3, + "character": 18 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 4, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 5, + "name": "innerMember", + "kind": 32, + "kindString": "Variable", + "flags": {}, + "sources": [ + { + "fileName": "export-literals.ts", + "line": 4, + "character": 19 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 5 + ] + } + ], + "sources": [ + { + "fileName": "export-literals.ts", + "line": 3, + "character": 20 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 6, + 3 + ] + } + ], + "sources": [ + { + "fileName": "export-literals.ts", + "line": 1, + "character": 33 + } + ] + }, + { + "id": 14, + "name": "createSomething", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 15, + "name": "createSomething", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 16, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 17, + "name": "foo", + "kind": 32, + "kindString": "Variable", + "flags": {}, + "sources": [ + { + "fileName": "export-literals.ts", + "line": 18, + "character": 11 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"bar\"" + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 17 + ] + } + ] + } + } + } + ], + "sources": [ + { + "fileName": "export-literals.ts", + "line": 16, + "character": 31 + } + ] + }, + { + "id": 9, + "name": "func", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 10, + "name": "func", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 11, + "name": "param", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 12, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 13, + "name": "nested", + "kind": 32, + "kindString": "Variable", + "flags": {}, + "sources": [ + { + "fileName": "export-literals.ts", + "line": 12, + "character": 35 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 13 + ] + } + ], + "sources": [ + { + "fileName": "export-literals.ts", + "line": 12, + "character": 27 + } + ] + } + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "sources": [ + { + "fileName": "export-literals.ts", + "line": 12, + "character": 20 + } + ] + } + ], + "groups": [ + { + "title": "Interfaces", + "kind": 256, + "children": [ + 2 + ] + }, + { + "title": "Functions", + "kind": 64, + "children": [ + 14, + 9 + ] + } + ], + "sources": [ + { + "fileName": "export-literals.ts", + "line": 1, + "character": 0 + } + ] + } + ], + "groups": [ + { + "title": "External modules", + "kind": 1, + "children": [ + 1 + ] + } + ] + }