jiaaoMario/octo

Octo is a toolbox of common scripts for your Front-end projects

octo 📦

A toolbox of common scripts for your Front-end projects

---

If you're fed up with configuring a set of specs every time you create a front-end project, e.g: eslint,prettier or commitlint. Maybe you can try to use Octo.

Install

npm install octo-minions -D

Usage

Husky

Husky will auto deploy when you run octo-init, and octo will help you auto register some git-hooks, e.g pre-commit, commit-msg.

commitlint

commitlint.config.js

module.exports = require("octo/commitlint");

lint-staged

.lintstagedrc.js

module.exports = require("octo/lintstagedrc");

prettier

.prettierrc.js

module.exports = require("octo/prettier");

eslint

.eslintrc.js

module.exports = {
  extends: ["./node_modules/octo/eslint.js"],
};

tsconfig

{
  "extends": "./node_modules/octo/shared-tsconfig.json"
}

What features are integrated into Octo

1. Git Hooks - Husky
2. Commit-Msg Hooks - commitlint
3. Pre-commit Hooks - lint-staged
4. code formatter - prettier
5. Tool for identifying and reporting on patterns found in ECMAScript/JavaScript code - eslint
6. Strongly typed programming language - TypeScript

License

MIT