{"id":15498746,"url":"https://github.com/jankapunkt/npm-package-template","last_synced_at":"2025-08-07T02:44:24.098Z","repository":{"id":42951412,"uuid":"233210872","full_name":"jankapunkt/npm-package-template","owner":"jankapunkt","description":":package: minimal NPM package template using Babel, Mocha, Chai, C8, Standardjs,  JSDoc and Rollup.","archived":false,"fork":false,"pushed_at":"2024-02-01T13:25:43.000Z","size":954,"stargazers_count":17,"open_issues_count":9,"forks_count":8,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-22T22:19:07.636Z","etag":null,"topics":["babel","c8","chai","hacktoberfest","hacktoberfest-accepted","javascript","jsdoc","jsdoc-to-markdown","mocha","npm","package","rollup","standardjs","template","template-package"],"latest_commit_sha":null,"homepage":"https://jankapunkt.github.io/npm-package-template/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jankapunkt.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["jankapunkt"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":["https://paypal.me/kuesterjan"]}},"created_at":"2020-01-11T10:00:49.000Z","updated_at":"2024-07-18T00:27:37.000Z","dependencies_parsed_at":"2024-10-02T08:47:32.676Z","dependency_job_id":"644d0014-0f32-4a6f-9338-9ca2c677fd59","html_url":"https://github.com/jankapunkt/npm-package-template","commit_stats":{"total_commits":36,"total_committers":4,"mean_commits":9.0,"dds":"0.13888888888888884","last_synced_commit":"28a6b815c3e273a20d453d149b5b48ec0e0b416c"},"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jankapunkt%2Fnpm-package-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jankapunkt%2Fnpm-package-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jankapunkt%2Fnpm-package-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jankapunkt%2Fnpm-package-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jankapunkt","download_url":"https://codeload.github.com/jankapunkt/npm-package-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250331816,"owners_count":21413104,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["babel","c8","chai","hacktoberfest","hacktoberfest-accepted","javascript","jsdoc","jsdoc-to-markdown","mocha","npm","package","rollup","standardjs","template","template-package"],"created_at":"2024-10-02T08:47:30.160Z","updated_at":"2025-04-22T22:19:15.805Z","avatar_url":"https://github.com/jankapunkt.png","language":"JavaScript","funding_links":["https://github.com/sponsors/jankapunkt","https://paypal.me/kuesterjan"],"categories":[],"sub_categories":[],"readme":"# 📦 NPM Package Template - Zero Config 📦\n\n![Test suite](https://github.com/jankapunkt/npm-package-template/workflows/Test%20suite/badge.svg)\n[![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)\n[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)\n[![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)\n![GitHub](https://img.shields.io/github/license/jankapunkt/npm-package-template)\n\nMinimal tested and fully functional NPM package template project for ES6+ Javascript.\n\n## About this package\n\nThis template is intended to allow you to **start developing immediatly** with a working set\nof tools and scripts that play well together.\n\nIt is little opinionated to the point, that only the most basic tools are integrated.\nIf you want a different flavour you can fork this project and easily replace the tools or add new ones.\n\n## What's included?\n\n### Tools / stack\n\n* 🗪 [Babel](https://babeljs.io/) for transpiling\n* 🪄 [Standard](https://standardjs.com/) for linting\n* ⚗️ [Mocha](https://mochajs.org/) and [Chai](https://www.chaijs.com) for testing\n* 🔍 [c8](https://github.com/bcoe/c8) for code coverage\n* 📚 [JSDoc](https://jsdoc.app/) for documentation and [jsdoc-to-markdown](https://www.npmjs.com/package/jsdoc-to-markdown) to create docs as markdown files\n* ⚡ [GitHub actions](https://github.com/features/actions) for continuous integration\n* 📦 [Rollup](https://rollupjs.org) for bundling\n\nAll tools are defined as **`dev-dependencies`**!\n\n### Docs and repository\n\nThis template repository has all relevant GitHub community standards implemented:\n\n- [x] Description\n- [x] [README](./README.md)\n- [x] [Code of conduct](./CODE_OF_CONDUCT.md)\n- [x] [Contributing](./CONTRIBUTING.md)\n- [x] [License](./LICENSE)\n- [x] [Security policy](./SECURITY.md)\n- [x] [Issue templates](./.github/ISSUE_TEMPLATE)\n- [x] [Pull request template](./.github/PULL_REQUEST_TEMPLATE.md)\n\n## Getting started\n\nFirst, [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)\nor fork the repository and clone it to your local machine.\n\nFrom here, simply create your Js files in the `./lib` folder and add the tests in the `test` folder.\n\n### Use the tools\n\nWe provide a default set of tools via npm scripts. Run a script via\n\n```shell\n$ npm run \u003ccommand\u003e\n```\n\nwhere `\u003ccommand\u003e` is one of the following available commands:\n\n| command         | description                                       | output     |\n|-----------------|---------------------------------------------------|------------|\n| `lint`          | runs the linter in read-mode                      |            |\n| `lint:fix`      | runs the linter; fixes minor issues automatically |            |\n| `test`          | runs the tests once                               |            |\n| `test:watch`    | runs the tests; re-runs them on code changes      |            |\n| `test:coverage` | runs the tests once and creates a coverage report | `coverage` |\n| `docs`          | creates API documentation                         | `docs`     |\n| `build`         | builds the bundles for several target platforms   | `dist`     |\n| `build:full`    | runs `build` and `docs`                           | see above  |\n\n## Contributing and development\n\nWe provide an [extensive contribution guideline](./CONTRIBUTING.md) and a [code of conduct](./CODE_OF_CONDUCT.md)\nto help you in making your contribution a success!\n\n## Security\n\nPlease read our [security policy](./SECURITY.md) to get to know which versions are covered.\n\n## License\n\nMIT, see [license file](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjankapunkt%2Fnpm-package-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjankapunkt%2Fnpm-package-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjankapunkt%2Fnpm-package-template/lists"}