Home

Awesome

<a name="user-content-eslint-plugin-sql"></a> <a name="eslint-plugin-sql"></a>

eslint-plugin-sql

NPM version Canonical Code Style Twitter Follow

SQL linting rules for ESLint.

In its current form, the plugin has been designed and tested to work with Postgres codebase.

<a name="user-content-eslint-plugin-sql-installation"></a> <a name="eslint-plugin-sql-installation"></a>

Installation

  1. Install ESLint.
  2. Install eslint-plugin-sql plugin.
<!-- --> 
npm install eslint --save-dev
npm install eslint-plugin-sql --save-dev

<a name="user-content-eslint-plugin-sql-configuration"></a> <a name="eslint-plugin-sql-configuration"></a>

Configuration

  1. Add plugins section and specify eslint-plugin-sql as a plugin.
  2. Enable rules.
<!-- --> 
{
  "plugins": [
    "sql"
  ],
  "rules": {
    "sql/format": [
      2,
      {
        "ignoreExpressions": false,
        "ignoreInline": true,
        "ignoreTagless": true
      }
    ],
    "sql/no-unsafe-query": [
      2,
      {
        "allowLiteral": false
      }
    ]
  }
}

<a name="user-content-eslint-plugin-sql-settings"></a> <a name="eslint-plugin-sql-settings"></a>

Settings

<a name="user-content-eslint-plugin-sql-settings-placeholderrule"></a> <a name="eslint-plugin-sql-settings-placeholderrule"></a>

<code>placeholderRule</code>

A regex used to ignore placeholders or other fragments of the query that'd make it invalid SQL query, e.g.

If you are using ? placeholders in your queries, you must ignore \? pattern as otherwise the string is not going to be recognized as a valid SQL query.

This configuration is relevant for sql/no-unsafe-query to match queries containing placeholders as well as for sql/format when used with {ignoreTagless: false} configuration.

<a name="user-content-eslint-plugin-sql-rules"></a> <a name="eslint-plugin-sql-rules"></a>

Rules

<!-- Rules are sorted alphabetically. -->

<a name="user-content-eslint-plugin-sql-rules-format"></a> <a name="eslint-plugin-sql-rules-format"></a>

<code>format</code>

The --fix option on the command line automatically fixes problems reported by this rule.

Matches queries in template literals. Warns when query formatting does not match the configured format (see Options).

This rule is used to format the queries using pg-formatter.

<a name="user-content-eslint-plugin-sql-rules-format-options"></a> <a name="eslint-plugin-sql-rules-format-options"></a>

Options

The first option is an object with the following configuration.

configurationformatdefaultdescription
ignoreBaseIndentbooleanfalseDoes not leave base indent before linting.
ignoreExpressionsbooleanfalseDoes not format template literals that contain expressions.
ignoreInlinebooleantrueDoes not format queries that are written on a single line.
ignoreStartWithNewLinebooleantrueDoes not remove \n at the beginning of queries.
ignoreTaglessbooleantrueDoes not format queries that are written without using sql tag.
sqlTagstringsqlTemplate tag name for SQL.

The second option is an object with the pg-formatter configuration.

<a name="user-content-eslint-plugin-sql-rules-no-unsafe-query"></a> <a name="eslint-plugin-sql-rules-no-unsafe-query"></a>

<code>no-unsafe-query</code>

Disallows use of SQL inside of template literals without the sql tag.

The sql tag can be anything, e.g.

<a name="user-content-eslint-plugin-sql-rules-no-unsafe-query-options-1"></a> <a name="eslint-plugin-sql-rules-no-unsafe-query-options-1"></a>

Options

The first option is an object with the following configuration.

configurationformatdefaultdescription
allowLiteralbooleanfalseControls whether sql tag is required for template literals containing literal queries, i.e. template literals without expressions.
sqlTagstringsqlTemplate tag name for SQL.