feat: add salTag option (fixes #40)

Author: gajus

.README/rules/format.md

@@ -15,8 +15,9 @@ The first option is an object with the following configuration.
 |`ignoreBaseIndent`|boolean|`false`|Does not leave base indent before linting.|
 |`ignoreExpressions`|boolean|`false`|Does not format template literals that contain expressions.|
 |`ignoreInline`|boolean|`true`|Does not format queries that are written on a single line.|
-|`ignoreTagless`|boolean|`true`|Does not format queries that are written without using `sql` tag.|
 |`ignoreStartWithNewLine`|boolean|`true`|Does not remove `\n` at the beginning of queries.|
+|`ignoreTagless`|boolean|`true`|Does not format queries that are written without using `sql` tag.|
+|`sqlTag`|string|`sql`|Template tag name for SQL.|
 
 The second option is an object with the [`pg-formatter` configuration](https://github.com/gajus/pg-formatter#configuration).
 

.README/rules/no-unsafe-query.md

@@ -14,5 +14,6 @@ The first option is an object with the following configuration.
 |configuration|format|default|description|
 |---|---|---|---|
 |`allowLiteral`|boolean|`false`|Controls whether `sql` tag is required for template literals containing literal queries, i.e. template literals without expressions.|
+|`sqlTag`|string|`sql`|Template tag name for SQL.|
 
 <!-- assertions noUnsafeQuery -->

README.md

@@ -109,8 +109,9 @@ The first option is an object with the following configuration.
 |`ignoreBaseIndent`|boolean|`false`|Does not leave base indent before linting.|
 |`ignoreExpressions`|boolean|`false`|Does not format template literals that contain expressions.|
 |`ignoreInline`|boolean|`true`|Does not format queries that are written on a single line.|
-|`ignoreTagless`|boolean|`true`|Does not format queries that are written without using `sql` tag.|
 |`ignoreStartWithNewLine`|boolean|`true`|Does not remove `\n` at the beginning of queries.|
+|`ignoreTagless`|boolean|`true`|Does not format queries that are written without using `sql` tag.|
+|`sqlTag`|string|`sql`|Template tag name for SQL.|
 
 The second option is an object with the [`pg-formatter` configuration](https://github.com/gajus/pg-formatter#configuration).
 
@@ -136,6 +137,7 @@ The first option is an object with the following configuration.
 |configuration|format|default|description|
 |---|---|---|---|
 |`allowLiteral`|boolean|`false`|Controls whether `sql` tag is required for template literals containing literal queries, i.e. template literals without expressions.|
+|`sqlTag`|string|`sql`|Template tag name for SQL.|
 
 
 

src/rules/format.ts

@@ -8,6 +8,7 @@ const create = (context) => {
 
   const pluginOptions = context.options?.[0] || {};
 
+  const sqlTag = pluginOptions.sqlTag;
   const ignoreExpressions = pluginOptions.ignoreExpressions === true;
   const ignoreInline = pluginOptions.ignoreInline !== false;
   const ignoreTagless = pluginOptions.ignoreTagless !== false;
@@ -21,7 +22,7 @@ const create = (context) => {
         node.parent.tag?.object?.name ??
         node.parent.tag?.callee?.object?.name;
 
-      const sqlTagIsPresent = tagName === 'sql';
+      const sqlTagIsPresent = tagName === sqlTag;
 
       if (ignoreTagless && !sqlTagIsPresent) {
         return;
@@ -131,6 +132,10 @@ export = {
             default: true,
             type: 'boolean',
           },
+          sqlTag: {
+            default: 'sql',
+            type: 'string',
+          },
         },
         type: 'object',
       },

src/rules/noUnsafeQuery.ts

@@ -5,12 +5,17 @@ const debug = createDebug('eslint-plugin-sql:rule:no-unsafe-query');
 
 const defaultOptions = {
   allowLiteral: false,
+  sqlTag: 'sql',
 };
 
 const create = (context) => {
   const placeholderRule = context.settings?.sql?.placeholderRule;
 
-  const { allowLiteral } = context.options[0] ?? defaultOptions;
+  const pluginOptions = context.options?.[0] || {};
+
+  const sqlTag = pluginOptions.sqlTag ?? defaultOptions.sqlTag;
+  const allowLiteral =
+    pluginOptions.allowLiteral ?? defaultOptions.allowLiteral;
 
   return {
     TemplateLiteral(node) {
@@ -41,9 +46,9 @@ const create = (context) => {
 
       const legacyTagName = node.parent.name?.toLowerCase();
 
-      if (legacyTagName !== 'sql' && tagName !== 'sql') {
+      if (legacyTagName !== sqlTag && tagName !== sqlTag) {
         context.report({
-          message: 'Use "sql" tag',
+          message: `Use "${sqlTag}" tag`,
           node,
         });
       }
@@ -68,6 +73,10 @@ export = {
             default: false,
             type: 'boolean',
           },
+          sqlTag: {
+            default: 'sql',
+            type: 'string',
+          },
         },
         type: 'object',
       },

test/rules/assertions/format.ts

@@ -91,6 +91,21 @@ export default {
       output:
         "    const code = sql`\nSELECT\n    ${'foo'}\nFROM\n    ${'bar'}\n`",
     },
+    {
+      code: 'SQL`SELECT 1`',
+      errors: [
+        {
+          message: 'Format the query',
+        },
+      ],
+      options: [
+        {
+          ignoreInline: false,
+          sqlTag: 'SQL',
+        },
+      ],
+      output: 'SQL`\nSELECT\n    1\n`',
+    },
   ],
   valid: [
     {

test/rules/assertions/noUnsafeQuery.ts

@@ -37,6 +37,19 @@ export default {
         },
       },
     },
+    {
+      code: "foo`SELECT ${'bar'}`",
+      errors: [
+        {
+          message: 'Use "SQL" tag',
+        },
+      ],
+      options: [
+        {
+          sqlTag: 'SQL',
+        },
+      ],
+    },
   ],
   valid: [
     {
@@ -56,5 +69,13 @@ export default {
     {
       code: "sql`SELECT ${'foo'}`",
     },
+    {
+      code: "SQL`SELECT ${'bar'}`",
+      options: [
+        {
+          sqlTag: 'SQL',
+        },
+      ],
+    },
   ],
 };