ci: auto publish;

chore: update dependencies

Author: tomchen

.github/workflows/publish.yml

@@ -1,10 +1,28 @@
-name: Publish
+name: Release & Publish
 
 on:
-  release:
-    types: [created]
+  push:
+    tags:
+      - 'v*'
 
 jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ github.ref }}
+          draft: false
+          prerelease: false
+
   publish:
     runs-on: ubuntu-latest
     steps:

.github/workflows/test.yml

@@ -2,10 +2,20 @@ name: Test
 
 on:
   push:
+    paths-ignore:
+      - 'docs/**'
+      - 'README.md'
+      - 'LICENSE'
+      - '.editorconfig'
     branches:
       - main
       - master
   pull_request:
+    paths-ignore:
+      - 'docs/**'
+      - 'README.md'
+      - 'LICENSE'
+      - '.editorconfig'
     branches:
       - main
       - master
@@ -17,9 +27,8 @@ jobs:
       matrix:
         os:
           - ubuntu-latest
-          - macos-latest
           - windows-latest
-        node: [10.x, 12.x, 14.x]
+        node: [10.x, 12.x, 14.x, 15.x]
 
     steps:
       - uses: actions/checkout@v2
@@ -29,7 +38,5 @@ jobs:
           node-version: ${{ matrix.node }}
       - name: Install modules
         run: yarn
-      - name: Build
-        run: yarn build
-      - name: Run tests
+      - name: Build and Test
         run: yarn test

README.md

@@ -31,12 +31,12 @@ Example 1:
  * My class
  * @notExported
  */
-class Cls {
+class MyClass {
   convert(str: string): string {
     return str
   }
 }
-export const me = new Cls()
+export const me = new MyClass()
 ```
 
 Example 2:
@@ -52,7 +52,7 @@ type twoNumbers = [number, number]
 type threeNumbers = [number, number, number]
 
 export type twoOrThreeNumbers = twoNumbers | threeNumbers
-export function sum2(ns: twoOrThreeNumbers): number {
+export function sum(ns: twoOrThreeNumbers): number {
   return ns.reduce((a, b) => a + b)
 }
 ```

package.json

@@ -5,10 +5,10 @@
   "main": "dist/main.js",
   "scripts": {
     "build": "rimraf dist && tsc",
-    "test": "npm run test:gen && npm run test:jest && npm run test:cleanup",
+    "test": "npm run build && npm run test:gen && npm run test:jest && npm run test:cleanup",
     "test:cleanup": "rimraf test/docs test/docs2",
     "test:gen": "npm run test:cleanup && typedoc --options test/typedoc.json && typedoc --options test/typedoc2.json",
-    "test:jest": "jest",
+    "test:jest": "jest --no-cache --runInBand",
     "addscope": "node tools/packagejson name @tomchen/typedoc-plugin-not-exported"
   },
   "publishConfig": {
@@ -42,18 +42,18 @@
   },
   "devDependencies": {
     "@types/jest": "^26.0.20",
-    "@typescript-eslint/eslint-plugin": "^4.14.1",
-    "@typescript-eslint/parser": "^4.14.1",
+    "@typescript-eslint/eslint-plugin": "^4.15.0",
+    "@typescript-eslint/parser": "^4.15.0",
     "cheerio": "^1.0.0-rc.5",
-    "eslint": "^7.18.0",
+    "eslint": "^7.20.0",
     "eslint-config-prettier": "^7.2.0",
     "eslint-plugin-prettier": "^3.3.1",
     "jest": "^26.6.3",
     "prettier": "^2.2.1",
     "rimraf": "^3.0.2",
-    "ts-jest": "^26.4.4",
-    "ts-loader": "^8.0.14",
-    "typedoc": "0.20.16",
-    "typescript": "^4.1.3"
+    "ts-jest": "^26.5.1",
+    "ts-loader": "^8.0.17",
+    "typedoc": "0.20.24",
+    "typescript": "^4.1.5"
   }
 }

src/main.ts

@@ -84,7 +84,10 @@ exports.load = function ({ application }: { application: Application }) {
   }
 }
 
-function isInDocumentableScope(symbol: TypeScript.Symbol, node: TypeScript.Node) {
+function isInDocumentableScope(
+  symbol: TypeScript.Symbol,
+  node: TypeScript.Node
+) {
   for (const decl of symbol.getDeclarations() || []) {
     // Case 1: Included in this namespace/source file
     if (decl.parent === node) return true
@@ -95,12 +98,11 @@ function isInDocumentableScope(symbol: TypeScript.Symbol, node: TypeScript.Node)
     if (
       TypeScript.isSourceFile(node) &&
       TypeScript.isModuleBlock(decl.parent) &&
-      decl.parent.parent.name.getText() === "global"
+      decl.parent.parent.name.getText() === 'global'
     ) {
       return true
     }
   }
 
   return false
 }
-