Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: C# NamespaceDoc emitted to wrong location #3183

Merged
merged 2 commits into from
Nov 18, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions packages/@scope/jsii-calc-lib/lib/submodule/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Submodule Readme

This is a submodule readme.
5 changes: 4 additions & 1 deletion packages/@scope/jsii-calc-lib/test/assembly.jsii
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,9 @@
"filename": "lib/index.ts",
"line": 130
},
"readme": {
"markdown": "# Submodule Readme\n\nThis is a submodule readme.\n"
},
"targets": {
"dotnet": {
"namespace": "Amazon.JSII.Tests.CustomSubmoduleName"
Expand Down Expand Up @@ -948,5 +951,5 @@
}
},
"version": "0.0.0",
"fingerprint": "LN1bs46m2O4aR6AhHvi6UDh/f90EoUT3n5apMPzr9+c="
"fingerprint": "fCLOsQQLslSg+W8rn7XDZ1RSenH5QeaoTna+j7o+URc="
}
6 changes: 1 addition & 5 deletions packages/jsii-calc/test/assembly.jsii
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,6 @@
"@scope/jsii-calc-lib": {
"submodules": {
"@scope/jsii-calc-lib.submodule": {
"locationInModule": {
"filename": "lib/index.ts",
"line": 130
},
"targets": {
"dotnet": {
"namespace": "Amazon.JSII.Tests.CustomSubmoduleName"
Expand Down Expand Up @@ -16779,5 +16775,5 @@
}
},
"version": "3.20.120",
"fingerprint": "XZczlgiEPAQC/n86Dqa40vixNH4txnPoyuF1Q+jR6I0="
"fingerprint": "WpcHNV2L+v3B7Ou+8xsRMzye4rf1U+SURQA97A3JT6g="
}
4 changes: 3 additions & 1 deletion packages/jsii-pacmak/lib/targets/dotnet/dotnetgenerator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,9 @@ export class DotNetGenerator extends Generator {
const dotnetNs = this.typeresolver.resolveNamespace(
this.assembly,
this.assembly.name,
jsiiNs,
// Strip the `${assmName}.` prefix here, as the "assembly-relative" NS
// is expected by `this.typeResolver.resovleNamespace`.
jsiiNs.substr(this.assembly.name.length + 1),
);
this.emitNamespaceDocs(dotnetNs, jsiiNs, submodule);
}
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

29 changes: 27 additions & 2 deletions packages/jsii/lib/assembler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3102,17 +3102,42 @@ function noEmptyDict<T>(
function toDependencyClosure(assemblies: readonly spec.Assembly[]): {
[name: string]: spec.AssemblyConfiguration;
} {
const result: { [name: string]: spec.AssemblyTargets } = {};
const result: { [name: string]: spec.AssemblyConfiguration } = {};
for (const assembly of assemblies) {
if (!assembly.targets) {
continue;
}
result[assembly.name] = {
submodules: assembly.submodules,
submodules: cleanUp(assembly.submodules),
targets: assembly.targets,
};
}
return result;

/**
* Removes unneeded fields from the entries part of the `dependencyClosure`
* property. Fields such as `readme` are not necessary and can bloat up the
* assembly object.
*
* This removes the `readme` and `locationInModule` fields from the submodule
* descriptios if present.
*
* @param submodules the submodules list to clean up.
*
* @returns the cleaned up submodules list.
*/
function cleanUp(
submodules: spec.Assembly['submodules'],
): spec.AssemblyConfiguration['submodules'] {
if (submodules == null) {
return submodules;
}
const result: spec.Assembly['submodules'] = {};
for (const [fqn, desc] of Object.entries(submodules)) {
result[fqn] = { ...desc, locationInModule: undefined, readme: undefined };
}
return result;
}
}

function toSubmoduleDeclarations(
Expand Down