https://github.com/chillerlan/js-library-template
JavaScript library template
https://github.com/chillerlan/js-library-template
Last synced: about 2 months ago
JSON representation
JavaScript library template
- Host: GitHub
- URL: https://github.com/chillerlan/js-library-template
- Owner: chillerlan
- License: mit
- Created: 2024-07-03T14:37:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-17T09:45:13.000Z (12 months ago)
- Last Synced: 2025-02-15T08:34:20.407Z (8 months ago)
- Language: JavaScript
- Size: 145 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# chillerlan/js-library-template
A template/boilerplate for JavaScript libraries.
[![License][license-badge]][license]
[![Build][gh-action-badge]][gh-action]
[![CodeCov][coverage-badge]][coverage]
[license-badge]: https://img.shields.io/github/license/chillerlan/js-library-template.svg
[license]: https://github.com/chillerlan/js-library-template/blob/main/LICENSE
[gh-action-badge]: https://img.shields.io/github/actions/workflow/status/chillerlan/js-library-template/build.yml?branch=main&logo=github&logoColor=ccc
[gh-action]: https://github.com/chillerlan/js-library-template/actions/workflows/build.yml?query=branch%3Amain
[coverage-badge]: https://img.shields.io/codecov/c/github/chillerlan/js-library-template?logo=codecov&logoColor=ccc
[coverage]: https://codecov.io/github/chillerlan/js-library-template
## Overview
### Features
- [GitHub Actions](https://github.com/chillerlan/js-library-template/actions) runner
- [Babel](https://babeljs.io) compiler/transpiler
- [Rollup](https://rollupjs.org) module bundler
- [ESLint](https://eslint.org) static analysis
- [Mocha](https://mochajs.org) test framework
- [Chai](https://www.chaijs.com) assertion library
- [C8](https://github.com/bcoe/c8) code coverage
- [istanbul/nyc](https://istanbul.js.org) test coverage
- [Codecov](https://codecov.io) code coverage analysis
- [jsdoc](https://jsdoc.app) automated API documentation
## Documentation
Register a package with {the GitHub package registry](https://github.com/features/packages), requires a [PAT for the repo/org](https://github.com/settings/tokens):
```bash
npm adduser
# ...
npm login --scope=@chillerlan --auth-type=legacy --registry=https://npm.pkg.github.com
# ...
npm publish --access public
```
## Disclaimer
Use at your own risk!