{"id":21022980,"url":"https://github.com/cklwblove/javascript-library-starter","last_synced_at":"2026-04-21T08:35:41.882Z","repository":{"id":80970190,"uuid":"309665805","full_name":"cklwblove/javascript-library-starter","owner":"cklwblove","description":"Starter kit with zero-config for building a library in JavasScript, featuring RollupJS, Jest, Prettier, ESLint, Semantic Release, and more!","archived":false,"fork":false,"pushed_at":"2020-11-09T12:38:55.000Z","size":131,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-13T18:13:47.644Z","etag":null,"topics":["babel7","eslint","javascript-library","rollup"],"latest_commit_sha":null,"homepage":"","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/cklwblove.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2020-11-03T11:32:05.000Z","updated_at":"2020-11-09T12:38:57.000Z","dependencies_parsed_at":null,"dependency_job_id":"f12e118e-77f8-419c-8a23-f77901b645d0","html_url":"https://github.com/cklwblove/javascript-library-starter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cklwblove/javascript-library-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cklwblove%2Fjavascript-library-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cklwblove%2Fjavascript-library-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cklwblove%2Fjavascript-library-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cklwblove%2Fjavascript-library-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cklwblove","download_url":"https://codeload.github.com/cklwblove/javascript-library-starter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cklwblove%2Fjavascript-library-starter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28077916,"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-12-27T02:00:05.897Z","response_time":58,"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":["babel7","eslint","javascript-library","rollup"],"created_at":"2024-11-19T11:16:08.552Z","updated_at":"2025-12-27T11:11:16.634Z","avatar_url":"https://github.com/cklwblove.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JavaScript library starter\n\nA starter project that makes creating a JavaScript library extremely easy.\n\n![](https://i.imgur.com/opUmHp0.png)\n\n### Usage\n\n```bash\ngit clone https://github.com/cklwblove/javascript-library-starter.git YOURFOLDERNAME\ncd YOURFOLDERNAME\n\n# Run npm install and write your library name when asked. That's all!\nnpm install\n```\n\n**Start coding!** `package.json` and entry files are already set up for you, so don't worry about linking to your main file, typings, etc. Just keep those files with the same name.\n\n### Features\n\n - Zero-setup. After running `npm install` things will setup for you :wink:\n - **[RollupJS](https://rollupjs.org/)** for multiple optimized bundles and **Tree-shaking**\n - Tests, coverage and interactive watch mode using **[Jest](http://facebook.github.io/jest/)**\n - **[Prettier](https://github.com/prettier/prettier)** and **[ESLint](https://eslint.org/)** for code formatting and consistency\n - **[Travis](https://travis-ci.org)** integration and **[Coveralls](https://coveralls.io/)** report\n - (Optional) **Automatic releases and changelog**, using [Semantic release](https://github.com/semantic-release/semantic-release), [Commitizen](https://github.com/commitizen/cz-cli), [Conventional changelog](https://github.com/conventional-changelog/conventional-changelog) and [Husky](https://github.com/typicode/husky) (for the git hooks)\n\n### Importing library\n\nYou can import the generated bundle to use the whole library generated by this starter:\n\n```javascript\nimport myLib from 'mylib'\n```\n\n### NPM scripts\n\n - `npm t`: Run test suite\n - `npm start`: Run `npm run build` in watch mode\n - `npm run test:watch`: Run test suite in [interactive watch mode](http://facebook.github.io/jest/docs/cli.html#watch)\n - `npm run test:prod`: Run linting and generate coverage\n - `npm run build`: Generate bundles and typings, create docs\n - `npm run lint`: Lints code\n - `npm run commit`: Commit using conventional commit style ([husky](https://github.com/typicode/husky) will tell you to use it if you haven't :wink:)\n\n### Excluding peerDependencies\n\nOn library development, one might want to set some peer dependencies, and thus remove those from the final bundle. You can see in [Rollup docs](https://rollupjs.org/#peer-dependencies) how to do that.\n\nGood news: the setup is here for you, you must only include the dependency name in `external` property within `rollup.config.js`. For example, if you want to exclude `lodash`, just write there `external: ['lodash']`.\n\n### Automatic releases\n\n_**Prerequisites**: you need to create/login accounts and add your project to:_\n - [npm](https://www.npmjs.com/)\n - [Travis CI](https://travis-ci.org)\n - [Coveralls](https://coveralls.io)\n\n_**Prerequisite for Windows**: Semantic-release uses\n**[node-gyp](https://github.com/nodejs/node-gyp)** so you will need to\ninstall\n[Microsoft's windows-build-tools](https://github.com/felixrieseberg/windows-build-tools)\nusing this command:_\n\n```bash\nnpm install --global --production windows-build-tools\n```\n\n#### Setup steps\n\nFollow the console instructions to install semantic release and run it (answer NO to \"Do you want a `.travis.yml` file with semantic-release setup?\").\n\n_Note: make sure you've setup `repository.url` in your `package.json` file_\n\n```bash\nnpm install -g semantic-release-cli\nsemantic-release-cli setup\n# IMPORTANT!! Answer NO to \"Do you want a `.travis.yml` file with semantic-release setup?\" question. It is already prepared for you :P\n```\n\nFrom now on, you'll need to use `npm run commit`, which is a convenient way to create conventional commits.\n\nAutomatic releases are possible thanks to [semantic release](https://github.com/semantic-release/semantic-release), which publishes your code automatically on [github](https://github.com/) and [npm](https://www.npmjs.com/), plus generates automatically a changelog. This setup is highly influenced by [Kent C. Dodds course on egghead.io](https://egghead.io/courses/how-to-write-an-open-source-javascript-library)\n\n### Git Hooks\n\nThere is already set a `precommit` hook for formatting your code with Prettier :nail_care:\n\nBy default, there are two disabled git hooks. They're set up when you run the `npm run semantic-release-prepare` script. They make sure:\n - You follow a [conventional commit message](https://github.com/conventional-changelog/conventional-changelog)\n - Your build is not going to fail in [Travis](https://travis-ci.org) (or your CI server), since it's runned locally before `git push`\n\nThis makes more sense in combination with [automatic releases](#automatic-releases)\n\n### FAQ\n\n#### `Array.prototype.from`, `Promise`, `Map`... is undefined?\n\nJavaScript or Babel only provides down-emits on syntactical features (`class`, `let`, `async/await`...), but not on functional features (`Array.prototype.find`, `Set`, `Promise`...), . For that, you need Polyfills, such as [`core-js`](https://github.com/zloirock/core-js) or [`babel-polyfill`](https://babeljs.io/docs/usage/polyfill/) (which extends `core-js`).\n\nFor a library, `core-js` plays very nicely, since you can import just the polyfills you need:\n\n```javascript\nimport \"core-js/fn/array/find\"\nimport \"core-js/fn/string/includes\"\nimport \"core-js/fn/promise\"\n...\n```\n\n#### What is `npm install` doing on first run?\n\nIt runs the script `tools/init` which sets up everything for you. In short, it:\n - Configures RollupJS for the build, which creates the bundles\n - Configures `package.json` (typings file, main file, etc)\n - Renames main src and test files\n\n#### What if I don't want git-hooks, automatic releases or semantic-release?\n\nThen you may want to:\n - Remove `commitmsg`, `postinstall` scripts from `package.json`. That will not use those git hooks to make sure you make a conventional commit\n - Remove `npm run semantic-release` from `.travis.yml`\n\n#### What if I don't want to use coveralls or report my coverage?\n\nRemove `npm run report-coverage` from `.travis.yml`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcklwblove%2Fjavascript-library-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcklwblove%2Fjavascript-library-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcklwblove%2Fjavascript-library-starter/lists"}