docs: Update to typedoc 0.28 and use entryPointStrategy: packages

projectfluent · eemeli · Mar 25, 2025 · Mar 25, 2025 · Mar 25, 2025 · Mar 25, 2025
commit d77cd5d6ef11ac4fe3596c1a4de324a8a17ba78c
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -21,4 +21,4 @@ jobs:
       - run: npm run build --workspaces
       - run: npm test
       - run: npm run lint
-      - run: npm run docs --workspaces
+      - run: npm run docs
diff --git a/README.md b/README.md
@@ -81,7 +81,7 @@ Build and test all packages at once:
     $ npm run build --workspaces
     $ npm run lint
     $ npm run test
-    $ npm run docs --workspaces
+    $ npm run docs
 
 Each package may also be built separately by running `npm run build` in
 its directory.
diff --git a/fluent-bundle/package.json b/fluent-bundle/package.json
@@ -41,7 +41,6 @@
   "scripts": {
     "build": "tsc",
     "postbuild": "rollup -c ../rollup.config.mjs",
-    "docs": "typedoc --options ../typedoc.config.cjs",
     "test": "mocha 'test/*_test.js'"
   },
   "engines": {

diff --git a/fluent-bundle/typedoc.json b/fluent-bundle/typedoc.json
@@ -0,0 +1,3 @@
+{
+  "intentionallyNotExported": ["Pattern", "TemporalObject"]
+}
diff --git a/fluent-dedent/package.json b/fluent-dedent/package.json
@@ -26,7 +26,6 @@
   "scripts": {
     "build": "tsc",
     "postbuild": "rollup -c ../rollup.config.mjs",
-    "docs": "typedoc --options ../typedoc.config.cjs",
     "test": "mocha 'test/*_test.js'"
   },
   "engines": {

diff --git a/fluent-dom/package.json b/fluent-dom/package.json
@@ -36,7 +36,6 @@
   "scripts": {
     "build": "tsc",
     "postbuild": "rollup -c ../rollup.config.mjs --globals cached-iterable:CachedIterable",
-    "docs": "typedoc --options ../typedoc.config.cjs src/index.js",
     "test": "c8 mocha -ui tdd --require ./test/index.js 'test/*_test.js'"
   },
   "engines": {

diff --git a/fluent-dom/typedoc.json b/fluent-dom/typedoc.json
@@ -0,0 +1,3 @@
+{
+  "entryPoints": ["src/index.js"]
+}
diff --git a/fluent-langneg/package.json b/fluent-langneg/package.json
@@ -34,7 +34,6 @@
   "scripts": {
     "build": "tsc",
     "postbuild": "rollup -c ../rollup.config.mjs",
-    "docs": "typedoc --options ../typedoc.config.cjs",
     "test": "mocha 'test/*_test.js'"
   },
   "engines": {

diff --git a/fluent-react/package.json b/fluent-react/package.json
@@ -43,7 +43,6 @@
   "scripts": {
     "build": "tsc -p ./tsconfig.build.json",
     "postbuild": "rollup -c ../rollup.config.mjs --globals @fluent/sequence:FluentSequence,cached-iterable:CachedIterable,react:React",
-    "docs": "typedoc --options ../typedoc.config.cjs --tsconfig ./tsconfig.build.json",
     "test": "jest --collect-coverage"
   },
   "engines": {

diff --git a/fluent-react/typedoc.json b/fluent-react/typedoc.json
@@ -0,0 +1,3 @@
+{
+  "tsconfig": "./tsconfig.build.json",
+}
diff --git a/fluent-sequence/package.json b/fluent-sequence/package.json
@@ -29,7 +29,6 @@
   "scripts": {
     "build": "tsc -p ./tsconfig.build.json",
     "postbuild": "rollup -c ../rollup.config.mjs",
-    "docs": "typedoc --options ../typedoc.config.cjs --tsconfig ./tsconfig.build.json",
     "test": "mocha 'test/*_test.js'"
   },
   "engines": {

diff --git a/fluent-syntax/package.json b/fluent-syntax/package.json
@@ -43,7 +43,6 @@
   "scripts": {
     "build": "tsc",
     "postbuild": "rollup -c ../rollup.config.mjs",
-    "docs": "typedoc --options ../typedoc.config.cjs",
     "test": "mocha 'test/*_test.js'"
   },
   "engines": {

diff --git a/fluent-syntax/typedoc.json b/fluent-syntax/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "categoryOrder": ["Parse", "Serialize", "Data Model"],
+  "excludeInternal": true
+}