Initialize a npm package with everything included, from CI to documentation website
Overview
Tosin is an opinionated way to start the creation of an npm package. It provides a comprehensive set of features, including continuous integration, linting and code formatting, testing framework, GitHub files for community engagement, and a build system using Rollup.
Features
- Continuous Integration: Tosin includes configurations for CircleCI and TravisCI, allowing for automated builds and tests for your repository.
- Linter + Prettier: Tosin utilizes ESLint for code linting and Prettier for code formatting, ensuring consistent code style and avoiding bugs.
- Testing Framework Jest: Tosin integrates Jest, a popular testing framework for JavaScript, which includes assertion library and mocking capabilities.
- GitHub Files for Community: Tosin provides standard templates for pull requests, bug reports, feature requests, and general issues, as well as a code of conduct, fostering community engagement and collaboration.
- Build System with Rollup: Tosin uses Rollup as the build system, allowing you to compile your code and output it in ES and CommonJS formats.
Installation
To install Tosin, you can follow these steps:
- First, make sure you have Node.js installed on your machine.
- Open your command line or terminal and navigate to the desired directory for your npm package.
- Run the following command to initialize a new Tosin npm package:
- This will create the necessary files and directories for your Tosin project.
- Customize the configuration files and templates as needed for your specific package requirements.
Summary
Tosin provides an opinionated approach to starting the creation of an npm package. With its comprehensive set of features, including continuous integration, linting and code formatting, testing framework, GitHub templates for community engagement, and a build system using Rollup, Tosin offers a convenient and efficient way to kickstart your npm package development process. Whether you are a solo developer or working with a team, Tosin helps streamline your workflow and ensures code quality and collaboration with the community.
