{"id":20986841,"url":"https://github.com/karmaniverous/npm-package-template","last_synced_at":"2025-10-09T11:36:10.192Z","repository":{"id":45552768,"uuid":"513797758","full_name":"karmaniverous/npm-package-template","owner":"karmaniverous","description":"An ES6 NPM package project template featuring a CLI, test support, automated API docs, release management \u0026 more!","archived":false,"fork":false,"pushed_at":"2024-08-12T05:55:05.000Z","size":627,"stargazers_count":3,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-09-13T10:38:50.301Z","etag":null,"topics":["chai","docs","es6","javascript","mocha","npm","package","release","template","testing"],"latest_commit_sha":null,"homepage":"https://karmanivero.us/blog/npm-package-template/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/karmaniverous.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["karmaniverous"]}},"created_at":"2022-07-14T07:12:39.000Z","updated_at":"2024-09-19T05:45:31.000Z","dependencies_parsed_at":"2023-02-18T23:01:16.071Z","dependency_job_id":"6ec5b812-4813-4681-9c46-b391749637ab","html_url":"https://github.com/karmaniverous/npm-package-template","commit_stats":{"total_commits":148,"total_committers":1,"mean_commits":148.0,"dds":0.0,"last_synced_commit":"94e8ff1f892f29d91b62a48d4beb9376033dc742"},"previous_names":[],"tags_count":23,"template":true,"template_full_name":null,"purl":"pkg:github/karmaniverous/npm-package-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karmaniverous%2Fnpm-package-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karmaniverous%2Fnpm-package-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karmaniverous%2Fnpm-package-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karmaniverous%2Fnpm-package-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/karmaniverous","download_url":"https://codeload.github.com/karmaniverous/npm-package-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karmaniverous%2Fnpm-package-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279001304,"owners_count":26083058,"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","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["chai","docs","es6","javascript","mocha","npm","package","release","template","testing"],"created_at":"2024-11-19T06:15:03.210Z","updated_at":"2025-10-09T11:36:10.174Z","avatar_url":"https://github.com/karmaniverous.png","language":"JavaScript","funding_links":["https://github.com/sponsors/karmaniverous"],"categories":[],"sub_categories":[],"readme":"# NPM Package Template\n\nYou wrote a sweet piece of code! Releasing it on [NPM](https://www.npmjs.com/)\nseems like the obvious next step. Right?\n\n_Try it!_ Not as easy to do as you might think. At high quality. From scratch.\n\nSo here's a plug-and-play NPM package template that offers the following\nfeatures:\n\n- Tree-shakable support for the latest ES6 goodies with\n  [`eslint`](https://www.npmjs.com/package/eslint) _uber alles_.\n\n- CJS distributions targeting specific browser support scenarios.\n\n- Command line interfaces for your widget with\n  [`commander`](https://www.npmjs.com/package/commander).\n\n- Automated [`lodash`](https://www.npmjs.com/package/lodash) cherry-picking with\n  [`babel-plugin-lodash`](https://www.npmjs.com/package/babel-plugin-lodash).\n\n- [`mocha`](https://www.npmjs.com/package/mocha) \u0026\n  [`chai`](https://www.npmjs.com/package/chai) for testing, with examples, and a\n  sweet testing console.\n\n- In-code access to\n  [`package.json`](https://github.com/karmaniverous/npm-package-template/blob/main/package.json)\n  data, with no warnings to ignore.\n\n- Code formatting at every save \u0026 paste with\n  [`prettier`](https://www.npmjs.com/package/prettier).\n\n- Automated documentation of your API with\n  [`jsdoc-to-markdown`](https://www.npmjs.com/package/jsdoc-to-markdown) and\n  assembly of your README with\n  [`concat-md`](https://www.npmjs.com/package/concat-md).\n\n- One-button release to GitHub \u0026 publish to NPM with\n  [`release-it`](https://www.npmjs.com/package/release-it).\n\n**[Click here](https://karmanivero.us/blog/npm-package-template/) for full\ndocumentation \u0026 instructions!**\n\n_If you want to create a React component in an NPM package, use my\n[React Component NPM Package Template](https://github.com/karmaniverous/react-component-npm-package-template)\ninstead!_\n\n# Command Line Interface\n\n```text\nUsage: mycli [options]\n\nFoos your bar.\n\nOptions:\n  -b, --bar \u003cstring\u003e  foo what?\n  -h, --help          display help for command\n```\n\n# API Documentation\n\n```js\nimport { foo, PACKAGE_INFO } from '@karmaniverous/npm-package-template`;\n```\n\n\u003ca name=\"foo\"\u003e\u003c/a\u003e\n\n## foo(value) ⇒ \u003ccode\u003eany\u003c/code\u003e\nReturns whatever value is passed.\n\n**Kind**: global function  \n**Returns**: \u003ccode\u003eany\u003c/code\u003e - Whatever value it was passed.  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| value | \u003ccode\u003eany\u003c/code\u003e | Any value. |\n\n\n---\n\nSee more great templates and other tools on\n[my GitHub Profile](https://github.com/karmaniverous)!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkarmaniverous%2Fnpm-package-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkarmaniverous%2Fnpm-package-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkarmaniverous%2Fnpm-package-template/lists"}