Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jankapunkt/npm-package-template

:package: minimal NPM package template using Babel, Mocha, Chai, C8, Standardjs, JSDoc and Rollup.
https://github.com/jankapunkt/npm-package-template

babel c8 chai hacktoberfest hacktoberfest-accepted javascript jsdoc jsdoc-to-markdown mocha npm package rollup standardjs template template-package

Last synced: about 1 month ago
JSON representation

:package: minimal NPM package template using Babel, Mocha, Chai, C8, Standardjs, JSDoc and Rollup.

Host: GitHub
URL: https://github.com/jankapunkt/npm-package-template
Owner: jankapunkt
License: mit
Created: 2020-01-11T10:00:49.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2024-02-01T13:25:43.000Z (11 months ago)
Last Synced: 2024-05-02T05:13:25.631Z (8 months ago)
Topics: babel, c8, chai, hacktoberfest, hacktoberfest-accepted, javascript, jsdoc, jsdoc-to-markdown, mocha, npm, package, rollup, standardjs, template, template-package
Language: JavaScript
Homepage: https://jankapunkt.github.io/npm-package-template/
Size: 932 KB
Stars: 14
Watchers: 3
Forks: 9
Open Issues: 9
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

        # 📦 NPM Package Template - Zero Config 📦

![Test suite](https://github.com/jankapunkt/npm-package-template/workflows/Test%20suite/badge.svg)

[![Build and publish](https://github.com/jankapunkt/npm-package-template/actions/workflows/publish.yml/badge.svg)](https://github.com/jankapunkt/npm-package-template/actions/workflows/publish.yml)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

![GitHub](https://img.shields.io/github/license/jankapunkt/npm-package-template)

Minimal tested and fully functional NPM package template project for ES6+ Javascript.

## About this package

This template is intended to allow you to **start developing immediatly** with a working set

of tools and scripts that play well together.

It is little opinionated to the point, that only the most basic tools are integrated.

If you want a different flavour you can fork this project and easily replace the tools or add new ones.

## What's included?

### Tools / stack

* 🗪 [Babel](https://babeljs.io/) for transpiling

* 🪄 [Standard](https://standardjs.com/) for linting

* ⚗️ [Mocha](https://mochajs.org/) and [Chai](https://www.chaijs.com) for testing

* 🔍 [c8](https://github.com/bcoe/c8) for code coverage

* 📚 [JSDoc](https://jsdoc.app/) for documentation and [jsdoc-to-markdown](https://www.npmjs.com/package/jsdoc-to-markdown) to create docs as markdown files

* ⚡ [GitHub actions](https://github.com/features/actions) for continuous integration

* 📦 [Rollup](https://rollupjs.org) for bundling

All tools are defined as **`dev-dependencies`**!

### Docs and repository

This template repository has all relevant GitHub community standards implemented:

- [x] Description

- [x] [README](./README.md)

- [x] [Code of conduct](./CODE_OF_CONDUCT.md)

- [x] [Contributing](./CONTRIBUTING.md)

- [x] [License](./LICENSE)

- [x] [Security policy](./SECURITY.md)

- [x] [Issue templates](./.github/ISSUE_TEMPLATE)

- [x] [Pull request template](./.github/PULL_REQUEST_TEMPLATE.md)

## Getting started

First, [create a new repository with this repository as template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)

or fork the repository and clone it to your local machine.

From here, simply create your Js files in the `./lib` folder and add the tests in the `test` folder.

### Use the tools

We provide a default set of tools via npm scripts. Run a script via

```shell

$ npm run 

```

where `` is one of the following available commands:

| command         | description                                       | output     |

|-----------------|---------------------------------------------------|------------|

| `lint`          | runs the linter in read-mode                      |            |

| `lint:fix`      | runs the linter; fixes minor issues automatically |            |

| `test`          | runs the tests once                               |            |

| `test:watch`    | runs the tests; re-runs them on code changes      |            |

| `test:coverage` | runs the tests once and creates a coverage report | `coverage` |

| `docs`          | creates API documentation                         | `docs`     |

| `build`         | builds the bundles for several target platforms   | `dist`     |

| `build:full`    | runs `build` and `docs`                           | see above  |

## Contributing and development

We provide an [extensive contribution guideline](./CONTRIBUTING.md) and a [code of conduct](./CODE_OF_CONDUCT.md)

to help you in making your contribution a success!

## Security

Please read our [security policy](./SECURITY.md) to get to know which versions are covered.

## License

MIT, see [license file](LICENSE)