Ts Node Starter

Overview

The ts-node-starter is a template repository designed to simplify the process of starting a new Node.js project using TypeScript. It provides a configurable setup with various features, allowing users to build standalone apps, libraries, and CLI tools.

Features

• Automatic changelog generation: Powered by generate-changelog, making it easy to create changelog files.
• Automatic code & config formatting: Powered by Lefthook, ensuring consistent formatting of code and configuration files.
• Automatic dependency updates: Powered by Dependabot, keeping dependencies up to date.
• Code coverage reports: Powered by Codecov, providing visibility into code coverage rates.
• Config formatting: Powered by Prettier, facilitating consistent code formatting.
• Continuous integration pipeline: Powered by GitHub Actions workflows, automating the build and testing process.
• Cross-platform compatibility: Powered by cross-env, ensuring compatibility across different operating systems.
• Dependency management: Powered by yarn, simplifying dependency installation and management.
• Distribution pipeline: Powered by npm, allowing for easy distribution and installation of the project.
• Static code analysis: Powered by ESLint, helping to identify and fix code issues.
• Testing & code coverage: Powered by Jest, enabling efficient testing and generating code coverage reports.
• Type checking: Powered by TypeScript, providing static type checking for better code quality.

Installation

To use the ts-node-starter template repository, follow these steps:

1. Replace all occurrences of “bennycode” with your own username or organization name.
2. Replace all occurrences of “ts-node-starter” with your project name or repository name.
3. Start writing your code in the “src” directory.
4. Run yarn to install dependencies.
5. Build a standalone app by running yarn start or debug your code using yarn debug.
6. Build a library by referring to the “src/index.ts” file and update the “main” property in the “package.json” file accordingly.
7. Build a CLI tool by referring to the “src/cli.ts” file and update the “bin” property in the “package.json” file if necessary.
8. To troubleshoot issues with the Git pre-commit hook, reinstall the hook using the command provided in the documentation.

Summary

The ts-node-starter template repository is a convenient solution for starting a new Node.js project with TypeScript. It offers a range of features and provides a configurable setup for building different types of applications. By following the installation guide, users can quickly set up their projects and take advantage of the provided tools and workflows for development, testing, and distribution.