{"id":25707728,"url":"https://github.com/jhsware/inferno-library-boilerplate","last_synced_at":"2025-09-10T03:38:17.615Z","repository":{"id":92670877,"uuid":"177271590","full_name":"jhsware/inferno-library-boilerplate","owner":"jhsware","description":"Boilerplate to get you started with your next great Inferno library","archived":false,"fork":false,"pushed_at":"2019-03-23T09:55:07.000Z","size":10,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-08-22T19:36:41.524Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/jhsware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2019-03-23T09:49:31.000Z","updated_at":"2019-03-23T11:05:45.000Z","dependencies_parsed_at":"2023-06-26T01:49:44.519Z","dependency_job_id":null,"html_url":"https://github.com/jhsware/inferno-library-boilerplate","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jhsware/inferno-library-boilerplate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhsware%2Finferno-library-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhsware%2Finferno-library-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhsware%2Finferno-library-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhsware%2Finferno-library-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jhsware","download_url":"https://codeload.github.com/jhsware/inferno-library-boilerplate/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhsware%2Finferno-library-boilerplate/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274407511,"owners_count":25279297,"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-09-10T02:00:12.551Z","response_time":83,"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":[],"created_at":"2025-02-25T08:39:07.879Z","updated_at":"2025-09-10T03:38:17.604Z","avatar_url":"https://github.com/jhsware.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# inferno-library-boilerplate\n\n\n## Quickstart\n\n1. Fork `inferno-library-boilerplate`\n\n2. Update all the package related info in `package.json`\n\n3. Add code to `/src` and tests to `/test`\n\n4. Choose a great name for your library and update `package.json` and probably your Git repos name aswell...\n\n5. Release your library `npm version patch \u0026\u0026 npm publish`\n\n## HOWTOs\n\n[Introduction to porting a React library](./howto/porting_react_library.md)\n\n[About semantic versioning](https://docs.npmjs.com/about-semantic-versioning)\n\n## Contributing\n\nIf you find bugs, please submit a PR.\n\nIf you solve a problem that might be of use to others. Please add a howto in the docs folder and submit a PR.\n\nThis boilerplate was created to lower the bar to create libraries for Inferno. I found that it took several hours to set up thee basic scaffolding. Now you can hopefully be up and running in five minutes.\n\n## Customisation\n\n### Adding unit tests\n\nThe tests are in the `/test` folder. There is a really simple example of an inferno component test there.\n\n- packages: `jest`, `jsdom`, `sinon`\n- command: `npm run test`\n- config: `jest.config.js`, `JEST-DEBUG.js`\n\nJest simplifies A LOT when it comes to setting up the testing environment. To learn more about writing tests, you can check out [inferno-bootstrap/__tests__](https://github.com/jhsware/inferno-bootstrap/tree/master/__test__)\n\n### Building for release\n\nReleasing your library is very easy! \n\n1. Tag a version, the preversion hook will run the tests and lint your code. If all is well the version will be bumped.\n\n  `$ npm version patch`\n\n  (If the linting fails you can run `$ npm run lint-fix` or manually fix linting errors)\n\n2. Publish your app\n\n  `$ npm publish`\n\nRollup is our main characte when creating releases. It works like Webpack but came as a nicer options for libraries, geneerating smaller and more readble code base.\n\n- packages: `rollup*`\n- command: `npm run build` or `npm run build:dist``\n- config: `rollup.config.js`\n\nWhen you add dependencies add them as an `external` to `rollup.config.js`. That way it won't get added to the generated code bundle, but rather as an external dependency. This avoids that your app has lots of duplicate packages.\n\n### Transpiling\n\nTranspiling of es6 code is done with:\n\n- packages: `@babel/*` and `babel-*`\n- command: `npm run build` or `npm run build-dev`\n- config: `.babelrc`\n\nThe `inferno-app` preset does A LOT of th heavy lifting! If you want to add or remove transpiling features, you would change these `.babelrc` and install or remove plugins/presets.\n\n### Linting\n\nCode style suggestions and linting is done with:\n\n- packages: `eslint-*`\n- command: `npm run lint` or `npm run lint-fix`\n- config: `.eslintrc.js`\n\nIf you don't want linting, you can remove them. If you want to change the coding style, modify the config.\n\nStay strong, you've got this!!!\n\nSebastian","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjhsware%2Finferno-library-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjhsware%2Finferno-library-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjhsware%2Finferno-library-boilerplate/lists"}