https://github.com/hypermod-io/hypermod-examples
Example stand-alone Hypermod package
https://github.com/hypermod-io/hypermod-examples
Last synced: 3 months ago
JSON representation
Example stand-alone Hypermod package
- Host: GitHub
- URL: https://github.com/hypermod-io/hypermod-examples
- Owner: hypermod-io
- License: mit
- Created: 2023-05-21T04:14:47.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-10-01T23:14:51.000Z (7 months ago)
- Last Synced: 2025-10-02T01:14:32.314Z (7 months ago)
- Language: TypeScript
- Homepage:
- Size: 104 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hypermod Examples
This project was bootstrapped with [Hypermod](https://www.codeshiftcommunity.com/).
Please see the [external packages guide](https://www.codeshiftcommunity.com/docs/external-packages) for more information on how to work with this repo.
## Scripts
### `npm run dev`
Runs the Hypermod CLI useful for testing transform files as if they have been published
**example:** `npm run dev -t codemods/10.0.0/transform.ts`
Alternatively, you can run `npm run dev` to see an interactive list of codemods to choose from.
See the [cli reference](https://www.codeshiftcommunity.com/docs/cli) for more information.
### `npm run test`
Launches the test runner in interactive watch mode.
See the [testing guide](https://www.codeshiftcommunity.com/docs/testing) for more information.
### `npm run validate`
Check the validity of your `hypermod.config.js` file.
See the [configuration options](https://www.codeshiftcommunity.com/docs/configuration) for more information.
### `npm run build`
Builds the app for production to the `dist` folder.
## Publishing
This package can be published to npm via the normal commands `npm version` and `npm publish`
## Build tooling
Feel free to replace the preinstalled build tooling & dependencies to suit your needs. The only requirement is that there is a valid `hypermod.config.js` in your project root, `/src` or `/codemods` directories.