feat(eslint-plugin): add option to no-object-literal-type-assertion rule (#87)

armano2 · JamesHenry · commit 9f501a1dce55 · 2019-01-22T18:49:23.000-05:00
diff --git a/packages/eslint-plugin/docs/rules/no-object-literal-type-assertion.md b/packages/eslint-plugin/docs/rules/no-object-literal-type-assertion.md
@@ -20,9 +20,11 @@ const z = { ... } as unknown;
 
 ## Options
 
-```json
+```cjson
 {
-  "@typescript-eslint/no-object-literal-type-assertion": "error"
+  "@typescript-eslint/no-object-literal-type-assertion": ["error", {
+    allowAsParameter: false // Allow type assertion in call and new expression, default false
+  }]
 }
 ```
 
diff --git a/packages/eslint-plugin/lib/rules/no-object-literal-type-assertion.js b/packages/eslint-plugin/lib/rules/no-object-literal-type-assertion.js
@@ -10,6 +10,12 @@ const util = require('../util');
 // Rule Definition
 //------------------------------------------------------------------------------
 
+const defaultOptions = [
+  {
+    allowAsParameter: false
+  }
+];
+
 module.exports = {
   meta: {
     type: 'problem',
@@ -25,9 +31,24 @@ module.exports = {
       unexpectedTypeAssertion:
         'Type assertion on object literals is forbidden, use a type annotation instead.'
     },
-    schema: []
+    schema: [
+      {
+        type: 'object',
+        additionalProperties: false,
+        properties: {
+          allowAsParameter: {
+            type: 'boolean'
+          }
+        }
+      }
+    ]
   },
   create(context) {
+    const { allowAsParameter } = util.applyDefault(
+      defaultOptions,
+      context.options
+    )[0];
+
     //----------------------------------------------------------------------
     // Public
     //----------------------------------------------------------------------
@@ -52,6 +73,14 @@ module.exports = {
 
     return {
       'TSTypeAssertion, TSAsExpression'(node) {
+        if (
+          allowAsParameter &&
+          (node.parent.type === 'NewExpression' ||
+            node.parent.type === 'CallExpression')
+        ) {
+          return;
+        }
+
         if (
           checkType(node.typeAnnotation) &&
           node.expression.type === 'ObjectExpression'
diff --git a/packages/eslint-plugin/tests/lib/rules/no-object-literal-type-assertion.js b/packages/eslint-plugin/tests/lib/rules/no-object-literal-type-assertion.js
@@ -39,7 +39,23 @@ ruleTester.run('no-object-literal-type-assertion', rule, {
     `const foo = <any> {};`,
     // Allow cast to 'unknown'
     `const foo = {} as unknown;`,
-    `const foo = <unknown> {};`
+    `const foo = <unknown> {};`,
+    {
+      code: `print({ bar: 5 } as Foo)`,
+      options: [
+        {
+          allowAsParameter: true
+        }
+      ]
+    },
+    {
+      code: `new print({ bar: 5 } as Foo)`,
+      options: [
+        {
+          allowAsParameter: true
+        }
+      ]
+    }
   ],
   invalid: [
     {
@@ -71,6 +87,26 @@ ruleTester.run('no-object-literal-type-assertion', rule, {
           column: 11
         }
       ]
+    },
+    {
+      code: `print({ bar: 5 } as Foo)`,
+      errors: [
+        {
+          messageId: 'unexpectedTypeAssertion',
+          line: 1,
+          column: 7
+        }
+      ]
+    },
+    {
+      code: `new print({ bar: 5 } as Foo)`,
+      errors: [
+        {
+          messageId: 'unexpectedTypeAssertion',
+          line: 1,
+          column: 11
+        }
+      ]
     }
   ]
 });

Original file line number	Diff line number	Diff line change
`@@ -20,9 +20,11 @@ const z = { ... } as unknown;`
`20`	`20`
`21`	`21`	`## Options`
`22`	`22`
`23`		-```json
	`23`	+```cjson
`24`	`24`	`{`
`25`		`- "@typescript-eslint/no-object-literal-type-assertion": "error"`
	`25`	`+ "@typescript-eslint/no-object-literal-type-assertion": ["error", {`
	`26`	`+ allowAsParameter: false // Allow type assertion in call and new expression, default false`
	`27`	`+ }]`
`26`	`28`	`}`
`27`	`29`	```
`28`	`30`