Merge pull request #638 from projectfluent/typedoc-update

Update to typedoc 0.28 and use entryPointStrategy: packages

Author: eemeli

.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

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.

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": {

fluent-bundle/src/builtins.ts

@@ -50,8 +50,8 @@ const NUMBER_ALLOWED = [
  *
  *     pi = The value of π is {NUMBER($pi, maximumFractionDigits: 2)}.
  *
- * The implementation expects an array of `FluentValues` representing the
- * positional arguments, and an object of named `FluentValues` representing the
+ * The implementation expects an array of {@link FluentValue | FluentValues} representing the
+ * positional arguments, and an object of named {@link FluentValue | FluentValues} representing the
  * named parameters.
  *
  * The following options are recognized:
@@ -121,8 +121,8 @@ const DATETIME_ALLOWED = [
  *
  *     now = It's {DATETIME($today, month: "long")}.
  *
- * The implementation expects an array of `FluentValues` representing the
- * positional arguments, and an object of named `FluentValues` representing the
+ * The implementation expects an array of {@link FluentValue | FluentValues} representing the
+ * positional arguments, and an object of named {@link FluentValue | FluentValues} representing the
  * named parameters.
  *
  * The following options are recognized:

fluent-bundle/src/index.ts

@@ -1,10 +1,8 @@
 /**
- * @module fluent
- * @overview
- *
- * `fluent` is a JavaScript implementation of Project Fluent, a localization
+ * A JavaScript implementation of Project Fluent, a localization
  * framework designed to unleash the expressive power of the natural language.
  *
+ * @module
  */
 
 export type { Message } from "./ast.js";

fluent-bundle/src/resolver.ts

@@ -1,8 +1,4 @@
-/* global Intl */
-
 /**
- * @overview
- *
  * The role of the Fluent resolver is to format a `Pattern` to an instance of
  * `FluentValue`. For performance reasons, primitive strings are considered
  * such instances, too.

fluent-bundle/src/types.ts

@@ -63,7 +63,7 @@ export abstract class FluentType<T> {
 }
 
 /**
- * A `FluentType` representing no correct value.
+ * A {@link FluentType} representing no correct value.
  */
 export class FluentNone extends FluentType<string> {
   /**
@@ -83,7 +83,7 @@ export class FluentNone extends FluentType<string> {
 }
 
 /**
- * A `FluentType` representing a number.
+ * A {@link FluentType} representing a number.
  *
  * A `FluentNumber` instance stores the number value of the number it
  * represents. It may also store an option bag of options which will be passed
@@ -120,7 +120,7 @@ export class FluentNumber extends FluentType<number> {
 }
 
 /**
- * A `FluentType` representing a date and time.
+ * A {@link FluentType} representing a date and time.
  *
  * A `FluentDateTime` instance stores a Date object, Temporal object, or a number
  * as a numerical timestamp in milliseconds. It may also store an

fluent-bundle/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../tsconfig.json",
+  "extends": "../tsconfig.base.json",
   "compilerOptions": {
     "outDir": "./esm",
     "rootDir": "./src"

fluent-bundle/typedoc.json

@@ -0,0 +1,3 @@
+{
+  "intentionallyNotExported": ["Pattern", "TemporalObject"]
+}

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": {