@umvel/typescript-base-guidelines

Welcome to umvel-typescript-base-guidelines 👋

This project contains a hook that validate lint project and prettier rules every run the command git commit -m '...'

🏠 Homepage

These guidelines are inspired from Airbnb/Javascript and Google Typescript Guidelines, the goal is generate a code guidelines to improve the code quality.

IMPORTANT This package takes Umvel Javascript Base Guidelines as base

Prerequisites

• npm >=6.14.6
• node 16.17.1

Install

// Select the node version
> nvm use
Found '.../umvel-typescript-base-guidelines/.nvmrc' with version <16.17.1>
Now using node v16.17.1 (npm v6.14.6)

// Install dependencies with npm
> npm ci
⸨          ░░░░░░░░⸩ ⠏ extractTree: sill extract
...
added 1531 packages in 19.488s

Usage

npm run lint

Run tests

npm run test

Author

👤 Miguel López

• Website: https://anxelin.dev/
• Github: @mikeg96
• LinkedIn: @malgarcia

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 Miguel López.

This project is MIT licensed.

---

This README was generated with ❤️ by readme-md-generator