Initial commit

.eslintignore

@@ -0,0 +1,4 @@
+dist/
+lib/
+node_modules/
+jest.config.js

.eslintrc.json

@@ -0,0 +1,55 @@
+{
+    "plugins": ["jest", "@typescript-eslint"],
+    "extends": ["plugin:github/recommended"],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+      "ecmaVersion": 9,
+      "sourceType": "module",
+      "project": "./tsconfig.json"
+    },
+    "rules": {
+      "eslint-comments/no-use": "off",
+      "import/no-namespace": "off",
+      "no-unused-vars": "off",
+      "no-console": "off",
+      "@typescript-eslint/no-unused-vars": "error",
+      "@typescript-eslint/explicit-member-accessibility": ["error", {"accessibility": "no-public"}],
+      "@typescript-eslint/no-require-imports": "error",
+      "@typescript-eslint/array-type": "error",
+      "@typescript-eslint/await-thenable": "error",
+      "@typescript-eslint/ban-ts-comment": "error",
+      "camelcase": "off",
+      "@typescript-eslint/consistent-type-assertions": "error",
+      "@typescript-eslint/explicit-function-return-type": ["error", {"allowExpressions": true}],
+      "@typescript-eslint/func-call-spacing": ["error", "never"],
+      "@typescript-eslint/no-array-constructor": "error",
+      "@typescript-eslint/no-empty-interface": "error",
+      "@typescript-eslint/no-explicit-any": "error",
+      "@typescript-eslint/no-extraneous-class": "error",
+      "@typescript-eslint/no-for-in-array": "error",
+      "@typescript-eslint/no-inferrable-types": "error",
+      "@typescript-eslint/no-misused-new": "error",
+      "@typescript-eslint/no-namespace": "error",
+      "@typescript-eslint/no-non-null-assertion": "warn",
+      "@typescript-eslint/no-unnecessary-qualifier": "error",
+      "@typescript-eslint/no-unnecessary-type-assertion": "error",
+      "@typescript-eslint/no-useless-constructor": "error",
+      "@typescript-eslint/no-var-requires": "error",
+      "@typescript-eslint/prefer-for-of": "warn",
+      "@typescript-eslint/prefer-function-type": "warn",
+      "@typescript-eslint/prefer-includes": "error",
+      "@typescript-eslint/prefer-string-starts-ends-with": "error",
+      "@typescript-eslint/promise-function-async": "error",
+      "@typescript-eslint/require-array-sort-compare": "error",
+      "@typescript-eslint/restrict-plus-operands": "error",
+      "semi": "off",
+      "@typescript-eslint/semi": ["error", "never"],
+      "@typescript-eslint/type-annotation-spacing": "error",
+      "@typescript-eslint/unbound-method": "error"
+    },
+    "env": {
+      "node": true,
+      "es6": true,
+      "jest/globals": true
+    }
+  }

.gitattributes

@@ -0,0 +1 @@
+dist/** -diff linguist-generated=true 

.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+  # Enable version updates for npm
+  - package-ecosystem: 'npm'
+    # Look for `package.json` and `lock` files in the `root` directory
+    directory: '/'
+    # Check the npm registry for updates every day (weekdays)
+    schedule:
+      interval: 'daily'

.github/workflows/test.yml

@@ -0,0 +1,22 @@
+name: 'build-test'
+on: # rebuild any PRs and main branch changes
+  pull_request:
+  push:
+    branches:
+      - main
+      - 'releases/*'
+
+jobs:
+  build: # make sure build/ci work properly
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - run: |
+          npm install
+      - run: |
+          npm run all
+  test: # make sure the action works on a clean machine without building
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ./

.gitignore

@@ -0,0 +1,99 @@
+# Dependency directory
+node_modules
+
+# Rest pulled from https://github.com/github/gitignore/blob/master/Node.gitignore
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# OS metadata
+.DS_Store
+Thumbs.db
+
+# Ignore built ts files
+__tests__/runner/*
+lib/**/*

.prettierignore

@@ -0,0 +1,3 @@
+dist/
+lib/
+node_modules/

.prettierrc.json

@@ -0,0 +1,10 @@
+{
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "none",
+  "bracketSpacing": false,
+  "arrowParens": "avoid"
+}

CODEOWNERS

@@ -0,0 +1 @@
+* @actions/actions-runtime

LICENSE

@@ -0,0 +1,22 @@
+
+The MIT License (MIT)
+
+Copyright (c) 2021 Tamás A. Roncsák
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,82 @@
+<a href="https://github.com/roncsak/check"><img alt="typescript-action status" src="https://github.com/roncsak/check/workflows/test/badge.svg"></a>
+
+# Parse results of Android's linter run by gradle and post comments to Pull Requests
+
+The main goal of this action to have a visual representation of lint results on the UI.  
+Currently the severity of issues have no effect on the PR: The PR is not blocked in case a lint error found.
+
+## Prerequisite
+
+ - (Source code) Configure lint in build.gradle of the module
+ - (GH Action) You need to checkout the project with the following head ref of the pull request. (Example below)
+ - (GH Action) Run gradle lint with basefile option 
+
+```groovy
+android {
+  lintOptions {
+    baseline file("lint-baseline.xml")
+    abortOnError false
+  }
+}
+
+```
+
+```yaml
+- name: Checkout project
+  uses: actions/checkout@v2
+  with:
+    ref: ${{ github.event.pull_request.head.ref }}
+
+- name: Lint with gradle
+  run : gradle lint -Dlint.baselines.continue=true
+
+- name: Parse and report gradle lint issues
+  uses: roncsak/[email protected]
+  with:
+    token: ${{ secrets.GITHUB_TOKEN }}
+    gradleLintBaselineReportPath: 'app/lint-baseline.xml'
+    gradleLintReportPath: 'app/build/reports/lint-results.xml'
+
+```
+
+## Optional input arguments
+
+### `token`
+A token (GitHub or PAT) with write permission to the repository.
+**Default:** `secrets.GITHUB_TOKEN`
+
+### `gradleLintBaselineReportPath`
+The relative path of the lint-baseline.xml
+**Default:** `app/lint-baseline.xml`
+
+### `gradleLintReportPath`
+The relative path of the lint-results.xml
+**Default:** `app/build/reports/lint-results.xml`
+
+## Workflow
+
+ 1. The action is triggered by a Pull Request (creating or updating one)
+ 1. The baseline report file is commited to the source code
+ 1. Parse report file into a JSON array
+ 1. Iterate through the JSON array and create review/regular comments to the PR
+
+## Example usage
+
+```yaml
+- name: Parse and report gradle lint issues
+  uses: roncsak/[email protected]
+  with:
+    token: ${{ secrets.GITHUB_TOKEN }}
+    gradleLintBaselineReportPath: 'app/lint-baseline.xml'
+    gradleLintReportPath: 'app/build/reports/lint-results.xml'
+```
+
+## Planned features and improvements
+ - Throttling
+   This action uses GitHub's REST API. When the action sends too many requests in too little time the action will likely hit errors due to rate and/or abuse limits. In order to automatically throttle requests as recommended in (GitHub’s best practices for integrators)[https://docs.github.com/en/rest/guides/best-practices-for-integrators] some improvements needed.
+ - Put the reports to GitHub artifacts  
+   Android's linter produce html reports beside xml reports. It would be good to download those html reports and check issues visually.
+ - Have control over blocking the merge of PR in case of specific severity issues  
+   Currently if an issue with Error severity is found the merge is still allowed, however it would be crucial to not let source code to be merged with errors in it. For greater control, an input variable will be introduced what is used to define which severity level blocks the merge.
+ - Have control over what type of issues (based on severity) want to post to GitHub comments.
+ - Integrate other tools ?

__tests__/androidGradleLint.test.ts

@@ -0,0 +1,6 @@
+import parseGradleReport from '../src/tools/androidGradleLint'
+
+test('parseGradleReport(lint-single.xml)', async () => {
+  const received = await parseGradleReport(`${__dirname}/reports/lint-single.xml`)
+  expect(received).toHaveLength(1)
+})