Tosin
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.
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.
- Vuepress
VuePress is a minimalistic static site generator based on Vue.js that allows developers to create fast, SEO-friendly, and customizable documentation websites.
- Templates & Themes
A template or theme refers to a pre-designed layout or structure that provides a basic framework for building a specific type of application or website. It typically includes good design, placeholder content and functional features, allowing developers to customize and fill in the details according to their specific needs.
- Eslint
ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.
- Rollup
RollupJS is a popular and efficient JavaScript module bundler that takes the code from multiple modules and packages them into a single optimized file, minimizing the overall size of the application and improving its performance.