chore(aws-cdk-lib): two import styles confuse Rosetta#17588
Merged
mergify[bot] merged 6 commits intomasterfrom Nov 19, 2021
Merged
chore(aws-cdk-lib): two import styles confuse Rosetta#17588mergify[bot] merged 6 commits intomasterfrom
mergify[bot] merged 6 commits intomasterfrom
Conversation
We currently allow two different import styles for our monopackage:
```ts
import { aws_ec2 } from 'aws-cdk-lib';
import * as aws_ec2 from 'aws-cdk-lib/aws-ec2';
```
However, the way this is currently implemented breaks the source
analysis performed by Rosetta on examples. Rosetta will only be
able to trace the first of these to the submodule that is being
imported. The second style actually is a completely different JavaScript
file that "represents" the export, and the tracing will break.
Today these resolve to:
```
import { aws_ec2 } from "aws-cdk-lib";
------> aws-cdk-lib/lib/aws-ec2/index.ts
import * as aws_ec2 from "aws-cdk-lib/aws-ec2";
------> aws-cdk-lib/aws-ec2.ts
```
This PR changes the layout of the package generated by `ubergen` to have
the submodule directories at the root, so that the imports resolve the
same:
```ts
// aws-cdk-lib/index.ts
export * as aws_ec2 from './aws-ec2';
// aws-cdk-lib/aws-ec2/index.ts
module_contents_here();
```
0d91787 to
70881e9
Compare
RomainMuller
approved these changes
Nov 19, 2021
Contributor
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
Collaborator
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
Contributor
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
TikiTDO
pushed a commit
to TikiTDO/aws-cdk
that referenced
this pull request
Feb 21, 2022
We currently allow two different import styles for our monopackage:
```ts
import { aws_ec2 } from 'aws-cdk-lib';
import * as aws_ec2 from 'aws-cdk-lib/aws-ec2';
```
However, the way this is currently implemented breaks the source
analysis performed by Rosetta on examples. Rosetta will only be
able to trace the first of these to the submodule that is being
imported. The second style actually is a completely different JavaScript
file that "represents" the export, and the tracing will break.
Today these resolve to:
```
import { aws_ec2 } from "aws-cdk-lib";
------> aws-cdk-lib/lib/aws-ec2/index.ts
import * as aws_ec2 from "aws-cdk-lib/aws-ec2";
------> aws-cdk-lib/aws-ec2.ts
```
This PR changes the layout of the package generated by `ubergen` to have
the submodule directories at the root, so that the imports resolve the
same:
```ts
// aws-cdk-lib/index.ts
export * as aws_ec2 from './aws-ec2';
// aws-cdk-lib/aws-ec2/index.ts
module_contents_here();
```
This means we now collect all submodules into the *root* of `aws-cdk-lib` and `monocdk`, instead of into
the `lib` subdirectory. It makes the gitignore config slightly different from the ones we usually have (but arguably better).
----
*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
We currently allow two different import styles for our monopackage:
However, the way this is currently implemented breaks the source
analysis performed by Rosetta on examples. Rosetta will only be
able to trace the first of these to the submodule that is being
imported. The second style actually is a completely different JavaScript
file that "represents" the export, and the tracing will break.
Today these resolve to:
This PR changes the layout of the package generated by
ubergento havethe submodule directories at the root, so that the imports resolve the
same:
This means we now collect all submodules into the root of
aws-cdk-libandmonocdk, instead of intothe
libsubdirectory. It makes the gitignore config slightly different from the ones we usually have (but arguably better).By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license