{"id":17028555,"url":"https://github.com/bennycode/stop-merging-test","last_synced_at":"2026-05-09T17:42:51.782Z","repository":{"id":60312190,"uuid":"542310356","full_name":"bennycode/stop-merging-test","owner":"bennycode","description":null,"archived":false,"fork":false,"pushed_at":"2023-07-12T08:42:52.000Z","size":491,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-27T23:46:44.631Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/bennycode.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}},"created_at":"2022-09-27T22:22:35.000Z","updated_at":"2022-11-06T10:09:31.000Z","dependencies_parsed_at":"2023-01-21T08:02:31.185Z","dependency_job_id":null,"html_url":"https://github.com/bennycode/stop-merging-test","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"bennycode/ts-node-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bennycode%2Fstop-merging-test","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bennycode%2Fstop-merging-test/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bennycode%2Fstop-merging-test/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bennycode%2Fstop-merging-test/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bennycode","download_url":"https://codeload.github.com/bennycode/stop-merging-test/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245013985,"owners_count":20547178,"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":[],"created_at":"2024-10-14T07:54:58.242Z","updated_at":"2026-05-09T17:42:46.763Z","avatar_url":"https://github.com/bennycode.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ts-node-starter\n\nThe `ts-node-starter` scaffolding project is a [template repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository) which makes it easy for you to start a new Node.js project with TypeScript.\n\nUsing this template, you can build **standalone apps**, **libraries** and/or **CLI tools**. The `ts-node-starter` setup is configurable and comes with a lot of features included.\n\n## Features\n\n1. **Automatic changelog generation** powered by [generate-changelog](https://github.com/lob/generate-changelog)\n1. **Automatic code \u0026 config formatting** powered by [Lefthook](https://github.com/evilmartians/lefthook)\n1. **Automatic dependency updates** powered by [Dependabot](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates)\n1. **Code coverage reports** powered by [Codecov](https://about.codecov.io/)\n1. **Config formatting** powered by [Prettier](https://prettier.io/)\n1. **Continuous integration pipeline** powered by [GitHub Actions workflows](https://docs.github.com/en/actions/using-workflows)\n1. **Cross-platform compatibility** powered by [cross-env](https://github.com/kentcdodds/cross-env)\n1. **Dependency management** powered by [yarn](https://yarnpkg.com/)\n1. **Distribution pipeline** powered by [npm](https://www.npmjs.com/)\n1. **Static code analysis** powered by [ESLint](https://eslint.org/)\n1. **Testing \u0026 code coverage** powered by [Jest](https://jestjs.io/)\n1. **Type checking** powered by [TypeScript](https://www.typescriptlang.org/)\n\n## Usage\n\n### Make it your own\n\n1. Replace all occurrences of \"bennycode\" with your own username (or organization name)\n2. Replace all occurrences of \"ts-node-starter\" with your project name (or repository name)\n3. Start writing your code in the [\"src\" directory](./src)\n4. Run `yarn` and be happy! 😊\n\n### Build a standalone app\n\n**Source Code**\n\nIf you just want to write and run a Node.js app, checkout [\"src/start.ts\"](./src/start.ts).\n\n**References**\n\nYou can start your application by executing `yarn start`. If you want to debug your code, run `yarn debug` ([Debug Instructions](https://dev.to/typescripttv/debug-your-node-js-app-with-chrome-devtools-4c98)).\n\n### Build a Library\n\n**Source Code**\n\nIf you want to distribute your code as a Node.js library on [npm](https://www.npmjs.com/), you can have a look at [\"src/index.ts\"](./src/index.ts). If you build a library, I recommend to always ship an index file from where you export the code of your library for others.\n\n**References**\n\nIn the [\"package.json\" file](./package.json) you will also discover a \"main\" property which defines the entry point to your library when it gets imported by other developers. The value of the \"main\" property has to point to the transpiled JavaScript code.\n\n### Build a CLI\n\n**Source Code**\n\nIf you want to build a CLI tool for Node.js, you can have a look at [\"src/cli.ts\"](./src/cli.ts).\n\n**References**\n\nIn the [\"package.json\" file](./package.json) you will also discover a \"bin\" property which defines the executable name of your tool and the entry point to its transpiled JavaScript code.\n\nIf you don't want to publish a CLI, simply remove the \"bin\" property and the CLI script.\n\n## Conventions\n\n### Test Files\n\nI recommend to colocate your test code with your source code by naming your test files `*.test.ts`.\n\n### Changelog Generation\n\nThe automatic changelog generation is based on [Semantic Commit Messages](https://sparkbox.com/foundry/semantic_commit_messages). Simply use the suggested prefixes in your commit messages to make use of it. For example, if you commit a new feature use the \"feat\" prefix:\n\n**Commit Message**\n\n\u003e feat: My new feature\n\n## Important Refactorings\n\n- Replaced [husky](https://github.com/typicode/husky) with [Lefthook](https://github.com/evilmartians/lefthook) (https://github.com/bennycode/ts-node-starter/commit/9c4161509acf49e56042383c9ea340f68f248582)\n- Replaced [action-dependabot-auto-merge](https://github.com/ahmadnassri/action-dependabot-auto-merge) with [Dependabot](https://github.com/dependabot) \u0026 [GitHub CLI](https://cli.github.com/) (https://github.com/bennycode/ts-node-starter/commit/86d5696113c2fb4907a1666e25d1b72d698b06a5)\n- Replaced [Jasmine](https://jasmine.github.io/) with [Jest](https://jestjs.io/) (https://github.com/bennycode/ts-node-starter/commit/41e9b42bb5b7ca364dbbabf1104955090003d1be)\n- Replaced [EditorConfig](https://editorconfig.org/) with [Prettier](https://prettier.io/) (https://github.com/bennycode/ts-node-starter/commit/2e24f7be5f427c26d6cc8281438a6398a211b75c)\n\n## Contributors\n\n[![Benny Neugebauer on Stack Exchange][stack_exchange_bennycode_badge]][stack_exchange_bennycode_url]\n\n[![Panayiotis Lipiridis on Stack Exchange][stack_exchange_lipis_badge]][stack_exchange_lipis_url]\n\n[stack_exchange_bennycode_badge]: https://stackexchange.com/users/flair/203782.png?theme=default\n[stack_exchange_bennycode_url]: https://stackexchange.com/users/203782/benny-neugebauer?tab=accounts\n[stack_exchange_lipis_badge]: https://stackexchange.com/users/flair/5282.png?theme=default\n[stack_exchange_lipis_url]: https://stackexchange.com/users/5282/lipis?tab=accounts\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbennycode%2Fstop-merging-test","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbennycode%2Fstop-merging-test","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbennycode%2Fstop-merging-test/lists"}