vue-storefront icon indicating copy to clipboard operation
vue-storefront copied to clipboard

Published 20 hours ago • verified publisher icon vuestorefront

Upgrade node & yarn engine & dependency configurations, and refactor declarations and related documentation to

Open jaydubb12 opened this issue 4 years ago • 0 comments

What is the motivation for adding / enhancing this feature?

  1. Current documentation, and engine configurations in package.json reference min version of node 10, which is potentially problematic given node 10 was deemed "End of Life" as of April 2021, and given nuxt v2.15.x+ requires a minimum version of node 12 or higher

  2. yarn package manager v1.x+ has entered "maintenance mode" and use of yarn "berry", which is current version 2.4.2 requires use of node15 to overcome the memory allocation issues for users who utilize MacBooks with an M1

  3. Utilization of yarn 2.x+ requires the use of a yarnrc file

  4. Modernize the platform / frameworks to ensure that developers are able to execute development without disruption & make it easier to adopt additional future state features such as "pnp" in the future.

  5. Utilize the incremental benefits of npm 7 and yarn 2 to

  • automate installation of peer dependencies
  • allow for ease of use of workspaces
  • resolve issues with mismatched project and transitive dependencies

What are the acceptance criteria

  1. Set the engine specification in the package.json files to accept a minimum of node 12, but ideally it would be recommended to set the min values at node 15, and npm 7

  2. Provide a base set of yarn plugins, packages and configurations to allow for use of yarn 2.x+

  3. Update platform documentation and command line excerpts to reflect the changes

  4. Release the changes as an explicit release version, and clearly annotate that this release include breaking changes vs continuing the process of merging commits directly to the branch "next"

Version of Vue Storefront

  • [ ] Vue Storefront
  • [X] Vue Storefront Next

Can you complete this feature request by yourself?

  • [X] YES
  • [ ] NO

Additional information

None, will submit a PR in the coming days. Have already completed this work in my local, but would need isolate the changes and revise the documentation to provide a consolidated PR

jaydubb12 avatar Jul 19 '21 13:07 jaydubb12