Code Quality Front

This project contains a collection of essential quality tools for front applications, including Prettier, TypeScript configuration, Jest, and ESLint.

Table of Contents

1. Introduction
2. Installation
3. Usage
4. Configuration
5. Contributing
6. License

Introduction

Code Quality Front Tools aims to help you maintain a high-quality codebase by providing a set of tools and configurations for code formatting, type checking, testing, and linting. The included tools are:

• Prettier: An opinionated code formatter.
• TypeScript: A superset of JavaScript that adds static types.
• Jest: A delightful JavaScript testing framework.
• ESLint: A pluggable JavaScript linter.

Code Quality include all quality packages you need for your font project. Make sure you have installed all these dependencies before using the tools.

Check package.json for more details.

Installation

To install the Code Quality Front Tools, run the following command:

make init
make install

Usage

After installation, you can use the following commands to run the tools:

Jest

Run tests:

make test

ESLint

Lint your code:

make eslint

Help

make help

Configuration

Each tool comes with its own configuration file:

• Prettier: .prettierrc.js
• TypeScript: tsconfig.json
• Jest: jest.config.js
• ESLint: .eslintrc.js

Installation in front project

• Make sure you have installed all these dependencies before using the tools.
• To install the Code Quality Front Tools in your project, run the following command :

npm install @groupeactual/code-quality-front

Copy makefile rule and use these commands to init your project depending on your framework :

make init-quality-react

or

make init-quality-react-native

You can customize these configurations (Prettier/TypeScript/Jest/ESLint) to fit your project's needs, all these configurations can be overridden in your project.

CI

For each new tag created, a new release will be created on github and a new version will be published on npm.

Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.

1. Create a new branch with your changes
2. Commit your changes and push them to your branch
3. Create a pull request and add reviewers

License

©Tysoft S.A.S. - La Digital Factory