https://github.com/joaopalmeiro/template-ts-package
Opinionated TypeScript template for new packages.
https://github.com/joaopalmeiro/template-ts-package
Last synced: about 1 month ago
JSON representation
Opinionated TypeScript template for new packages.
- Host: GitHub
- URL: https://github.com/joaopalmeiro/template-ts-package
- Owner: joaopalmeiro
- License: mit
- Created: 2024-02-17T07:52:52.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-17T08:42:24.000Z (8 months ago)
- Last Synced: 2025-01-31T07:12:03.808Z (3 months ago)
- Language: TypeScript
- Homepage:
- Size: 40 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# template-ts-package
Opinionated TypeScript template for new packages.
- [Source code](https://github.com/joaopalmeiro/template-ts-package)
- [npm package](https://www.npmjs.com/package/template-ts-package)
- [Licenses](https://licenses.dev/npm/template-ts-package)
- [Package Phobia](https://packagephobia.com/result?p=template-ts-package)
- [bundlejs](https://bundlejs.com/?bundle&q=template-ts-package)
- [npm trends](https://npmtrends.com/template-ts-package)
- [Snyk Advisor](https://snyk.io/advisor/npm-package/template-ts-package)
- [Visualization of npm dependencies](https://npm.anvaka.com/#/view/2d/template-ts-package)
## Getting Started
1. Go to or create the package folder.
2. Get the template files:
```bash
npx degit github:joaopalmeiro/template-ts-package
```
or
```bash
npx degit github:joaopalmeiro/template-ts-package --force
```
3. Search for `template-ts-package` and replace it with the package name. Ignore the template repository URL in the [NOTES.md](NOTES.md) file.
4. Search for `Opinionated TypeScript template for new packages.` and replace it with the (short) package description.
5. Search for `João Palmeiro` and replace it with the author's name.
6. Search for `[email protected]` and replace it with the author's email address.
7. Change the `author.url` field in the `package.json` file to the author's website/social media profile.
8. Install [fnm](https://github.com/Schniz/fnm) (if necessary).
9. Run the first two commands in the [`Development`](#development) section to install [Node.js](https://nodejs.org/en) and the development dependencies.
10. Open the [NOTES.md](NOTES.md) file and install the package-specific dependencies according to the first command in the [`Commands`](NOTES.md#commands) section.
11. Update the `Source code` link at the top to the package repository link (if necessary).
12. Change `GitHub` in the [`Deployment`](#deployment) section to `GitLab` or `Codeberg` and update the link to the corresponding Tags page (if necessary).
13. Update the `homepage`, `bugs.url`, and `repository.url` fields in the `package.json` file with their respective repository-related links (if necessary).
14. Delete the [TEMPLATE.md](TEMPLATE.md) file.
15. Delete the [`Getting Started`](#getting-started) section.
## Development
Install [fnm](https://github.com/Schniz/fnm) (if necessary).
```bash
fnm install && fnm use && node --version && npm --version
```
```bash
npm install
```
```bash
npm run lint
```
```bash
npm run format
```
```bash
npm run build
```
## Deployment
```bash
npm pack --dry-run
```
```bash
npm version patch
```
```bash
npm version minor
```
```bash
npm version major
```
```bash
echo "v$(npm pkg get version | tr -d \")" | pbcopy
```
- Commit and push changes.
- Create a tag on [GitHub Desktop](https://github.blog/2020-05-12-create-and-push-tags-in-the-latest-github-desktop-2-5-release/).
- Check [GitHub](https://github.com/joaopalmeiro/template-ts-package/tags).
```bash
npm login
```
```bash
npm publish
```
- Check [npm](https://www.npmjs.com/package/template-ts-package).