Merge pull request #894 from yutailang0119/action/ignore-warnings

Add ability to ignore warnings
yutailang0119 · Mar 11, 2024 · 76b8a39 · 76b8a39
2 parents 7fdd643 + bb7e3fe
commit 76b8a39
Show file tree

Hide file tree

Showing 8 changed files with 116 additions and 52 deletions.
diff --git a/README.md b/README.md
@@ -30,6 +30,7 @@ jobs:
       - uses: yutailang0119/action-textlint@v3
         with:
           textlint-output: ${{ steps.run-textlint.outputs.TEXTLINT_OUTPUT }}
+          ignore-warnings: true # Ignore Lint Warnings
         continue-on-error: false # If annotations contain error of severity, action-textlint exit 1.
 ```
 

diff --git a/__tests__/main.test.ts b/__tests__/main.test.ts
@@ -10,6 +10,7 @@ test('test runs with json file', () => {
     'resource',
     'textlint-report.json'
   )
+  process.env['INPUT_IGNORE-WARNINGS'] = 'false'
   const np = process.execPath
   const ip = path.join(__dirname, '..', 'lib', 'main.js')
   const options: cp.ExecFileSyncOptions = {
@@ -43,6 +44,7 @@ test('test runs with textlint output', () => {
     }
   ]`
   process.env['INPUT_TEXTLINT-OUTPUT'] = json
+  process.env['INPUT_IGNORE-WARNINGS'] = 'false'
   const np = process.execPath
   const ip = path.join(__dirname, '..', 'lib', 'main.js')
   const options: cp.ExecFileSyncOptions = {

diff --git a/__tests__/parser.test.ts b/__tests__/parser.test.ts
@@ -2,50 +2,51 @@ import {expect, test} from '@jest/globals'
 import {Annotation} from '../src/annotation'
 import {parseReport} from '../src/parser'
 
-test('test parse', () => {
-  const json = `[
-    {
-      "messages":[
-        {
-          "type":"lint",
-          "ruleId":"sample-rule/no-weak-phrase",
-          "message":"adverbs can weaken meaning",
-          "index":12,
-          "line":3,
-          "column":6,
-          "severity":1
-        },
-        {
-          "type":"lint",
-          "ruleId":"sample-rule/misspellings",
-          "message":"This is a commonly misspelled word. Correct it to useful",
-          "index":13,
-          "line":22,
-          "column":7,
-          "severity":2
-        }
-      ],
-      "filePath":"Foo.md"
-    },
-    {
-      "messages":[
-        {
-          "type":"lint",
-          "ruleId":"sample-rule/sentence:uppercase",
-          "message":"sentence should start with an uppercase letter",
-          "index":7,
-          "line":3,
-          "column":1,
-          "severity":2,
-          "fix":{
-            "range":[1,4],
-            "text":"This"
-          }
+const json = `[
+  {
+    "messages":[
+      {
+        "type":"lint",
+        "ruleId":"sample-rule/no-weak-phrase",
+        "message":"adverbs can weaken meaning",
+        "index":12,
+        "line":3,
+        "column":6,
+        "severity":1
+      },
+      {
+        "type":"lint",
+        "ruleId":"sample-rule/misspellings",
+        "message":"This is a commonly misspelled word. Correct it to useful",
+        "index":13,
+        "line":22,
+        "column":7,
+        "severity":2
+      }
+    ],
+    "filePath":"Foo.md"
+  },
+  {
+    "messages":[
+      {
+        "type":"lint",
+        "ruleId":"sample-rule/sentence:uppercase",
+        "message":"sentence should start with an uppercase letter",
+        "index":7,
+        "line":3,
+        "column":1,
+        "severity":2,
+        "fix":{
+          "range":[1,4],
+          "text":"This"
         }
-      ],
-      "filePath":"Bar.md"
-    }
-  ]`
+      }
+    ],
+    "filePath":"Bar.md"
+  }
+]`
+
+test('test parse', () => {
   const annotation1 = new Annotation(
     1,
     'adverbs can weaken meaning (sample-rule/no-weak-phrase)',
@@ -68,5 +69,28 @@ test('test parse', () => {
     1
   )
 
-  expect(parseReport(json)).toEqual([annotation1, annotation2, annotation3])
+  expect(parseReport(json, false)).toEqual([
+    annotation1,
+    annotation2,
+    annotation3
+  ])
+})
+
+test('test parse and ignore warnings', () => {
+  const annotation2 = new Annotation(
+    2,
+    'This is a commonly misspelled word. Correct it to useful (sample-rule/misspellings)',
+    'Foo.md',
+    22,
+    7
+  )
+  const annotation3 = new Annotation(
+    2,
+    'sentence should start with an uppercase letter (sample-rule/sentence:uppercase)',
+    'Bar.md',
+    3,
+    1
+  )
+
+  expect(parseReport(json, true)).toEqual([annotation2, annotation3])
 })
diff --git a/action.yml b/action.yml
@@ -8,6 +8,9 @@ inputs:
   textlint-output:
     description: 'The json format output by textlint'
     required: false
+  ignore-warnings:
+    description: 'Ignore Lint Warnings'
+    default: false
 runs:
   using: 'node20'
   main: 'dist/index.js'

diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/main.ts b/src/main.ts
@@ -13,7 +13,9 @@ async function run(): Promise<void> {
     } else {
       json = textlintOutput
     }
-    const annotations = parseReport(json)
+    const ignoreWarnings = core.getBooleanInput('ignore-warnings')
+
+    const annotations = parseReport(json, ignoreWarnings)
     echoMessages(annotations)
 
     const errors = annotations.filter(annotation => {

diff --git a/src/parser.ts b/src/parser.ts
@@ -1,7 +1,10 @@
 import {TextlintResult} from '@textlint/types/src/Message/TextlintResult'
 import {Annotation} from './annotation'
 
-export const parseReport = (json: string): Annotation[] => {
+export const parseReport = (
+  json: string,
+  ignoreWarnings: boolean
+): Annotation[] => {
   const results: TextlintResult[] = JSON.parse(json)
   const annotations: Annotation[] = results.flatMap(result => {
     return result.messages.map(message => {
@@ -14,5 +17,11 @@ export const parseReport = (json: string): Annotation[] => {
       )
     })
   })
-  return annotations
+  if (ignoreWarnings === true) {
+    return annotations.filter(annotation => {
+      return annotation.severityLevel !== 'warning'
+    })
+  } else {
+    return annotations
+  }
 }