{"id":14384657,"url":"https://github.com/algolia/rollup-jest-boilerplate","last_synced_at":"2025-08-23T17:33:12.530Z","repository":{"id":42877255,"uuid":"138937886","full_name":"algolia/rollup-jest-boilerplate","owner":"algolia","description":"🎉 Full featured boilerplate for building JavaScript libraries the modern way","archived":true,"fork":false,"pushed_at":"2023-03-03T07:12:46.000Z","size":2319,"stargazers_count":80,"open_issues_count":22,"forks_count":12,"subscribers_count":56,"default_branch":"master","last_synced_at":"2024-09-24T14:06:32.765Z","etag":null,"topics":["boilerplate","jest","library","rollup"],"latest_commit_sha":null,"homepage":null,"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/algolia.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}},"created_at":"2018-06-27T22:08:40.000Z","updated_at":"2023-12-02T13:45:08.000Z","dependencies_parsed_at":"2024-01-14T20:30:42.039Z","dependency_job_id":null,"html_url":"https://github.com/algolia/rollup-jest-boilerplate","commit_stats":{"total_commits":287,"total_committers":5,"mean_commits":57.4,"dds":0.04878048780487809,"last_synced_commit":"ababdcdc2860c7fddf1bba0ed9cf981d148787bd"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Frollup-jest-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Frollup-jest-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Frollup-jest-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Frollup-jest-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/algolia","download_url":"https://codeload.github.com/algolia/rollup-jest-boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230716603,"owners_count":18269805,"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":["boilerplate","jest","library","rollup"],"created_at":"2024-08-28T18:01:33.336Z","updated_at":"2024-12-21T12:30:48.478Z","avatar_url":"https://github.com/algolia.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# 📚 rollup-jest-boilerplate\n\n\u003e Full featured boilerplate for building JavaScript libraries the modern way.\n\n## Features\n- 📜 [Rollup.js](https://rollupjs.org/guide/en) configuration providing compatibility with different module systems (CommonJS, ECMAScript, UMD for `\u003cscript\u003e` tags)\n- 🃏 [Jest](http://jestjs.io/) setup with watch mode working\n- 🛀 [Renovate](https://github.com/apps/renovate) configuration for auto updates (you have to activate it via https://github.com/apps/renovate)\n- 🐈 [Yarn](https://yarnpkg.com/) with lock file, [pinned](https://renovatebot.com/docs/dependency-pinning/) devDependencies and fixed Yarn version in .yarnrc using [Yarn policies](https://yarnpkg.com/lang/en/docs/cli/policies/)\n- ✅ [Travis CI](https://travis-ci.com/)\n- 🏗 [.nvmrc](https://github.com/creationix/nvm) file to enforce the Node.js version for contributors and continuous integration\n- ⚡️ Ready to publish and use\n\n## How to use\n\nDecide of a new library name, let's say `new-super-library` (🤦🏼‍♀️), then in a terminal:\n\n```sh\ncurl --output rollup-jest-boilerplate.zip -LOk https://github.com/algolia/rollup-jest-boilerplate/archive/master.zip\nunzip rollup-jest-boilerplate.zip\nrm rollup-jest-boilerplate.zip\nmv rollup-jest-boilerplate-master new-super-library\n```\n\n**Next steps:**\n- search the project for `rollup-starter-lib` and replace everywhere with `new-super-library`\n- start coding in [src/main.js](src/main.js)\n- profit 💸\n\n## Live examples\n\nThose examples are using the live published version of this boilerplate library on [npm](https://www.npmjs.com/rollup-jest-boilerplate) and they run with [CodeSandbox](https://codesandbox.io/).\n\n- [ECMAScript](https://codesandbox.io/s/7ojknnqjl6?module=%2Fsrc%2Findex.js)\n- [CommonJS](https://codesandbox.io/s/o5q018q609?module=%2Fsrc%2Findex.js)\n- [UMD](https://codesandbox.io/s/jyqqp21rv), this leverages [jsDelivr npm CDN](https://www.jsdelivr.com/features)\n\n## Developer environment requirements\n\nTo run this project, you will need:\n\n- Node.js \u003e= v10.5.0, use nvm - [install instructions](https://github.com/creationix/nvm#install-script)\n- Yarn \u003e= v1.7.0 - [install instructions (\"Alternatives\" tab)](https://yarnpkg.com/en/docs/install#alternatives-rc)\n\n## Running tests\n\n```sh\nyarn\nyarn test\nyarn test --watch\n```\n\n## Dev mode\n\nWhen developing you can run:\n\n```\nyarn watch\n```\n\nThis will regenerate the build files each time a source file is changed and serve on http://127.0.0.1:5000.\n\n### Previewing umd build in the browser\n\nIf your package works in the browser, you can open `dev/index.html` to try it out.\n\n## Publishing\n\n```sh\nnpm publish\n```\n\n## Additional tooling\n\nBased on your need, you might want to add:\n- [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/)\n- [TypeScript](https://www.typescriptlang.org/) support\n- Monorepo support with [Lerna](https://lernajs.io/)\n- CHANGELOG.md generation with [conventional-changelog](https://github.com/conventional-changelog)\n\nIf so, please do and open pull requests when you feel like it.\n\n## Original idea\n\nI initially used [rollup/rollup-starter-lib](https://github.com/rollup/rollup-starter-lib) but really needed that Jest support so I did it.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgolia%2Frollup-jest-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falgolia%2Frollup-jest-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgolia%2Frollup-jest-boilerplate/lists"}