Text on external projects (#52)

* Add external tests

* Fixes

* Tweaks

* Tweaks to better test on external repos

* Add correct settings

* Fix deprecated action

* Replace deprecated `::set-output`

* Add missing work directory

* Update README

* Fix README

Author: voxpelli

.github/workflows/external.yml

@@ -0,0 +1,93 @@
+name: Test External
+
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - '*'
+  pull_request:
+    branches:
+      - master
+  workflow_dispatch:
+    inputs:
+      moduleSet:
+        description: 'Module set'
+        required: true
+        default: 'nonCompliant'
+        type: choice
+        options:
+        - compliant
+        - nonCompliant
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  read_external_projects:
+    name: Read list of ${{ github.event.inputs.moduleSet || 'compliant' }} external projects
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.set-matrix.outputs.matrix }}
+    steps:
+      - uses: actions/checkout@v3
+      - id: set-matrix
+        run: echo "matrix=$(cat workflow-external.json | jq -c '.${{ github.event.inputs.moduleSet || 'compliant' }}')" >> $GITHUB_OUTPUT
+  test_external:
+    needs: read_external_projects
+    name: Test ${{ matrix.project }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        node_version: [lts/*]
+        project: ${{ fromJson(needs.read_external_projects.outputs.matrix) }}
+    steps:
+      - name: Checkout main project
+        uses: actions/checkout@v3
+        with:
+          path: main
+      - name: Checkout ${{ matrix.project }}
+        uses: actions/checkout@v3
+        with:
+          repository: ${{ matrix.project }}
+          path: project
+      - name: Use Node.js ${{ matrix.node_version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node_version }}
+
+      - name: Determine npm cache directory windows
+        id: npm-cache-dir-windows
+        if: runner.os == 'Windows'
+        run: echo "dir=$(npm config get cache)" >> $env:GITHUB_OUTPUT
+      - name: Determine npm cache directory non-windows
+        id: npm-cache-dir
+        if: runner.os != 'Windows'
+        run: echo "dir=$(npm config get cache)" >> $GITHUB_OUTPUT
+      - uses: actions/cache@v3
+        with:
+          path: ${{ steps.npm-cache-dir-windows.outputs.dir || steps.npm-cache-dir.outputs.dir }}
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json', '**/package.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+
+      - name: install main
+        run: npm ci --no-audit --no-fund
+        working-directory: ./main
+      - name: install project
+        run: '[ -f package-lock.json ] && npm ci --force || npm install --force'
+        working-directory: ./project
+      - name: modify project eslint config
+        run: sed 's/"@socketsecurity"/"..\/main\/test.eslintrc"/' .eslintrc > tmp.eslintrc && rm .eslintrc && mv tmp.eslintrc .eslintrc
+        working-directory: ./project
+      - name: modify project eslint config (ESM version)
+        run: sed 's/"@socketsecurity\/eslint-config\/jsdoc"/"..\/main\/test-jsdoc.eslintrc"/' .eslintrc > tmp.eslintrc && rm .eslintrc && mv tmp.eslintrc .eslintrc
+        working-directory: ./project
+      - name: run eslint
+        run: ../main/node_modules/.bin/eslint --resolve-plugins-relative-to ../main --ext js --ext cjs --ext mjs --report-unused-disable-directives .
+        working-directory: ./project

.github/workflows/npm-test.yml

@@ -3,12 +3,12 @@ name: CI
 on:
   push:
     branches:
-      - main
+      - master
     tags:
       - '*'
   pull_request:
     branches:
-      - main
+      - master
 
 permissions:
   contents: read

README.md

@@ -22,3 +22,15 @@ For projects without a `tsconfig.json`:
   "root": true
 }
 ```
+
+For projects being typed with JSDoc:
+
+```json
+{
+  "extends": "@socketsecurity/eslint-config/jsdoc",
+  "root": true,
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  }
+}
+```

index.js

@@ -14,7 +14,8 @@ module.exports = {
   },
   'plugins': [
     '@typescript-eslint',
-    'react-hooks'
+    'react-hooks',
+    'unicorn'
   ],
   'extends': ['./lib/standard-eslint-ts'],
   'settings': {
@@ -64,6 +65,8 @@ module.exports = {
     'react-hooks/rules-of-hooks': 'off',
     'react-hooks/exhaustive-deps': 'off',
 
+    'unicorn/expiring-todo-comments': 'warn',
+
     '@typescript-eslint/consistent-type-imports': [
       'error',
       { 'prefer': 'type-imports', 'disallowTypeAnnotations': true }

jsdoc.js

@@ -0,0 +1,27 @@
+'use strict'
+
+module.exports = {
+  plugins: [
+    'jsdoc'
+  ],
+  extends: [
+    './',
+    'plugin:jsdoc/recommended'
+  ],
+  root: true,
+  settings: {
+    jsdoc: {
+      mode: 'typescript'
+    }
+  },
+  rules: {
+    'jsdoc/check-types': 'off',
+    'jsdoc/no-undefined-types': 'off',
+    'jsdoc/require-jsdoc': 'warn',
+    'jsdoc/require-param-description': 'off',
+    'jsdoc/require-property-description': 'off',
+    'jsdoc/require-returns-description': 'off',
+    'jsdoc/require-yields': 'off',
+    'jsdoc/valid-types': 'off'
+  }
+}