Merge pull request #240 from ForgeRock/redo-format

chore: change-format-again

Author: ryanbas21

.github/workflows/ci.yml

@@ -66,7 +66,7 @@ jobs:
           retention-days: 30
 
       - name: build docs
-        run: pnpm typedoc
+        run: pnpm generate-docs
 
       - name: preview-docs
         uses: rajyan/preview-pages@v1

.github/workflows/publish.yml

@@ -91,7 +91,7 @@ jobs:
           token: ${{ secrets.CODECOV_TOKEN }}
 
       - name: Build docs
-        run: pnpm typedoc
+        run: pnpm generate-docs
 
       - name: Publish api docs
         if: steps.changesets.outputs.published == 'true'

eslint.config.mjs

@@ -23,6 +23,7 @@ export default [
   {
     ignores: [
       '**/dist',
+      '**/docs',
       '**/vite.config.*.timestamp*',
       '**/vitest.config.*.timestamp*',
       '**/out-tsc',

package.json

@@ -16,13 +16,13 @@
     "build": "nx affected --target=build",
     "changeset": "changeset",
     "ci:release": "pnpm publish -r --no-git-checks && changeset tag",
-    "ci:version": "changeset version && pnpm install --no-frozen-lockfile && pnpm format",
+    "ci:version": "changeset version && pnpm install --no-frozen-lockfile && pnpm nx format:write",
     "circular-dep-check": "madge --circular .",
     "clean": "shx rm -rf ./{coverage,dist,docs,node_modules,tmp}/ ./{packages,e2e}/*/{dist,node_modules}/ && git clean -fX -e \"!.env*,nx-cloud.env\"",
     "commit": "git cz",
     "commitlint": "commitlint --edit",
     "create-package": "nx g @nx/js:library",
-    "docs": "nx affected --target=typedoc",
+    "generate-docs": "typedoc",
     "format": "pnpm nx format:write",
     "lint": "nx affected --target=lint",
     "local-release": "pnpm ts-node tools/release/release.ts",
@@ -48,6 +48,7 @@
       "path": "./node_modules/cz-conventional-changelog"
     }
   },
+  "dependencies": {},
   "devDependencies": {
     "@changesets/changelog-github": "^0.5.0",
     "@changesets/cli": "^2.27.9",
@@ -132,6 +133,5 @@
   },
   "nx": {
     "includedScripts": []
-  },
-  "dependencies": {}
+  }
 }

packages/sdk-effects/iframe-manager/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "name": "@forgerock/iframe-manager",
+  "entryPoints": ["src/index.ts"]
+}

packages/sdk-effects/storage/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "name": "@forgerock/storage",
+  "entryPoints": ["src/index.ts"]
+}

typedoc.json

@@ -10,7 +10,7 @@
   "hideGenerator": true,
   "searchInComments": true,
   "navigationLinks": {
-    "GitHub": "https://github.com/yourusername/yourrepo"
+    "GitHub": "https://github.com/ForgeRock/ping-javascript-sdk"
   },
   "packageOptions": {
     "tsconfig": "tsconfig.lib.json",