Introduction to Git Validate

Git Validate is a powerful tool that allows developers to enforce code quality and consistency across their project. The tool integrates with Git hooks to automate linting, testing, and validation processes. This helps in maintaining code standards, avoiding bug introductions, and ensuring a smoother development workflow.

Key APIs of Git Validate

Git Validate comes with a multitude of useful APIs that simplify the task of adding validations to your repository. Here are dozens of examples:

Basic Setup

  # Install git-validate
  npm install --save-dev git-validate

Configure Validation Hooks

  # Add validation hook configuration in package.json
  {
    "config": {
      "git-validate": {
        "hooks": {
          "pre-commit": "lint",
          "pre-push": "test"
        }
      }
    }
  }

Pre-Commit Hook Example

  "scripts": {
    "lint": "eslint ./src"
  }

Pre-Push Hook Example

  "scripts": {
    "test": "jest"
  }

Adding Custom Hooks

  {
    "config": {
      "git-validate": {
        "hooks": {
          "custom-hook": "custom-script"
        }
      }
    }
  }

With these configurations, Git Validate will run the specified scripts automatically during the Git lifecycle events, ensuring that your code matches the defined standards before it’s committed or pushed.

App Example

Here’s an example of a simple Node.js application configured with Git Validate:

Project Structure

  your-app/
  ├── src/
  │   └── index.js
  ├── test/
  │   └── index.test.js
  ├── package.json
  └── .eslintrc.json

Sample Code in index.js

  console.log("Hello, world!");

Sample Test in index.test.js

  const sum = (a, b) => a + b;

  test('adds 1 + 2 to equal 3', () => {
    expect(sum(1, 2)).toBe(3);
  });

Sample package.json

  {
    "name": "your-app",
    "version": "1.0.0",
    "scripts": {
      "lint": "eslint ./src",
      "test": "jest"
    },
    "config": {
      "git-validate": {
        "hooks": {
          "pre-commit": "lint",
          "pre-push": "test"
        }
      }
    },
    "devDependencies": {
      "eslint": "^7.2.1",
      "jest": "^26.0.1",
      "git-validate": "^2.2.4"
    }
  }

Sample ESLint Configuration (.eslintrc.json)

  {
    "env": {
      "es2021": true,
      "node": true
    },
    "extends": "eslint:recommended",
    "parserOptions": {
      "ecmaVersion": 12
    },
    "rules": {
      "indent": [
        "error",
        2
      ],
      "linebreak-style": [
        "error",
        "unix"
      ],
      "quotes": [
        "error",
        "single"
      ],
      "semi": [
        "error",
        "always"
      ]
    }
  }

By following the above setup and configurations, Git Validate will lint your code for style errors and run tests before the code is pushed, helping you maintain high code standards.

Hash: 447fcc96213289d947fc3dd30bd399be828b5cf87b3ce8ebbf9e951feef8f79a