Rebrand to Hypermod and remove in-repo website; update docs links and package READMEs#256
Conversation
|
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 7414b71876
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| Downloading and running codemods as well as initialising and maintaining codemod packages can all be done via the Hypermod CLI (`@hypermod/cli`). | ||
| ```bash | ||
| npx @hypermod/cli --packages react@18.0.0 ./src |
There was a problem hiding this comment.
Replace the React version example with a runnable command
The new quick-start example --packages react@18.0.0 will fail in this CLI: packages/cli/src/resolvers/npm.ts:49-60 rejects any version that is not present in config.transforms, and community/react/src/hypermod.config.js:1-16 exposes no versioned transforms for react at all (only presets). As written, a user following the first README command will get an "Unable to resolve version 18.0.0" error instead of a successful migration.
Useful? React with 👍 / 👎.
Motivation
https://www.hypermod.io/.Description
README.mdto present the Hypermod product, add CLI usage examples, and link tohttps://www.hypermod.io/and related resources.packages/cli/README.md,packages/cli-alias/README.md,packages/initializer/template/README.md,packages/utils/README.md) to replace old CodeshiftCommunity links with the Hypermod URLs and refreshed instructions/examples.codeshiftcommunitydoc links withhttps://www.hypermod.io/docs) without changing transformation logic.website/content and thescripts/docs.tsdoc-generation script, and removed website-related npm scripts frompackage.json.Testing
yarn lint(ESLint) against the modified README and package README files and confirmed there were no new lint errors after the changes; the run completed successfully.yarn test(Jest) for the repository test suite to ensure no regressions in unit tests and observed successful test completion.Codex Task