Add ignoreWarnings option to valid-compile rule (#42)

* Add ignoreWarnings option to valid-compile rule

* Add test

Author: ota-meshi

docs/rules/valid-compile.md

@@ -37,7 +37,34 @@ Note that we exclude reports for some checks, such as `missing-declaration`, whi
 
 ## :wrench: Options
 
-Nothing.
+```json
+{
+  "@ota-meshi/svelte/valid-compile": [
+    "error",
+    {
+      "ignoreWarnings": false
+    }
+  ]
+}
+```
+
+- `ignoreWarnings` ... If set to `true`, ignores any warnings other than fatal errors reported by the svelte compiler.
+
+<eslint-code-block>
+
+<!--eslint-skip-->
+
+```svelte
+<script>
+  /* eslint @ota-meshi/svelte/valid-compile: ["error", { ignoreWarnings: true }] */
+  let src = "tutorial/image.gif"
+</script>
+
+<!-- Ignore -->
+<img {src} />
+```
+
+</eslint-code-block>
 
 ## :rocket: Version
 

src/rules/valid-compile.ts

@@ -67,11 +67,20 @@ export default createRule("valid-compile", {
       category: "Possible Errors",
       recommended: false,
     },
-    schema: [],
+    schema: [
+      {
+        type: "object",
+        properties: {
+          ignoreWarnings: { type: "boolean" },
+        },
+        additionalProperties: false,
+      },
+    ],
     messages: {},
     type: "problem",
   },
   create(context) {
+    const ignoreWarnings = Boolean(context.options[0]?.ignoreWarnings)
     const sourceCode = context.getSourceCode()
     const text = sourceCode.text
 
@@ -320,29 +329,32 @@ export default createRule("valid-compile", {
         report(getWarnings(code), (warn) => remapContext.remapLocs(warn))
       },
     }
+
+    /**
+     * Get compile warnings
+     */
+    function getWarnings(code: string): Warning[] {
+      try {
+        const result = compiler.compile(code, { generate: false })
+
+        if (ignoreWarnings) {
+          return []
+        }
+        return result.warnings
+      } catch (e) {
+        // console.log(code)
+        return [
+          {
+            message: e.message,
+            start: e.start,
+            end: e.end,
+          },
+        ]
+      }
+    }
   },
 })
 
-/**
- * Get compile warnings
- */
-function getWarnings(code: string): Warning[] {
-  try {
-    const result = compiler.compile(code, { generate: false })
-
-    return result.warnings
-  } catch (e) {
-    // console.log(code)
-    return [
-      {
-        message: e.message,
-        start: e.start,
-        end: e.end,
-      },
-    ]
-  }
-}
-
 /**
  * Checks if the given visitorKeys are the equals.
  */

tests/fixtures/rules/valid-compile/valid/ignore-warnings/_config.json

@@ -0,0 +1,3 @@
+{
+  "options": [{ "ignoreWarnings": true }]
+}

tests/fixtures/rules/valid-compile/valid/ignore-warnings/enum01-input.svelte

@@ -0,0 +1,5 @@
+<script>
+  let src = "tutorial/image.gif"
+</script>
+
+<img {src} />