From 6546a132a1847baaba09b43d60f8bafa65c79cd9 Mon Sep 17 00:00:00 2001 From: linusha Date: Wed, 7 Dec 2022 12:15:03 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=9B=A0=EF=B8=8F:=20add=20github=20action?= =?UTF-8?q?=20counting=20missing=20doc=20strings?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .eslintrc.js | 14 ++++++++++ .../{check_docs.yml => check_docs_build.yml} | 0 .github/workflows/check_docs_coverage.yml | 27 +++++++++++++++++++ 3 files changed, 41 insertions(+) create mode 100644 .eslintrc.js rename .github/workflows/{check_docs.yml => check_docs_build.yml} (100%) create mode 100644 .github/workflows/check_docs_coverage.yml diff --git a/.eslintrc.js b/.eslintrc.js new file mode 100644 index 0000000000..f60cfe8cc3 --- /dev/null +++ b/.eslintrc.js @@ -0,0 +1,14 @@ +module.exports = { + 'plugins': [ + 'jsdoc' + ], + 'rules': { + "jsdoc/require-jsdoc": 'error' + }, + "parser": "@babel/eslint-parser", + parserOptions: { + requireConfigFile: false, + ecmaVersion: 2018, + sourceType: 'module' + } +} diff --git a/.github/workflows/check_docs.yml b/.github/workflows/check_docs_build.yml similarity index 100% rename from .github/workflows/check_docs.yml rename to .github/workflows/check_docs_build.yml diff --git a/.github/workflows/check_docs_coverage.yml b/.github/workflows/check_docs_coverage.yml new file mode 100644 index 0000000000..405e7e9822 --- /dev/null +++ b/.github/workflows/check_docs_coverage.yml @@ -0,0 +1,27 @@ +name: Check Docs Coverage + +on: + pull_request: + workflow_dispatch: + push: + +jobs: + check: + name: Check Docs Coverage + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v2 + - name: Setup node + uses: actions/setup-node@v2 + with: + node-version: '18.12.1' + - name: Install eslint + run: npm install eslint + - name: Install jsdoc plugin for eslint + run: npm install eslint-plugin-jsdoc + - name: Install eslint parser for babel + run: npm install @babel/eslint-parser + - name: Run eslint + run: npx eslint -c .eslintrc.js lively.*/*.js +