Emit new package-related properties in generated C# project file. #169

mpiroc · 2018-08-09T22:16:06Z

Update JsonModel.Assembly to include new language-agnostic package-related properties.
Update JsonModel.DotNetTarget to include new dotnet-specific package-related properties.
Convert new properties to MSBuild properties and include them in generated .csproj files.

mpiroc · 2018-08-09T22:23:14Z

(fix incoming for the test failure)

eladb · 2018-08-10T07:16:03Z

packages/jsii-calc-base-of-base/package.json

@@ -15,7 +15,8 @@
        }
      },
      "dotnet": {
-        "namespace": "Amazon.JSII.Tests.Calculator.BaseOfBase"
+        "namespace": "Amazon.JSII.Tests.Calculator.BaseOfBase",
+        "packageId": "Amazon.JSII.Tests.Calculator.BaseOfBase"


To improve testability, perhaps use a different packageId to make sure you don't have lingering assumptions

eladb · 2018-08-10T07:20:11Z

...-calc-base/dotnet/Amazon.JSII.Tests.Calculator.Base/Amazon.JSII.Tests.Calculator.Base.csproj

    <PackageVersion>0.6.4</PackageVersion>
+    <PackageId>Amazon.JSII.Tests.Calculator.Base</PackageId>
+    <Description>@scope/jsii-calc-base</Description>


Is that really the description in package.json? If it is, let's change it to something that looks like a description

package.json does not contain a description, so the jsii compiler falls back on name:

// default "description" to "name" and "homepage" to repo url if (!pkg.description) { pkg.description = pkg.name; }

I'll add description properties to the jsii-calc packages.

eladb · 2018-08-10T07:22:37Z

packages/jsii-dotnet-jsonmodel/src/Amazon.JSII.JsonModel.UnitTests/Spec/AssemblyTests.cs

+                        packageId: "Dot.Net.PackageId",
+                        signAssembly: true,
+                        assemblyOriginatorKey: "key.snk",
+                        tags: new [] { "tag1", "tag2" },


Tags should come from package.json through the jsii spec, not from the target. I think you can omit for now and open an issue for us to add it later.

✔️ (removed tags for now, refer to #170)

…different names than their root namespaces.

costleya · 2018-08-11T01:20:52Z

packages/jsii-ruby-runtime/package.json

@@ -1,35 +0,0 @@
-{


costleya · 2018-08-11T01:21:54Z

...culatorPackageId/Amazon/JSII/Tests/CalculatorNamespace/composition/CompositionStringStyle.cs

@@ -1,6 +1,6 @@
 using Amazon.JSII.Runtime.Deputy;

-namespace Amazon.JSII.Tests.Calculator.composition
+namespace Amazon.JSII.Tests.CalculatorNamespace.composition


Not for this change, but the last section of a namespace also needs to obey capitalization rules

costleya

This also removes nuspec file generation correct? We don't need those since we are using the dotnet cli with csproj metadata.

eladb · 2018-08-12T07:21:05Z

@costleya wrote:

This also removes nuspec file generation correct? We don't need those since we are using the dotnet cli with csproj metadata.

Can you elaborate? I am still assuming we are producing unsigned .nupkg files in jsii-pacmak and then unzip + resign them in our publishing task. Can we please align on this as this has implications on our release infrastructure.

eladb · 2018-08-13T12:11:24Z

Please make sure to update README with the new dotnet target configuration schema

mpiroc · 2018-08-13T21:33:02Z

This also removes nuspec file generation correct? We don't need those since we are using the dotnet cli with csproj metadata.

We never explicitly generated .nuspec files--we were already using the .NET Standard .csproj properties to produce NuGet packages, but we were missing several properties.

eladb · 2018-08-14T05:24:23Z

README.md

@@ -86,7 +86,8 @@ Edit your `package.json`:
        }
      },
      "dotnet": {
-        "namespace": "Acme.Hello"
+        "namespace": "Acme.Hello",
+        "packageId": "Acme.Hello"


Set a different packageId here to make it clear where this value is going

eladb · 2018-08-14T05:24:36Z

README.md

@@ -265,7 +267,15 @@ The following targets are currently supported:
 ```json


Change to js so that comments won't appear as errors

eladb · 2018-08-14T05:25:04Z

README.md

+    "packageId": "Acme.Hello",
+
+    /* optional */
+    "title": "ACME Hello",


Why do we have this? Isn't this the same as description? If it's not provided, what is the default?

It is not--title is a short human-readable name, while description is more detailed. If a NuGet package has no title, it defaults to the package's packageId. Updated comments to reflect this.

✔️

eladb · 2018-08-14T05:25:12Z

README.md

+
+    /* optional */
+    "title": "ACME Hello",
+    "iconUrl": "path/to/icon.svg",


Add comments with defaults to all fields

…1 in /packages/@jsii/python-runtime (#3315) Updates the requirements on [cattrs](https://github.com/python-attrs/cattrs) to permit the latest version. <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/python-attrs/cattrs/blob/main/HISTORY.rst">cattrs's changelog</a>.</em></p> <blockquote> <h2>1.10.0 (2022-01-04)</h2> <ul> <li>Add PEP 563 (string annotations) support for dataclasses. (<code>[#195](python-attrs/cattrs#195) <https://github.com/python-attrs/cattrs/issues/195></code>_)</li> <li>Fix handling of dictionaries with string Enum keys for bson, orjson, and tomlkit.</li> <li>Rename the <code>cattr.gen.make_dict_unstructure_fn.omit_if_default</code> parameter to <code>_cattrs_omit_if_default</code>, for consistency. The <code>omit_if_default</code> parameters to <code>GenConverter</code> and <code>override</code> are unchanged.</li> <li>Following the changes in <code>attrs</code> 21.3.0, add a <code>cattrs</code> package mirroring the existing <code>cattr</code> package. Both package names may be used as desired, and the <code>cattr</code> package isn't going away.</li> </ul> <h2>1.9.0 (2021-12-06)</h2> <ul> <li>Python 3.10 support, including support for the new union syntax (<code>A | B</code> vs <code>Union[A, B]</code>).</li> <li>The <code>GenConverter</code> can now properly structure generic classes with generic collection fields. (<code>[#149](python-attrs/cattrs#149) <https://github.com/python-attrs/cattrs/issues/149></code>_)</li> <li><code>omit=True</code> now also affects generated structuring functions. (<code>[#166](python-attrs/cattrs#166) <https://github.com/python-attrs/cattrs/issues/166></code>_)</li> <li><code>cattr.gen.{make_dict_structure_fn, make_dict_unstructure_fn}</code> now resolve type annotations automatically when PEP 563 is used. (<code>[#169](python-attrs/cattrs#169) <https://github.com/python-attrs/cattrs/issues/169></code>_)</li> <li>Protocols are now unstructured as their runtime types. (<code>[#177](python-attrs/cattrs#177) <https://github.com/python-attrs/cattrs/pull/177></code>_)</li> <li>Fix an issue generating structuring functions with renaming and <code>_cattrs_forbid_extra_keys=True</code>. (<code>[#190](python-attrs/cattrs#190) <https://github.com/python-attrs/cattrs/issues/190></code>_)</li> </ul> <h2>1.8.0 (2021-08-13)</h2> <ul> <li>Fix <code>GenConverter</code> mapping structuring for unannotated dicts on Python 3.8. (<code>[#151](python-attrs/cattrs#151) <https://github.com/python-attrs/cattrs/issues/151></code>_)</li> <li>The source code for generated un/structuring functions is stored in the <code>linecache</code> cache, which enables more informative stack traces when un/structuring errors happen using the <code>GenConverter</code>. This behavior can optionally be disabled to save memory.</li> <li>Support using the attr converter callback during structure. By default, this is a method of last resort, but it can be elevated to the default by setting <code>prefer_attrib_converters=True</code> on <code>Converter</code> or <code>GenConverter</code>. (<code>[#138](python-attrs/cattrs#138) <https://github.com/python-attrs/cattrs/issues/138></code>_)</li> <li>Fix structuring recursive classes. (<code>[#159](python-attrs/cattrs#159) <https://github.com/python-attrs/cattrs/issues/159></code>_)</li> <li>Converters now support un/structuring hook factories. This is the most powerful and complex venue for customizing un/structuring. This had previously been an internal feature.</li> <li>The <code>Common Usage Examples <https://cattrs.readthedocs.io/en/latest/usage.html#using-factory-hooks></code>_ documentation page now has a section on advanced hook factory usage.</li> <li><code>cattr.override</code> now supports the <code>omit</code> parameter, which makes <code>cattrs</code> skip the atribute entirely when unstructuring.</li> <li>The <code>cattr.preconf.bson</code> module is now tested against the <code>bson</code> module bundled with the <code>pymongo</code> package, because that package is much more popular than the standalone PyPI <code>bson</code> package.</li> </ul> <h2>1.7.1 (2021-05-28)</h2> <ul> <li><code>Literal</code> s are not supported on Python 3.9.0 (supported on 3.9.1 and later), so we skip importing them there. (<code>[#150](python-attrs/cattrs#150) <https://github.com/python-attrs/cattrs/issues/150></code>_)</li> </ul> <h2>1.7.0 (2021-05-26)</h2> <ul> <li><code>cattr.global_converter</code> (which provides <code>cattr.unstructure</code>, <code>cattr.structure</code> etc.) is now an instance of <code>cattr.GenConverter</code>.</li> <li><code>Literal</code> s are now supported and validated when structuring.</li> <li>Fix dependency metadata information for <code>attrs</code>. (<code>[#147](python-attrs/cattrs#147) <https://github.com/python-attrs/cattrs/issues/147></code>_)</li> <li>Fix <code>GenConverter</code> mapping structuring for unannotated dicts. (<code>[#148](python-attrs/cattrs#148) <https://github.com/python-attrs/cattrs/issues/148></code>_)</li> </ul> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/python-attrs/cattrs/commit/7d3a6ba5e0df942391349e332cb87f6871088015"><code>7d3a6ba</code></a> Bump to 1.10.0</li> <li><a href="https://github.com/python-attrs/cattrs/commit/22b24c28fbeb2b8ca90d568dc4939bdc98ec5902"><code>22b24c2</code></a> Tin/import cattrs (<a href="https://github-redirect.dependabot.com/python-attrs/cattrs/issues/203">#203</a>)</li> <li><a href="https://github.com/python-attrs/cattrs/commit/a0e56f43f061c43814d6f938833d1c325ed61525"><code>a0e56f4</code></a> Fix test with 32-bit time_t</li> <li><a href="https://github.com/python-attrs/cattrs/commit/bc9432e606177fe10aa3d2d11e715970c92526be"><code>bc9432e</code></a> Documentation tweaks</li> <li><a href="https://github.com/python-attrs/cattrs/commit/6260c58aa185200a08c76ecc99a941a26a93eeb8"><code>6260c58</code></a> Rename gen.make_dict_unstructure_fn.omit_if_default</li> <li><a href="https://github.com/python-attrs/cattrs/commit/bb4383c2d97aae0e8a01db64f142d07350861a17"><code>bb4383c</code></a> Remove walrus</li> <li><a href="https://github.com/python-attrs/cattrs/commit/81d7756541129a73b82f076b860d61c550296666"><code>81d7756</code></a> Clean up test</li> <li><a href="https://github.com/python-attrs/cattrs/commit/de16200c3d02d259d04960ab466f49fcf8fa47a4"><code>de16200</code></a> Fix preconf string Enum keys</li> <li><a href="https://github.com/python-attrs/cattrs/commit/077c9ea8521372f706346f1f39101db716ca3089"><code>077c9ea</code></a> CI tweak</li> <li><a href="https://github.com/python-attrs/cattrs/commit/3ad74d4456c19598e7278deef62e3af85eabc99d"><code>3ad74d4</code></a> setup.cfg B gone</li> <li>Additional commits viewable in <a href="https://github.com/python-attrs/cattrs/compare/v1.8.0...v1.10.0">compare view</a></li> </ul> </details> <br /> Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details>

…2 in /packages/@jsii/python-runtime (#3470) Updates the requirements on [cattrs](https://github.com/python-attrs/cattrs) to permit the latest version. <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/python-attrs/cattrs/blob/main/HISTORY.rst">cattrs's changelog</a>.</em></p> <blockquote> <h2>22.1.0 (2022-04-03)</h2> <ul> <li>cattrs now uses the CalVer versioning convention.</li> <li>cattrs now has a detailed validation mode, which is enabled by default. Learn more <code>here <https://cattrs.readthedocs.io/en/latest/validation.html></code>_. The old behavior can be restored by creating the converter with <code>detailed_validation=False</code>.</li> <li><code>attrs</code> and dataclass structuring is now ~25% faster.</li> <li>Fix an issue structuring bare <code>typing.List</code> s on Pythons lower than 3.9. (<code>[#209](python-attrs/cattrs#209) <https://github.com/python-attrs/cattrs/issues/209></code>_)</li> <li>Fix structuring of non-parametrized containers like <code>list/dict/...</code> on Pythons lower than 3.9. (<code>[#218](python-attrs/cattrs#218) <https://github.com/python-attrs/cattrs/issues/218></code>_)</li> <li>Fix structuring bare <code>typing.Tuple</code> on Pythons lower than 3.9. (<code>[#218](python-attrs/cattrs#218) <https://github.com/python-attrs/cattrs/issues/218></code>_)</li> <li>Fix a wrong <code>AttributeError</code> of an missing <code>__parameters__</code> attribute. This could happen when inheriting certain generic classes – for example <code>typing.*</code> classes are affected. (<code>[#217](python-attrs/cattrs#217) <https://github.com/python-attrs/cattrs/issues/217></code>_)</li> <li>Fix structuring of <code>enum.Enum</code> instances in <code>typing.Literal</code> types. (<code>[#231](python-attrs/cattrs#231) <https://github.com/python-attrs/cattrs/pull/231></code>_)</li> <li>Fix unstructuring all tuples - unannotated, variable-length, homogenous and heterogenous - to <code>list</code>. (<code>[#226](python-attrs/cattrs#226) <https://github.com/python-attrs/cattrs/issues/226></code>_)</li> <li>For <code>forbid_extra_keys</code> raise custom <code>ForbiddenExtraKeyError</code> instead of generic <code>Exception</code>. (<code>[#225](python-attrs/cattrs#225) <https://github.com/python-attrs/cattrs/pull/225></code>_)</li> <li>All preconf converters now support <code>loads</code> and <code>dumps</code> directly. See an example <code>here <https://cattrs.readthedocs.io/en/latest/preconf.html></code>_.</li> <li>Fix mappings with byte keys for the orjson, bson and tomlkit converters. (<code>[#241](python-attrs/cattrs#241) <https://github.com/python-attrs/cattrs/issues/241></code>_)</li> </ul> <h2>1.10.0 (2022-01-04)</h2> <ul> <li>Add PEP 563 (string annotations) support for dataclasses. (<code>[#195](python-attrs/cattrs#195) <https://github.com/python-attrs/cattrs/issues/195></code>_)</li> <li>Fix handling of dictionaries with string Enum keys for bson, orjson, and tomlkit.</li> <li>Rename the <code>cattr.gen.make_dict_unstructure_fn.omit_if_default</code> parameter to <code>_cattrs_omit_if_default</code>, for consistency. The <code>omit_if_default</code> parameters to <code>GenConverter</code> and <code>override</code> are unchanged.</li> <li>Following the changes in <code>attrs</code> 21.3.0, add a <code>cattrs</code> package mirroring the existing <code>cattr</code> package. Both package names may be used as desired, and the <code>cattr</code> package isn't going away.</li> </ul> <h2>1.9.0 (2021-12-06)</h2> <ul> <li>Python 3.10 support, including support for the new union syntax (<code>A | B</code> vs <code>Union[A, B]</code>).</li> <li>The <code>GenConverter</code> can now properly structure generic classes with generic collection fields. (<code>[#149](python-attrs/cattrs#149) <https://github.com/python-attrs/cattrs/issues/149></code>_)</li> <li><code>omit=True</code> now also affects generated structuring functions. (<code>[#166](python-attrs/cattrs#166) <https://github.com/python-attrs/cattrs/issues/166></code>_)</li> <li><code>cattr.gen.{make_dict_structure_fn, make_dict_unstructure_fn}</code> now resolve type annotations automatically when PEP 563 is used. (<code>[#169](python-attrs/cattrs#169) <https://github.com/python-attrs/cattrs/issues/169></code>_)</li> <li>Protocols are now unstructured as their runtime types. (<code>[#177](python-attrs/cattrs#177) <https://github.com/python-attrs/cattrs/pull/177></code>_)</li> <li>Fix an issue generating structuring functions with renaming and <code>_cattrs_forbid_extra_keys=True</code>. (<code>[#190](python-attrs/cattrs#190) <https://github.com/python-attrs/cattrs/issues/190></code>_)</li> </ul> <h2>1.8.0 (2021-08-13)</h2> <ul> <li>Fix <code>GenConverter</code> mapping structuring for unannotated dicts on Python 3.8.</li> </ul> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li>See full diff in <a href="https://github.com/python-attrs/cattrs/commits">compare view</a></li> </ul> </details> <br /> Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details>

Emit new package-related properties in generated C# project file.

1af3741

mpiroc requested review from RomainMuller, costleya and eladb August 9, 2018 22:16

Fix test expectations.

2bd4319

eladb reviewed Aug 10, 2018

View reviewed changes

Address feedback from code review, and allow dotnet packages to have …

19f9ef8

…different names than their root namespaces.

costleya reviewed Aug 11, 2018

View reviewed changes

mpiroc added 2 commits August 13, 2018 14:26

Restore accidentally deleted file.

4ca58e5

Merge branch 'master' into pirocchi/metadata

a350715

Update README for dotnet target spec changes.

e4a0611

eladb approved these changes Aug 14, 2018

View reviewed changes

mpiroc added 2 commits August 14, 2018 10:56

Update README based on PR feedback.

aae26fd

Merge remote-tracking branch 'origin/master' into pirocchi/metadata

369b6d1

eladb approved these changes Aug 14, 2018

View reviewed changes

mpiroc added 3 commits August 14, 2018 17:51

Merge branch 'master' into pirocchi/metadata and fix conflicts.

1939577

Update test expectations.

6d2f1d1

Merge remote-tracking branch 'origin/master' into pirocchi/metadata

b1ed6d8

mpiroc merged commit fd424ee into master Aug 15, 2018

rix0rrr deleted the pirocchi/metadata branch August 21, 2018 13:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Emit new package-related properties in generated C# project file. #169

Emit new package-related properties in generated C# project file. #169

mpiroc commented Aug 9, 2018

mpiroc commented Aug 9, 2018

eladb Aug 10, 2018

mpiroc Aug 11, 2018

eladb Aug 10, 2018

mpiroc Aug 10, 2018

mpiroc Aug 11, 2018

eladb Aug 10, 2018

mpiroc Aug 10, 2018

mpiroc Aug 11, 2018

costleya Aug 11, 2018

mpiroc Aug 13, 2018

costleya Aug 11, 2018

mpiroc Aug 13, 2018

costleya left a comment

eladb commented Aug 12, 2018 •

edited

Loading

eladb commented Aug 13, 2018

mpiroc commented Aug 13, 2018

eladb Aug 14, 2018

mpiroc Aug 14, 2018

eladb Aug 14, 2018

mpiroc Aug 14, 2018

eladb Aug 14, 2018

mpiroc Aug 14, 2018

eladb Aug 14, 2018

mpiroc Aug 14, 2018

		@@ -265,7 +267,15 @@ The following targets are currently supported:
		```json

Emit new package-related properties in generated C# project file. #169

Emit new package-related properties in generated C# project file. #169

Conversation

mpiroc commented Aug 9, 2018

mpiroc commented Aug 9, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

costleya left a comment

Choose a reason for hiding this comment

eladb commented Aug 12, 2018 • edited Loading

eladb commented Aug 13, 2018

mpiroc commented Aug 13, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eladb commented Aug 12, 2018 •

edited

Loading