|
1 |
| -# @wopjs/template |
| 1 | +# @wopjs/cast |
2 | 2 |
|
3 |
| -[](https://github.com/wopjs/template/actions/workflows/build.yml) |
| 3 | +[](https://wopjs.github.io/cast) |
| 4 | +[](https://github.com/wopjs/cast/actions/workflows/build.yml) |
| 5 | +[](https://www.npmjs.com/package/@wopjs/cast) |
| 6 | +[](https://coveralls.io/github/wopjs/cast) |
| 7 | +[](https://bundlephobia.com/package/@wopjs/cast) |
4 | 8 |
|
5 |
| -A template starter repo for modern JavaScript and TypeScript development, designed to ensure high-quality code output. |
6 |
| - |
7 |
| -- **ESLint Configuration**: Includes TypeScript support and automatic import sorting. |
8 |
| -- **Testing Framework**: Utilizes Vitest for seamless testing and coverage reporting. |
9 |
| -- **Documentation Generation**: Handled by TypeDoc for creating detailed documentation. |
10 |
| -- **Build Process**: Uses `tsup` to bundle compact, readable code with a focus on minimizing bundle size. |
11 |
| -- **Continuous Integration**: Includes GitHub Actions for automated CI testing, versioning and publishing. |
| 9 | +cast |
12 | 10 |
|
13 | 11 | ## Install
|
14 | 12 |
|
15 |
| -After you have cloned the repository generated by this template, run the following command to rename the package and install dependencies: |
16 |
| - |
17 |
| -```console |
18 |
| -node scripts/setup.mjs |
19 | 13 | ```
|
| 14 | +npm add @wopjs/cast |
| 15 | +``` |
| 16 | + |
| 17 | +## Publish New Version |
20 | 18 |
|
21 |
| -It will update the template with info inferred from git or directory name, and install dependencies. |
| 19 | +You can use [npm version](https://docs.npmjs.com/cli/v10/commands/npm-version) to bump version. |
22 | 20 |
|
23 |
| -You can also set the info manually by running: |
| 21 | +``` |
| 22 | +npm version patch |
| 23 | +``` |
24 | 24 |
|
25 |
| -```console |
26 |
| -node scripts/setup.mjs --name "package-name" --description "package description" --repo "https://github.com/wopjs/template.git" |
| 25 | +Push the tag to remote and CI will publish the new version to npm. |
| 26 | + |
| 27 | +``` |
| 28 | +git push --follow-tags |
27 | 29 | ```
|
28 | 30 |
|
29 |
| -## License |
| 31 | +### CI Publish |
30 | 32 |
|
31 |
| -MIT @ [wopjs](https://github.com/wopjs) |
| 33 | +If you want to publish the package in CI, you need to set the `NPM_TOKEN` secrets [in GitHub repository settings](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository). See how to [create a NPM access token](https://docs.npmjs.com/creating-and-viewing-access-tokens). |
0 commit comments