(done) Next Major 2.0 Release Roadmap

[ghiscoding]

Planned for Next Major Release

List of upcoming changes

Just opening this discussion to keep track of possible future improvement, for example when Node 14 is EOL (Apr. 2023) as shown in first list item below:

• 1. use node: import prefix for Node libs as ESM, ref Node GitHub issue, for example (rollback PR fix(version): Node14, import from "fs" instead of "node:fs", fixes #260 #261 and apply other changes)
  • other package that can use node: protocol are (node:assert, node:fs, node:path, node:stream, node:os, node:util, node:url, ...)
• 2. remove all usage of require() and replace them with import (or await import()) to be ESM ready
  • for the ones that are too hard to replace with async imports, we can probably use createRequire
    • need to review GHE dynamic imports, it might need await import
• 3. __dirname was also replaced by import.meta.url with ESM but that only works with very latest version of Node >=14.18.3 (which is higher than current requirement) or Node 16, probably better to wait on the next Node major release after Node14 EOL - April 2023
  • https://stackoverflow.com/a/55944697
• 4. deprecate Node 14 with next major version, we should also increase minimum version to Node >= 16.15.0 and npm >= 8.5.0
  • revisit this version note about npm version required for the --sync-workspace-lock flag and remove npm shrinkwrap in update-lockfile-version.ts
  • remove all previously deprecated Lerna command options/flags (search for text "remove in next major release")
    • some of them are displayed here
  • bump TS build target to newer ES2020 or ES2021
  • replace "module": "commonjs" with "module": "bundler"
• 5. make the lib compatible with ESM only dependencies
  • also remove them from Renovate config exceptions list
  • migrate from Jest to Vitest for better ESM support in unit tests
  • conventional commits presets need to be verified after ESM change
• 6. eventually remove --no-workspace-strict-match flag from publish readme doc
  • it might be better to start by adding a warning to not use it and add it to deprecated options in their respective readme
• 7. convert all JS files to TS (even mocks & fixtures)
• 8. remove "os" dependency from any package.json since it is now a NodeJS core package
• 9. possibly rename git-dry-run and cmd-dry-run to the simpler dry-run
  • now deprecated, to be removed in next major release
• 10. make version and publish commands as optional packages as well, ref issue Make the @lerna-lite/version and @lerna-lite/publish dependencies optional #450
  • also update homepage & CLI readme optional command list
• 11. rename and split optional-cmd-common into 2 new packages (filter-packages & profiler)
• 12. cleanup temp files on exit (option 1 option 2, option 3)
  • currently implemented as opt-in, it might be better to switch it to be the default in future version keep it as opt-in since some users are using it in CI
• 13. remove lerna info since I don't think anyone ever used it and it can be replaced by a simple npx envinfo command
• 14. remove "(new)" label from all options
• 15. upgrade pnpm and minimatch to v8, delay upgrade since it requires Node >=16
  • will delay pnpm v8 after our official 2.0 release
• 16. use fs-extra/esm for ESM imports
• 17. change all istanbul ignore comments to c8 ignore (see Vitest coverage ignore)
• 18. add external conventional-commits config and test with/without in dry-run mode
• 19. deprecate unused version option --changelog-version-message-msg
• 20. global types not detected, might be better to disable global Vitest types
• 21. types aren't working in spec files
• 22. add Node 19 to list of environment to test against in CI
  • probably to review when Node 20 goes out at the end of April
• 23. create a version1 branch before merging next into main
• 24. remove optional useNx from run command
  • actually added it back since it's used by some, I might revisit in the next major though
• 25. move listable CLI options directly into the CLI package to avoid extra deps in CLI
• 26. release 2.0.0-alpha version from next branch
  • first alpha release is out, see v2.0.0-alpha.2

References

• What does it take to support Node.js ESM?
• Pure ESM package

List of associated PRs

• the work has started on the next major 2.0 release with the following PRs so far:
  • PR feat(build)!: migrate to ESM build & switch to Vitest for ESM support #537
  • PR chore: update Vitest snapshot to temporarily proceed with migration #538
  • PR chore: use node: imports and fs-extra/esm import #539
  • PR chore(version): remove sync lock support for npm version below 8.5.0 #540
  • PR chore(publish): remove deprecated --no-workspace-strict-match option #541
  • PR feat(publish): remove --require-scripts, keep npm scripts lifecycle #542
  • PR feat(version): remove deprecated --changelog-version-message option #543
  • PR chore: change all istanbul ignores to c8 ignores #544
  • PR feat: remove all deprecated options tagged to be removed in next major #545
  • PR feat(version): use await import instead of require() for GHE release #546
  • PR fix: all TS Types problems in all unit test spec files & make sure no helpers are published #549
  • PR fix(deps): update dependency minimatch to v8 and couple other deps patch #550
  • PR chore: add Node 19 to list of testing environment #551
  • PR feat(publish)!: make version & publish commands optionnal, closes #450 #552
  • PR feat(cli): remove listable dependency from CLI #553
  • PR feat(run)!: remove --use-nx (powered by Nx) option from run command #554
  • PR feat(version): add --skip-bump-only-release to avoid empty gh releases #555
  • PR feat(run): add back optional --use-nx option to run command #557