Json to es #1575
Json to es #1575
Conversation
🦋 Changeset detectedLatest commit: 42e2cae The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
packages/react/package.json
Outdated
| @@ -12,6 +12,10 @@ | |||
| "import": "./dist/esm/internal.js", | |||
| "require": "./dist/internal.js" | |||
| }, | |||
| "./internal/primitive": { | |||
There was a problem hiding this comment.
| "./internal/primitive": { | |
| "./internal/primitives-catalog": { |
There was a problem hiding this comment.
Should we be consistent with primitive though I agree this name is better? The json version used by studio is named primitive. I think a new name will cause confusion but they are the same in different forms.
packages/react/package.json
Outdated
| @@ -12,6 +12,10 @@ | |||
| "import": "./dist/esm/internal.js", | |||
| "require": "./dist/internal.js" | |||
| }, | |||
| "./internal/primitive": { | |||
| "import": "./dist/esm/primitive.js", | |||
There was a problem hiding this comment.
| "import": "./dist/esm/primitive.js", | |
| "import": "./dist/esm/primitives-catalog.js", |
| * import { PrimitiveCatalog } from '@aws-amplify/ui-react/internal/primitive' | ||
| */ | ||
| const exportString = `export const PrimitiveCatalog = ${jsonString}; | ||
| export default PrimitiveCatalog;`; |
There was a problem hiding this comment.
Should we use a named export to stay consistent with the rest of the repo?
| export default PrimitiveCatalog;`; | |
| export { PrimitiveCatalog }`; |
| 'dist/esm', | ||
| 'primitives-catalog.js' | ||
| ); | ||
| fs.writeFileSync(JSONoutputPath, jsonString); |
There was a problem hiding this comment.
Continuing to create the JSON version so that this isn't a breaking change for studio, will remove this export once studio has had a chance to migrate over to the new export.
| @@ -12,6 +12,10 @@ | |||
| "import": "./dist/esm/internal.js", | |||
| "require": "./dist/internal.js" | |||
| }, | |||
| "./internal/primitives-catalog": { | |||
| "import": "./dist/esm/primitives-catalog.js", | |||
| "default": null | |||
There was a problem hiding this comment.
Do we have a plan to add CJS export in the future? It is a dual(ESM/CJS) package. This seems deviating from the goal
There was a problem hiding this comment.
I don't know of any plans to add a CJS export as this is an internal package only being used by studio we would do one if they ever needed it, but I'm not sure if there are any plans otherwise. That being said I could add a CJS export for consistency if that is what we agree should happen.
There was a problem hiding this comment.
Ok, that makes sense. CJS is not a must
Description of changes
Add a new es module export of PrimitiveCatalog to the
/internal/primitives-catalogsubpath.Checklist
yarn testpassesBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.