Skip to content

Commit 3bd0463

Browse files
committed
init project
1 parent 05473ee commit 3bd0463

10 files changed

+1473
-1226
lines changed

.prettierrc.json

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{
2+
"printWidth": 120,
23
"trailingComma": "es5",
34
"tabWidth": 2,
45
"semi": true,

LICENSE.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2023 wopjs
3+
Copyright (c) 2024 wopjs
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

+21-19
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,33 @@
1-
# @wopjs/template
1+
# @wopjs/cast
22

3-
[![Build Status](https://github.com/wopjs/template/actions/workflows/build.yml/badge.svg)](https://github.com/wopjs/template/actions/workflows/build.yml)
3+
[![Docs](https://img.shields.io/badge/Docs-read-%23fdf9f5)](https://wopjs.github.io/cast)
4+
[![Build Status](https://github.com/wopjs/cast/actions/workflows/build.yml/badge.svg)](https://github.com/wopjs/cast/actions/workflows/build.yml)
5+
[![npm-version](https://img.shields.io/npm/v/@wopjs/cast.svg)](https://www.npmjs.com/package/@wopjs/cast)
6+
[![Coverage Status](https://img.shields.io/coverallsCoverage/github/wopjs/cast)](https://coveralls.io/github/wopjs/cast)
7+
[![minified-size](https://img.shields.io/bundlephobia/minzip/@wopjs/cast)](https://bundlephobia.com/package/@wopjs/cast)
48

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
1210

1311
## Install
1412

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
1913
```
14+
npm add @wopjs/cast
15+
```
16+
17+
## Publish New Version
2018

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.
2220

23-
You can also set the info manually by running:
21+
```
22+
npm version patch
23+
```
2424

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
2729
```
2830

29-
## License
31+
### CI Publish
3032

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).

README.template.md

-33
This file was deleted.

0 commit comments

Comments
 (0)