Skip to content

Commit

Permalink
🛠️: add github action counting missing doc strings
Browse files Browse the repository at this point in the history
  • Loading branch information
linusha committed Dec 12, 2022
1 parent dbb1833 commit 6546a13
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 0 deletions.
14 changes: 14 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
module.exports = {
'plugins': [
'jsdoc'
],
'rules': {
"jsdoc/require-jsdoc": 'error'
},
"parser": "@babel/eslint-parser",
parserOptions: {
requireConfigFile: false,
ecmaVersion: 2018,
sourceType: 'module'
}
}
File renamed without changes.
27 changes: 27 additions & 0 deletions .github/workflows/check_docs_coverage.yml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 6546a13

Please sign in to comment.