@pikokr/command.ts 4.0.2-dev.6d75eff → 4.0.2-dev.c1a6596

package/.github/workflows/docs.yml

@@ -0,0 +1,79 @@
+name: Documentation
+on:
+  push:
+    branches:
+      - 'dev'
+      - 'master'
+      - '!docs'
+    tags:
+      - '*'
+jobs:
+  build:
+    name: Build documentation
+    runs-on: ubuntu-latest
+    outputs:
+      BRANCH_NAME: ${{ steps.env.outputs.BRANCH_NAME }}
+      BRANCH_OR_TAG: ${{ steps.env.outputs.BRANCH_OR_TAG }}
+      SHA: ${{ steps.env.outputs.SHA }}
+    if: github.repository_owner == 'pikokr'
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Install node.js v16
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16
+          cache: 'yarn'
+          cache-dependency-path: yarn.lock
+      - name: Install dependencies
+        run: yarn --immutable
+
+      - name: Build docs
+        run: yarn docs
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v2
+        with:
+          name: docs
+          path: docs/docs.json
+      - name: Set outputs for upload job
+        id: env
+        run: |
+          echo "::set-output name=BRANCH_NAME::${GITHUB_REF_NAME}"
+          echo "::set-output name=BRANCH_OR_TAG::${GITHUB_REF_TYPE}"
+          echo "::set-output name=SHA::${GITHUB_SHA}"
+  upload:
+    name: Upload Documentation
+    needs: build
+    runs-on: ubuntu-latest
+    env:
+      BRANCH_NAME: ${{ needs.build.outputs.BRANCH_NAME }}
+      BRANCH_OR_TAG: ${{ needs.build.outputs.BRANCH_OR_TAG }}
+      SHA: ${{ needs.build.outputs.SHA }}
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v2
+        with:
+          name: docs
+          path: docs
+
+      - name: Checkout docs repository
+        uses: actions/checkout@v2
+        with:
+          repository: 'pikokr/docs'
+          token: ${{ secrets.PIKOKR_DOCS }}
+          path: 'out'
+
+      - name: Move docs to correct directory
+        run: |
+          mkdir -p out/command.ts
+          mv docs/docs.json out/command.ts/${BRANCH_NAME}.json
+      - name: Commit and push
+        run: |
+          cd out
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+          git add .
+          git commit -m "Docs build for ${BRANCH_OR_TAG} ${BRANCH_NAME}: ${SHA}" || true
+          git push

package/docs/index.yml

@@ -0,0 +1,5 @@
+- name: General
+  files:
+    - name: Welcome
+      id: welcome
+      path: ../../README.md

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@pikokr/command.ts",
   "description": "Discord.js command framework for typescript.",
-  "version": "4.0.2-dev.6d75eff",
+  "version": "4.0.2-dev.c1a6596",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "MIT",
   "devDependencies": {
+    "@discordjs/ts-docgen": "^0.3.4",
     "@swc/core": "^1.2.135",
     "@types/lodash": "^4.14.172",
     "all-contributors-cli": "^6.20.0",
@@ -13,7 +14,7 @@
     "prettier": "^2.2.1",
     "ts-node": "^10.1.0",
     "tsup": "^5.11.12",
-    "typedoc": "^0.20.35"
+    "typedoc": "^0.22.11"
   },
   "dependencies": {
     "@types/node": "^14.14.37",
@@ -32,6 +33,7 @@
     "prepack": "yarn build",
     "build": "tsup-node",
     "docs:dev": "typedoc",
-    "docs:build": "typedoc"
+    "docs:build": "typedoc",
+    "docs": "typedoc --json docs/typedoc-out.json src/index.ts && ts-node scripts/docs"
   }
 }

package/scripts/docs.ts

@@ -0,0 +1,11 @@
+/*
+ * Copyright (c) 2022 pikokr. Licensed under the MIT license
+ */
+
+import { runGenerator } from '@discordjs/ts-docgen'
+
+runGenerator({
+  existingOutput: 'docs/typedoc-out.json',
+  custom: 'docs/index.yml',
+  output: 'docs/docs.json',
+})

package/tsconfig.json

@@ -79,5 +79,5 @@
     "forceConsistentCasingInFileNames": true
     /* Disallow inconsistently-cased references to the same file. */
   },
-  "exclude": ["test", "node_modules", "dist", "tsup.config.ts"]
+  "exclude": ["test", "node_modules", "dist", "tsup.config.ts", "scripts"]
 }