Skip to content

Latest commit

 

History

History
28 lines (17 loc) · 1.03 KB

README.md

File metadata and controls

28 lines (17 loc) · 1.03 KB

eslint-plugin-improvin

Custom eslint rules created by and used by the Improvin development team

Install command with esling-config-improvin

yarn add --dev https://github.com/plantaseed/eslint-config-improvin.git https://github.com/plantaseed/eslint-plugin-improvin.git

How the sql linting works

To get the sql linting rules to work you must tag the template strings containing sql with a sql tag. It can either be one that has extra logic or something as simple as const sql = x => x;

Example

sql`SELECT * FROM "table_name"`;

Rules

  1. improvin/sql-matching-double-quotes: Checks if you have incorrectly formatted double quotes for a postgres query

    • OK: select "tableName"."fieldName" from "tableName";
    • BAD: select tableName"."fieldName" from "tableName"; || select "tableName."fieldName" from "tableName";

  2. improvin/sql-formatting: Errors if your sql template string is not formatted the same way as the npm package sql-formatter

    • We make use of this rule with eslints auto fixing