chore: rewrite imports in READMEs for aws-cdk-lib#14255
Merged
mergify[bot] merged 3 commits intomasterfrom Apr 20, 2021
Merged
Conversation
For the v2 (aws-cdk-lib) docs, the imports scattered throughout the READMEs need
to be re-written. We could hand-edit all of the READMEs on the v2-main branch,
but this is not an ongoing mechanism and may also introduce forward-merge pain.
Instead, we're going to take the cheap option of rewriting the import statements
as part of `ubergen` when building the `aws-cdk-lib` package.
I aimed to capture as many import types as I found in the live READMEs.
As an example, the code transforms these imports as seen below:
```ts
// BEFORE
import * as cdk from '@aws-cdk/core';
import * as cloudfront from '@aws-cdk/aws-cloudfront';
import codeartifact = require('@aws-cdk/aws-codeartifact');
import { VpcEndpointServiceDomainName } from '@aws-cdk/aws-route53';
import { Construct, Stage, Stack, StackProps, StageProps } from '@aws-cdk/core';
// AFTER
import * as cdk from 'aws-cdk-lib';
import { aws_cloudfront as cloudfront } from 'aws-cdk-lib';
import { aws_codeartifact as codeartifact } from 'aws-cdk-lib';
import { VpcEndpointServiceDomainName } from 'aws-cdk-lib/aws-route53';
import { Construct, Stage, Stack, StackProps, StageProps } from 'aws-cdk-lib';
```
|
|
nija-at
approved these changes
Apr 19, 2021
Contributor
|
PR could do with a motivation not to use the |
Contributor
I was going to ask about this too. |
Contributor
Author
Simplicity and laziness. To reuse |
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). |
njlynch
added a commit
that referenced
this pull request
Apr 21, 2021
Imports in READMEs are now rewritten from '@aws-cdk/...' to 'aws-cdk-lib'. This change was introduced in #14255, but no validation was included in the original PR. This change introduces a post-build validation step for aws-cdk-lib to ensure that the module rewrites were properly done.
njlynch
added a commit
that referenced
this pull request
Apr 22, 2021
Imports in READMEs are now rewritten from '@aws-cdk/...' to 'aws-cdk-lib'. This change was introduced in #14255, but no validation was included in the original PR. This change introduces a post-build validation step for aws-cdk-lib to ensure that the module rewrites were properly done.
mergify bot
pushed a commit
that referenced
this pull request
Apr 22, 2021
…#14302) Imports in READMEs are now rewritten from '@aws-cdk/...' to 'aws-cdk-lib'. This change was introduced in #14255, but no validation was included in the original PR. This change introduces a post-build validation step for aws-cdk-lib to ensure that the module rewrites were properly done. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
njlynch
added a commit
that referenced
this pull request
Apr 26, 2021
For the v2 (aws-cdk-lib) docs, the imports scattered throughout the READMEs need
to be re-written. We could hand-edit all of the READMEs on the v2-main branch,
but this is not an ongoing mechanism and may also introduce forward-merge pain.
Instead, we're going to take the cheap option of rewriting the import statements
as part of `ubergen` when building the `aws-cdk-lib` package.
I aimed to capture as many import types as I found in the live READMEs.
As an example, the code transforms these imports as seen below:
```ts
// BEFORE
import * as cdk from '@aws-cdk/core';
import * as cloudfront from '@aws-cdk/aws-cloudfront';
import codeartifact = require('@aws-cdk/aws-codeartifact');
import { VpcEndpointServiceDomainName } from '@aws-cdk/aws-route53';
import { Construct, Stage, Stack, StackProps, StageProps } from '@aws-cdk/core';
// AFTER
import * as cdk from 'aws-cdk-lib';
import { aws_cloudfront as cloudfront } from 'aws-cdk-lib';
import { aws_codeartifact as codeartifact } from 'aws-cdk-lib';
import { VpcEndpointServiceDomainName } from 'aws-cdk-lib/aws-route53';
import { Construct, Stage, Stack, StackProps, StageProps } from 'aws-cdk-lib';
```
Note: Doesn't use the existing `rewrite-imports` method as that would require parsing the Markdown (requiring an extra dependency) and potentially guarding against malformed inputs. This approach was chosen as a simple, pragmatic solution. We can revisit this in the future if necessary.
----
*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
john-tipper
pushed a commit
to john-tipper/aws-cdk
that referenced
this pull request
May 10, 2021
For the v2 (aws-cdk-lib) docs, the imports scattered throughout the READMEs need
to be re-written. We could hand-edit all of the READMEs on the v2-main branch,
but this is not an ongoing mechanism and may also introduce forward-merge pain.
Instead, we're going to take the cheap option of rewriting the import statements
as part of `ubergen` when building the `aws-cdk-lib` package.
I aimed to capture as many import types as I found in the live READMEs.
As an example, the code transforms these imports as seen below:
```ts
// BEFORE
import * as cdk from '@aws-cdk/core';
import * as cloudfront from '@aws-cdk/aws-cloudfront';
import codeartifact = require('@aws-cdk/aws-codeartifact');
import { VpcEndpointServiceDomainName } from '@aws-cdk/aws-route53';
import { Construct, Stage, Stack, StackProps, StageProps } from '@aws-cdk/core';
// AFTER
import * as cdk from 'aws-cdk-lib';
import { aws_cloudfront as cloudfront } from 'aws-cdk-lib';
import { aws_codeartifact as codeartifact } from 'aws-cdk-lib';
import { VpcEndpointServiceDomainName } from 'aws-cdk-lib/aws-route53';
import { Construct, Stage, Stack, StackProps, StageProps } from 'aws-cdk-lib';
```
Note: Doesn't use the existing `rewrite-imports` method as that would require parsing the Markdown (requiring an extra dependency) and potentially guarding against malformed inputs. This approach was chosen as a simple, pragmatic solution. We can revisit this in the future if necessary.
----
*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
john-tipper
pushed a commit
to john-tipper/aws-cdk
that referenced
this pull request
May 10, 2021
…aws#14302) Imports in READMEs are now rewritten from '@aws-cdk/...' to 'aws-cdk-lib'. This change was introduced in aws#14255, but no validation was included in the original PR. This change introduces a post-build validation step for aws-cdk-lib to ensure that the module rewrites were properly done. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
hollanddd
pushed a commit
to hollanddd/aws-cdk
that referenced
this pull request
Aug 26, 2021
For the v2 (aws-cdk-lib) docs, the imports scattered throughout the READMEs need
to be re-written. We could hand-edit all of the READMEs on the v2-main branch,
but this is not an ongoing mechanism and may also introduce forward-merge pain.
Instead, we're going to take the cheap option of rewriting the import statements
as part of `ubergen` when building the `aws-cdk-lib` package.
I aimed to capture as many import types as I found in the live READMEs.
As an example, the code transforms these imports as seen below:
```ts
// BEFORE
import * as cdk from '@aws-cdk/core';
import * as cloudfront from '@aws-cdk/aws-cloudfront';
import codeartifact = require('@aws-cdk/aws-codeartifact');
import { VpcEndpointServiceDomainName } from '@aws-cdk/aws-route53';
import { Construct, Stage, Stack, StackProps, StageProps } from '@aws-cdk/core';
// AFTER
import * as cdk from 'aws-cdk-lib';
import { aws_cloudfront as cloudfront } from 'aws-cdk-lib';
import { aws_codeartifact as codeartifact } from 'aws-cdk-lib';
import { VpcEndpointServiceDomainName } from 'aws-cdk-lib/aws-route53';
import { Construct, Stage, Stack, StackProps, StageProps } from 'aws-cdk-lib';
```
Note: Doesn't use the existing `rewrite-imports` method as that would require parsing the Markdown (requiring an extra dependency) and potentially guarding against malformed inputs. This approach was chosen as a simple, pragmatic solution. We can revisit this in the future if necessary.
----
*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
hollanddd
pushed a commit
to hollanddd/aws-cdk
that referenced
this pull request
Aug 26, 2021
…aws#14302) Imports in READMEs are now rewritten from '@aws-cdk/...' to 'aws-cdk-lib'. This change was introduced in aws#14255, but no validation was included in the original PR. This change introduces a post-build validation step for aws-cdk-lib to ensure that the module rewrites were properly done. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
mergify bot
pushed a commit
that referenced
this pull request
Nov 22, 2021
- Adds `rewriteImports` and helper functions `rewriteReadmeImports` and `rewriteMonoPackageImports` to `aws-cdk-migration` package. - `individual-package-gen` consumes `rewriteReadmeImports` for alpha modules. - `individual-package-gen` treats rosetta fixtures as source files and rewrites imports there as well. - Adds `aws-cdk-migration` as a dependency to `ubergen`. - Refactors `rewriteImports` in `ubergen` to use the API in `aws-cdk-migration`. Has the side affect of removing the string-replace function that was introduced in this [PR](#14255). This changes the readme import style from `import { blah as blah } from 'aws-cdk-lib';` to `import * as blah from 'aws-cdk-lib/blah';`. - fixes error in `cfnspec` that generated invalid import names for L1 module readmes. - fixes bug in `cdk-build` that only executed one `post` command. - fixes `verify-imports` scripts typo introduced previously (that was not caught due to the `cdk-build` bug). ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
mergify bot
pushed a commit
that referenced
this pull request
Nov 22, 2021
- Adds `rewriteImports` and helper functions `rewriteReadmeImports` and `rewriteMonoPackageImports` to `aws-cdk-migration` package. - `individual-package-gen` consumes `rewriteReadmeImports` for alpha modules. - `individual-package-gen` treats rosetta fixtures as source files and rewrites imports there as well. - Adds `aws-cdk-migration` as a dependency to `ubergen`. - Refactors `rewriteImports` in `ubergen` to use the API in `aws-cdk-migration`. Has the side affect of removing the string-replace function that was introduced in this [PR](#14255). This changes the readme import style from `import { blah as blah } from 'aws-cdk-lib';` to `import * as blah from 'aws-cdk-lib/blah';`. - fixes error in `cfnspec` that generated invalid import names for L1 module readmes. - fixes bug in `cdk-build` that only executed one `post` command. - fixes `verify-imports` scripts typo introduced previously (that was not caught due to the `cdk-build` bug). ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license* (cherry picked from commit 66e37cc) # Conflicts: # packages/@aws-cdk/cfnspec/lib/library-creation.ts
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
4 participants
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.
For the v2 (aws-cdk-lib) docs, the imports scattered throughout the READMEs need
to be re-written. We could hand-edit all of the READMEs on the v2-main branch,
but this is not an ongoing mechanism and may also introduce forward-merge pain.
Instead, we're going to take the cheap option of rewriting the import statements
as part of
ubergenwhen building theaws-cdk-libpackage.I aimed to capture as many import types as I found in the live READMEs.
As an example, the code transforms these imports as seen below:
Note: Doesn't use the existing
rewrite-importsmethod as that would require parsing the Markdown (requiring an extra dependency) and potentially guarding against malformed inputs. This approach was chosen as a simple, pragmatic solution. We can revisit this in the future if necessary.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license