-
Notifications
You must be signed in to change notification settings - Fork 276
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
[Focused Improvement] Consolidate packages #824
Conversation
- media to it's own folder - various files into utils folder - graphql-request-client into graphql folder - rename testData -> test-data
- update dependencies in nextjs package and sample - TODO: update dependies in remaining samples
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/sitecore-jss/edge-e2e-styleguide/GBXoHizdFgjhqeRPwutqL2Lt6Vby [Deployment for 8129389 failed] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well done!
- I would propose you to introduce
path aliases
usingtsconfig
Currently, we reference one package from another, and insitecore-jss-dev-tools
you can see that you added a lot of long paths like../../../../index
etc.
https://www.typescriptlang.org/docs/handbook/module-resolution.html#path-mapping
https://dev.to/larswaechter/path-aliases-with-typescript-in-nodejs-4353 - For customer it has breaking changes, they still will use separate packages in the sample. It should be documented in release notes as a breaking change
- I think we need to move
typings - packages/sitecore-jss-dev-tools/src/manifest/typings.d.ts
undersrc
folder, so it should be at the root of the package.
packages/sitecore-jss-dev-tools/src/manifest/generator/pipelines/generateMedia/utils.ts
Outdated
Show resolved
Hide resolved
packages/sitecore-jss-dev-tools/src/manifest/generator/pipelines/generateMedia/utils.ts
Outdated
Show resolved
Hide resolved
...ges/sitecore-jss-dev-tools/src/manifest/testData/components/folder0/component0-0.sitecore.ts
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See specific comments. Overall looks great!
...tecore-jss-dev-tools/src/manifest/generator/pipelines/generateContentItem/pipeline.config.ts
Outdated
Show resolved
Hide resolved
b66bf9e
to
f5e5dda
Compare
packages/sitecore-jss-dev-tools/src/manifest/testData/components/Welcome.sitecore.ts
Outdated
Show resolved
Hide resolved
packages/sitecore-jss-dev-tools/src/manifest/testData/components/component0.sitecore.ts
Outdated
Show resolved
Hide resolved
packages/sitecore-jss-dev-tools/src/manifest/testData/content/content.sitecore.ts
Outdated
Show resolved
Hide resolved
packages/sitecore-jss-nextjs/src/middleware/editing-render-middleware.test.ts
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved 👍👍
Consolidate manifest and pipeline packages into dev-tools
Description / Motivation
To be able to maintain all the packages in a easier way in future.
--> Changes made
Package name = Sitecore.jss : Organized files into sub-modules
- graphql = no change
- i18 = no change
- layout = no change
- media = new
- testData = no change
- tracking
before: separate individual package
now: submodule in base package
- utils = moved all loosely left related files to this submodule.
Package name = Sitecore-jss-angular : Changed package.json
Package name = Sitecore-jss-angular-schematics : No change
Package name = Sitecore-jss-cli : No change
Package name = Sitecore-jss-dev-tools : Moved manifest, pipelines and update package into this package
before: separate individual package
now: part of this package
before: separate individual package
now: part of this package
before: separate individual package
now: part of this package
Package name = Sitecore-jss-forms : No change
Package name = Sitecore-jss-nextjs :
Package name = Sitecore-jss-proxy : No change
Package name = Sitecore-jss-react :
Package name = Sitecore-jss-react-forms : No change
Package name = Sitecore-jss-native : No Change
Package name = Sitecore-jss-hosts : No change
Package name = Sitecore-jss-vue :
--> Sample Apps
Testing Details
Types of changes
/docs
directory)