ci(docs): 👷 auto generated docs

.github/workflows/build.yml

@@ -44,9 +44,13 @@ jobs:
 
       - name: Run tests
         run: pnpm run test
+
       - name: Build
         run: pnpm run build
 
+      - name: Generate Docs
+        run: pnpm run docs
+
       - name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,4 +1,5 @@
 node_modules
 dist
 temp
-coverage
+coverage
+docs

.releaserc.js

@@ -21,7 +21,13 @@ const npm = {
 const git = {
   message:
     "release: :bookmark: ${nextRelease.version} <%= new Date().toLocaleDateString('en-US', {year: 'numeric', month: 'short', day: 'numeric', hour: 'numeric', minute: 'numeric' }) %> [skip ci]\n\n${nextRelease.notes}",
-  assets: ['dist/**', 'package.json', 'pnpm-lock.yaml', 'CHANGELOG.md'],
+  assets: [
+    'dist/**',
+    'package.json',
+    'pnpm-lock.yaml',
+    'CHANGELOG.md',
+    'docs/**',
+  ],
 }
 
 /**

package.json

@@ -16,7 +16,10 @@
     "test:coverage": "vitest run --coverage",
     "lint": "echo \"Lint\"",
     "commit": "cz",
-    "release": "semantic-release"
+    "release": "semantic-release",
+    "docs": "pnpm docs:html && pnpm docs:md",
+    "docs:html": "typedoc --out docs/html",
+    "docs:md": "typedoc --out docs/md --plugin typedoc-plugin-markdown"
   },
   "keywords": [],
   "author": "",
@@ -37,6 +40,8 @@
     "rollup-plugin-typescript-paths": "^1.5.0",
     "semantic-release": "^23.1.1",
     "semantic-release-pnpm": "^1.0.2",
+    "typedoc": "^0.25.13",
+    "typedoc-plugin-markdown": "^4.0.3",
     "typescript": "^5.4.5",
     "vite": "^5.2.11",
     "vite-plugin-dts": "^3.9.1",

src/index.ts

@@ -11,3 +11,5 @@ export {
   downloadFile,
   generatePDF,
 }
+
+export type * from './types'

src/types/GeneralSearch.ts

@@ -16,7 +16,14 @@ export type DateSearch = {
   endDate: string
 }
 
-// TODO document all types
+/**
+ * Search params for an eLibrary General Search
+ * https://elibrary.ferc.gov/eLibrary/search
+ *
+ *
+ *
+ *
+ */
 export type GeneralSearchParams = {
   // ways to search
   docketSearches: DocketSearch[]

src/types/index.ts

@@ -1 +1,5 @@
 export type { GeneralSearchParams, GeneralSearchResult } from './GeneralSearch'
+export type { DownloadFileParams } from './DownloadFile'
+export type { DocketSearchParams, DocketSearchResults } from './DocketSearch'
+export type { NewDocketParams, NewDocketResults } from './NewDocket'
+export type * as Stubs from './stubs'

test/consts/generalSearch.ts

@@ -115,4 +115,5 @@ export const SINGLE_PAGE_SEARCH_PARAMS: GeneralSearchParams = {
   groupBy: 'NONE',
   idolResultID: '',
   allDates: false,
+  curPage: 0,
 }

test/newDocket.test.ts

@@ -1,6 +1,6 @@
 import { describe, expect, test } from 'vitest'
 import NewDocketSearch from '~/search/newDocket'
-import { DEFAULT_NEW_DOCKET_SEARCH } from './consts/newDocketSearch'
+// import { DEFAULT_NEW_DOCKET_SEARCH } from './consts/newDocketSearch'
 
 describe.concurrent('New Docket Search', () => {
   test('Default Search', async () => {

typedoc.config.js

@@ -0,0 +1,6 @@
+/** @type {import('typedoc').TypeDocOptions} */
+export default {
+  // plugin: ['typedoc-plugin-markdown'],
+  entryPoints: ['./src/index.ts'],
+  githubPages: true,
+}