Skip to content

normalize-yaml: Prepare for NPM publish#8654

Merged
aduth merged 3 commits intomainfrom
aduth-prepare-normalize-yaml-publish
Jun 30, 2023
Merged

normalize-yaml: Prepare for NPM publish#8654
aduth merged 3 commits intomainfrom
aduth-prepare-normalize-yaml-publish

Conversation

@aduth
Copy link
Contributor

@aduth aduth commented Jun 23, 2023

🛠 Summary of changes

Adds details to the @18f/identity-normalize-yaml package to prepare for publish to NPM:

  • Add README.md
  • Add package.json details
  • Update dependencies to latest
  • Reorganize dependencies for optimal peer dependency usage

Why?

  • So that it can be used in other Login.gov projects, e.g. identity-site

📜 Testing Plan

There should be no impact on the IdP usage.

You could test that npm publish --dry-run outputs the expected result for a published artifact.

Copy link
Contributor

@zachmargolis zachmargolis left a comment

Choose a reason for hiding this comment

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

LGTM

@aduth
Copy link
Contributor Author

aduth commented Jun 23, 2023

Something we should figure out how to do is get TypeScript types (.d.ts files) included as part of publishing these.

@aduth aduth force-pushed the aduth-prepare-normalize-yaml-publish branch from 048949d to 3f5e904 Compare June 27, 2023 15:19
@aduth
Copy link
Contributor Author

aduth commented Jun 27, 2023

I gave this a quick try in identity-site before publishing (using npm link) and it seems to work as expected, including TypeScript types.

It might be nice to support glob patterns as an argument vs. the current brace expansion / explicit paths approach, but fine to save that for a future enhancement.

@aduth aduth force-pushed the aduth-prepare-normalize-yaml-publish branch from 3f5e904 to a4f4682 Compare June 28, 2023 18:32
aduth added 3 commits June 30, 2023 08:33
changelog: Internal, JavaScript Packages, Publish normalize-yaml package to NPM
@aduth aduth force-pushed the aduth-prepare-normalize-yaml-publish branch from a4f4682 to 14400c9 Compare June 30, 2023 12:33
@aduth aduth merged commit 2ced43f into main Jun 30, 2023
@aduth aduth deleted the aduth-prepare-normalize-yaml-publish branch June 30, 2023 12:57
@aduth
Copy link
Contributor Author

aduth commented Jun 30, 2023


- Alphabetizes keys.
- Applies improved punctuation.
- Converts straight quotes `"` and `'` to smart quotes `“`, `”`, and `’`
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Of course I'm realizing after publishing that this should have included the left form of the single smart quote 🤦

Suggested change
- Converts straight quotes `"` and `'` to smart quotes ``, ``, and ``
- Converts straight quotes `"` and `'` to smart quotes ``, ``, ``, and ``

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants