{"id":14155314,"url":"https://github.com/norskeld/serpent","last_synced_at":"2025-07-14T17:32:42.800Z","repository":{"id":46864151,"uuid":"272443697","full_name":"norskeld/serpent","owner":"norskeld","description":"Yet another TypeScript library starter with conventional goodies and automatic semantic releases.","archived":false,"fork":false,"pushed_at":"2024-07-02T03:54:43.000Z","size":1451,"stargazers_count":11,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-08-17T08:05:03.548Z","etag":null,"topics":["commitlint","eslint","husky","library","lint-staged","prettier","semantic-release","starter","tsup","tsx","typescript","vite"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/norskeld.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-06-15T13:16:53.000Z","updated_at":"2024-08-17T08:05:06.014Z","dependencies_parsed_at":"2023-01-31T02:01:02.691Z","dependency_job_id":"f85d43ae-d08c-42a5-a4d0-2be826976864","html_url":"https://github.com/norskeld/serpent","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/norskeld%2Fserpent","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/norskeld%2Fserpent/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/norskeld%2Fserpent/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/norskeld%2Fserpent/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/norskeld","download_url":"https://codeload.github.com/norskeld/serpent/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225990484,"owners_count":17556153,"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":["commitlint","eslint","husky","library","lint-staged","prettier","semantic-release","starter","tsup","tsx","typescript","vite"],"created_at":"2024-08-17T08:02:49.294Z","updated_at":"2024-11-23T01:48:34.449Z","avatar_url":"https://github.com/norskeld.png","language":"TypeScript","funding_links":[],"categories":["vite"],"sub_categories":[],"readme":"# `〜` serpent\n\n\u003c!-- Uncomment \u0026 replace owner/repo. --\u003e\n\n\u003c!-- [![Build/Test](https://img.shields.io/github/actions/workflow/status/norskeld/serpent/test.yml?style=flat-square\u0026colorA=22272d\u0026colorB=22272d)](https://github.com/norskeld/serpent/actions 'Build and test workflows') --\u003e\n\u003c!-- [![Coverage](https://img.shields.io/coverallsCoverage/github/norskeld/serpent?style=flat-square\u0026colorA=22272d\u0026colorB=22272d)](https://coveralls.io/github/norskeld/serpent 'Test coverage') --\u003e\n\u003c!-- [![NPM](https://img.shields.io/npm/v/@nrsk/serpent?style=flat-square\u0026colorA=22272d\u0026colorB=22272d)](https://npm.im/@nrsk/serpent 'This package on NPM') --\u003e\n\u003c!-- [![Bundlephobia](https://img.shields.io/bundlephobia/minzip/@nrsk/serpent?style=flat-square\u0026colorA=22272d\u0026colorB=22272d\u0026label=minzipped)](https://bundlephobia.com/package/@nrsk/serpent) --\u003e\n\u003c!-- ![Tree Shaking](https://img.shields.io/static/v1?label=tree+shaking\u0026message=✔\u0026style=flat-square\u0026colorA=22272d\u0026colorB=22272d) --\u003e\n\n![Supported Node Versions](https://img.shields.io/static/v1?label=node\u0026message=\u003e=18+\u003c=20\u0026style=flat-square\u0026colorA=22272d\u0026colorB=22272d)\n[![Semantic Release](https://img.shields.io/static/v1?label=semantic+release\u0026message=✔\u0026style=flat-square\u0026colorA=22272d\u0026colorB=22272d)](https://github.com/semantic-release/semantic-release 'This package uses semantic release to handle releasing, versioning, changelog generation and tagging')\n[![Conventional Commits](https://img.shields.io/static/v1?label=conventional+commits\u0026message=✔\u0026style=flat-square\u0026colorA=22272d\u0026colorB=22272d)](https://conventionalcommits.org 'This package follows the conventional commits spec and guidelines')\n\nYet another TypeScript library starter with conventional goodies and automatic semantic releases.\n\n## Usage\n\nCreate your own repo [using this one as a template][use-template], clone it, [make necessary changes](#edits), install dependencies and you are set.\n\n## Features\n\nWhat's inside:\n\n- **[TypeScript]** with **[tsup]** for bundling (CJS/ESM) and **[tsx]** (for executing `.ts` files).\n- **[Vitest]**: for testing and generating coverage report, by default it runs in watch mode (behaves properly in CI).\n- **[ESLint]**: with TypeScript and Prettier plugins, extends only built-in recommended configs.\n- **[Prettier]**: very basic config, feel free to adjust as you want.\n- **[commitlint]**: for linting commits, by default it uses [Angular preset][commitlint-preset].\n- **[semantic-release]**: for generating `CHANGELOG.md` and [handling the whole releasing process][semantic-release-highlights] based on [conventional commits][cc].\n- **[husky]** + **[lint-staged]**: for fixing and formatting your code before committing.\n- **[EditorConfig]**: handy little thing to make things a bit more consistent.\n\nAlso:\n\n- **[.vscode](.vscode)**: some handy settings for Visual Studio Code.\n- **[.scripts/release](.scripts/release.ts)**: custom script to help **semantic-release** produce flat and tidy tarballs.\n- **[.github/workflows](.github/workflows)**: basic configs for:\n  - Testing and building on **node@20**;\n  - Releasing to **npm** with **semantic-release**.\n\n## Edits\n\nYou'll have to make some changes right after generating your own repository using this template.\n\n- **[README.md](README.md)**: change as you want, you may want to check [this site][readme] and [this awesome-readme list][readme-awesome] for examples of good readmes.\n- **[LICENSE](LICENSE)**: change as you want and don't forget to mention it in README.\n- **[package.json](package.json)**: change `name`, `description`, `repository.url`, `keywords`, `author`, `bugs.url`, `homepage`.\n- **[.github/workflows](.github/workflows)**: either remove these, replace with your own CI configuration or change as you need.\n  - [semantic-release has recipes and instructions][semantic-recipes] for popular CI services.\n\n## License\n\n[MIT](LICENSE) by default, but you may want to [consider using something else][choose-license].\n\n\u003c!-- Links. --\u003e\n\n[use-template]: https://github.com/norskeld/serpent/generate\n[typescript]: https://typescriptlang.org\n[tsup]: https://github.com/egoist/tsup\n[tsx]: https://github.com/esbuild-kit/tsx\n[vitest]: https://vitest.dev\n[commitlint]: https://github.com/conventional-changelog/commitlint\n[commitlint-preset]: https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-angular\n[semantic-release]: https://semantic-release.gitbook.io/semantic-release\n[eslint]: https://eslint.org\n[prettier]: https://prettier.io\n[husky]: https://github.com/typicode/husky\n[lint-staged]: https://github.com/okonet/lint-staged\n[editorconfig]: https://editorconfig.org\n[semantic-recipes]: https://semantic-release.gitbook.io/semantic-release/recipes/recipes\n[readme]: https://makeareadme.com\n[readme-awesome]: https://github.com/matiassingers/awesome-readme\n[choose-license]: https://choosealicense.com\n[semantic-release-highlights]: https://semantic-release.gitbook.io/semantic-release/#highlights\n[cc]: https://conventionalcommits.org\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnorskeld%2Fserpent","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnorskeld%2Fserpent","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnorskeld%2Fserpent/lists"}