Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 1.41 KB

PRE-COMMIT.md

File metadata and controls

37 lines (27 loc) · 1.41 KB
Raw

Pre-commit

Plio utilizes the power of pre-commit to identify simple programming issues at the time of code check-in. This helps the reviewer to focus more on architectural and conceptual issues and reduce the overall time to market.

The pre-commit configurations are stored in .pre-commit-config.yaml file.

To know about the syntax, visit the official documentation site.

The pre-commit hook in this repository uses various plugins to run different kinds of checks.

  1. Pre-commit-hooks: Checks and fixes basic linting issues. All available hooks for pre-commit can be found here.

  2. Prettier mirror: Checks for code formatting issues within Javascript files and fixes if errors found, like indentation, extra lines and spaces, invalid syntax, etc .

Installation

  1. Install pre-commit

    Use pip to install pre-commit

    pip install pre-commit

    Or using homebrew on macOS

    brew install pre-commit

    For more installation alternatives, check out Pre-commit official documentation.

  2. Verify pre-commit installation

    pre-commit --version

Usage

  1. Run command 
    pre-commit .