https://github.com/kanakkholwal/pkg-template
A template repository for typescript packages
https://github.com/kanakkholwal/pkg-template
Last synced: 2 months ago
JSON representation
A template repository for typescript packages
- Host: GitHub
- URL: https://github.com/kanakkholwal/pkg-template
- Owner: kanakkholwal
- Created: 2025-01-25T10:30:20.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-01-25T12:00:18.000Z (4 months ago)
- Last Synced: 2025-02-10T19:39:21.669Z (4 months ago)
- Language: TypeScript
- Homepage:
- Size: 31.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Package name
[](https://www.npmjs.com/package/pdf-tables-parser)
**Package name** is a JavaScript/TypeScript library designed to this and that stuff seamlessly.
## Features
- Supports `Typescript`.
- Can work with both `browser` and `server` environment packages.
- Configured with `changeset` to seamlessly handle version upgrades with PRs
- `lint` and `release` to `npm` workflow action setup
## Setup
- update the dependencies
```bash
npx ncu -u
```
- Add `NPM_TOKEN` to `repository>settings>secrets and variables>actions` to publish package to npm registry
- Upgrade `node-version` and `pnpm` version in workflow files if new `lts` version is available.
- Navigate to Repo > Settings > Actions. Something like: https://github.com///settings/actions.
- Enable the settings to `Allow GitHub Actions to create and approve pull requests`
## Dependencies
- [@changesets/cli](https://www.npmjs.com/package/@changesets/cli): Helps you manage the versioning and changelog entries for your packages, with a focus on versioning within a mono-repository (though we support single-package repositories too).
- [Typescript](https://www.npmjs.com/package/typescript):TypeScript is a language for application-scale JavaScript. TypeScript adds optional types to JavaScript that support tools for large-scale JavaScript applications for any browser, for any host, on any OS. TypeScript compiles to readable, standards-based JavaScript.
- [tsup](https://www.npmjs.com/package/tsup): Bundle your TypeScript library with no config.
## Contributing
Contributions are welcome! If you find a bug or have a feature request, please open an issue or submit a pull request on [GitHub](https://github.com/kanakkholwal/pkg-template).
## License
This project is licensed under the ISC License. See the LICENSE file for details.
## Support
For issues and suggestions, please visit the [GitHub issues page](https://github.com/kanakkholwal/pkg-template/issues).