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

chore: expose node-bundle options via CLI #32475

Merged
merged 4 commits into from
Dec 11, 2024
Merged

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented Dec 11, 2024

Add two options that were not being exposed via the CLI:

  • minifyWhitespace
  • Packing target

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

Add two options that were not being exposed via the CLI:

- `minifyWhitespace`
- Packing `target`
@rix0rrr rix0rrr requested a review from a team December 11, 2024 14:33
@aws-cdk-automation aws-cdk-automation requested a review from a team December 11, 2024 14:33
@github-actions github-actions bot added the p2 label Dec 11, 2024
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Dec 11, 2024
@@ -16,6 +16,8 @@ export async function cliMain(cliArgs: string[]) {
.option('resource', { type: 'array', nargs: 1, default: [], desc: 'List of resources that need to be explicitly copied to the bundle (example: node_modules/proxy-agent/contextify.js:bin/contextify.js)' })
.option('dont-attribute', { type: 'string', desc: 'Dependencies matching this regular expressions wont be added to the notice file' })
.option('test', { type: 'string', desc: 'Validation command to sanity test the bundle after its created' })
.option('minify-whitespace', { type: 'boolean', default: false, desc: 'Minify whitespace' })
.option('pack-destination', { type: 'string', desc: 'Directory to write the tarball to', nargs: 1, requiresArg: true })
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we put this as an option of the pack command instead of global?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yeah, I thought we weren't doing that but I should have looked better.

*
* @default '.'
*/
readonly packDestination?: string;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this needed?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not.

.command('validate', 'Validate the package is ready for bundling', args => args
.option('fix', { type: 'boolean', default: false, alias: 'f', desc: 'Fix any fixable violations' }),
)
.command('write', 'Write the bundled version of the project to a temp directory')
.command('pack', 'Write the bundle and create the tarball')
.command('pack', 'Write the bundle and create the tarball', args => args
.option('pack-destination', { type: 'string', desc: 'Directory to write the tarball to', nargs: 1, requiresArg: true })
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.option('pack-destination', { type: 'string', desc: 'Directory to write the tarball to', nargs: 1, requiresArg: true })
.option('destination', { type: 'string', desc: 'Directory to write the tarball to', nargs: 1, requiresArg: true })

or better yet, to align with the name in the API.

Suggested change
.option('pack-destination', { type: 'string', desc: 'Directory to write the tarball to', nargs: 1, requiresArg: true })
.option('target', { type: 'string', desc: 'Directory to write the tarball to', nargs: 1, requiresArg: true })

But lets remove the redundant pack from there.

Copy link

codecov bot commented Dec 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.66%. Comparing base (c208789) to head (38e31eb).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #32475   +/-   ##
=======================================
  Coverage   78.66%   78.66%           
=======================================
  Files         107      107           
  Lines        7237     7237           
  Branches     1329     1329           
=======================================
  Hits         5693     5693           
  Misses       1358     1358           
  Partials      186      186           
Flag Coverage Δ
suite.unit 78.66% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
packages/aws-cdk 78.66% <ø> (ø)

Copy link
Contributor

mergify bot commented Dec 11, 2024

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 38e31eb
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify mergify bot merged commit 0f5fe9a into main Dec 11, 2024
17 checks passed
Copy link
Contributor

mergify bot commented Dec 11, 2024

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot deleted the huijbers/node-bundle-options branch December 11, 2024 16:03
Copy link

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 11, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
contribution/core This is a PR that came from AWS. p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants