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(maintenance): cleaned up package.json files #1504

Merged
merged 14 commits into from
Jun 16, 2023
Merged

chore(maintenance): cleaned up package.json files #1504

merged 14 commits into from
Jun 16, 2023

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

The PR make some light changes to the scripts section of the various package.json files of the project. The main goal of these changes is to remove unused or redundant commands while also making it so that when they are published the files contain only the info strictly necessary. In doing so, the PR also should fix the issue causing the README.md file of the Parameters utility to be missing.

List of changes

  • Removed the prepare script, the script was used to run npm run build before packaging the utilities, however this script also runs when installing which caused issues when running npm ci (which required the --foreground-scripts flag) due to the project being a monorepo written in TS.
  • Added a prebuild script that is run before executing npm run build. The script removes any existing ./lib folder so that each build (especially local) is clean.
  • Added a prepack script to run a custom script that removes unused fields from the package.json file before packing & publishing an utility to npm, the script also applies the -alpha or -beta suffix to relevant utilities.
  • Removed scripts related to measuring the package size, we might reintroduce a different version of this in the future.
  • Removed the build scripts from the examples since each example has build commands related to SAM or CDK.
  • Added exports to the package.json file of the Parameters utility, a follow up PR will reorganize the package structure.
  • Aligned the version of the Idempotency utility to the rest of the workspaces, marked the package as private so that it's not published, and added it to the Lerna config.

Related issues, RFCs

Issue number: #1492

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my change is effective and works
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@dreamorosi dreamorosi self-assigned this Jun 15, 2023
@boring-cyborg boring-cyborg bot added automation This item relates to automation documentation Improvements or additions to documentation dependencies Changes that touch dependencies, e.g. Dependabot, etc. internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) labels Jun 15, 2023
@pull-request-size pull-request-size bot added the size/L PRs between 100-499 LOC label Jun 15, 2023
@dreamorosi dreamorosi changed the title chore(build): cleaned up package.json files chore(maintenance): cleaned up package.json files Jun 15, 2023
@dreamorosi dreamorosi merged commit bc5d35b into main Jun 16, 2023
@dreamorosi dreamorosi deleted the issue1492 branch June 16, 2023 00:20
@dreamorosi dreamorosi linked an issue Jun 16, 2023 that may be closed by this pull request
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation This item relates to automation dependencies Changes that touch dependencies, e.g. Dependabot, etc. documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) size/L PRs between 100-499 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Maintenance: add README to Parameters utility published on npm
1 participant