schemalint

Schemalint

Run linting rules on your database schema.

Works with Postgres databases.

Usage

Install with:

$ npm i -g schemalint

To run, make sure you are in a folder that has a .schemalintrc.js configuration file, and type:

$ schemalint

Here is an example configuration file:

module.exports = {
  connection: {
    host: 'localhost',
    user: 'postgres',
    password: 'postgres',
    database: 'acme',
    charset: 'utf8',
  },

  plugins: ['./custom-rules'],

  rules: {
    'table-name-casing': ['error', 'snake'],
    'column-name-casing': ['error', 'snake'],
    'prefer-jsonb-to-json': ['error'],
    'prefer-text-to-varchar': ['error'],
  },

  schemas: [
    {
      name: 'public',
      tablesToIgnore: ['knex_migrations', 'knex_migrations_lock'],
    },
  ],
};