v0.28

.config/mocha.fast.json

@@ -5,5 +5,5 @@
     "spec": ["src/test/**/*.test.ts", "src/test/**/*.test.tsx"],
     "timeout": 5000,
     "watch-files": ["src/**/*.ts", "src/**/*.tsx"],
-    "node-option": ["import=tsx"]
+    "node-option": ["import=tsx", "conditions=typedoc-ts"]
 }

.config/mocha.full.json

@@ -3,5 +3,5 @@
     "timeout": 0,
     "spec": ["src/test/**/*.test.ts", "src/test/**/*.test.tsx"],
     "exclude": ["src/test/packages/**"],
-    "node-option": ["import=tsx"]
+    "node-option": ["import=tsx", "conditions=typedoc-ts"]
 }

.config/mocha.test-explorer.json

@@ -1,9 +1,9 @@
 {
     "$schema": "https://json.schemastore.org/mocharc.json",
     "extension": ["ts"],
-    "ignore": ["src/test/slow/**", "src/test/packages/**"],
+    "ignore": [],
     "package": "./package.json",
-    "node-option": ["import=tsx"],
+    "node-option": ["import=tsx", "conditions=typedoc-ts"],
     "slow": 500,
     "spec": ["src/**/*.test.ts", "src/**/*.test.tsx"],
     "timeout": 0,

.config/typedoc.json

@@ -29,6 +29,7 @@
     ],
 
     "excludeExternals": true,
+    "externalPattern": ["**/node_modules/**", "../src/lib/types/**"],
     "excludeInternal": false,
     "excludePrivate": true,
     // "excludeReferences": true,
@@ -59,7 +60,7 @@
     "searchInComments": true,
     "searchInDocuments": true,
     "searchGroupBoosts": {
-        "Classes": 2.0,
+        "Classes": 5.0,
         "Interfaces": 2.0,
         "Enumerations": 2.0,
         "Type Aliases": 2.0

.github/CODE_OF_CONDUCT.md

@@ -17,24 +17,24 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
--   Demonstrating empathy and kindness toward other people
--   Being respectful of differing opinions, viewpoints, and experiences
--   Giving and gracefully accepting constructive feedback
--   Accepting responsibility and apologizing to those affected by our mistakes,
-    and learning from the experience
--   Focusing on what is best not just for us as individuals, but for the
-    overall community
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
 
 Examples of unacceptable behavior include:
 
--   The use of sexualized language or imagery, and sexual attention or
-    advances of any kind
--   Trolling, insulting or derogatory comments, and personal or political attacks
--   Public or private harassment
--   Publishing others' private information, such as a physical or email
-    address, without their explicit permission
--   Other conduct which could reasonably be considered inappropriate in a
-    professional setting
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
 
 ## Enforcement Responsibilities
 

.github/CONTRIBUTING.md

@@ -6,21 +6,21 @@ This document includes a set of guidelines for contributing to TypeDoc. These ar
 
 ## Table of Contents
 
--   [Contributing to TypeDoc](#contributing-to-typedoc)
-    -   [Table of Contents](#table-of-contents)
-    -   [How Can I Contribute?](#how-can-i-contribute)
-        -   [Bug Reports](#bug-reports)
-        -   [Suggestions](#suggestions)
-        -   [Documentation](#documentation)
-        -   [Code](#code)
-    -   [Setup - Git, GitHub, and Node](#setup---git-github-and-node)
-        -   [Installation](#installation)
-    -   [Linting, Building, and Testing](#linting-building-and-testing)
-        -   [Linting](#linting)
-        -   [Building](#building)
-        -   [Testing](#testing)
-    -   [Pull Requests](#pull-requests)
-    -   [Updating Your Branch](#updating-your-branch)
+- [Contributing to TypeDoc](#contributing-to-typedoc)
+  - [Table of Contents](#table-of-contents)
+  - [How Can I Contribute?](#how-can-i-contribute)
+    - [Bug Reports](#bug-reports)
+    - [Suggestions](#suggestions)
+    - [Documentation](#documentation)
+    - [Code](#code)
+  - [Setup - Git, GitHub, and Node](#setup---git-github-and-node)
+    - [Installation](#installation)
+  - [Linting, Building, and Testing](#linting-building-and-testing)
+    - [Linting](#linting)
+    - [Building](#building)
+    - [Testing](#testing)
+  - [Pull Requests](#pull-requests)
+  - [Updating Your Branch](#updating-your-branch)
 
 ## How Can I Contribute?
 
@@ -32,9 +32,9 @@ Before creating a bug report please check [this list][bugs] to see if it has alr
 
 When creating a bug report, explain the problem and include as much additional information as necessary to help maintainers to reproduce it. Ideally, provide an example project which highlights the problem.
 
--   **Use a clear and descriptive title** for the issue to identify the problem
--   **Describe your project setup**. The easier it is for maintainers to reproduce your problem, the more likely it is to be quickly fixed.
--   **Explain what you expected to see instead and why**
+- **Use a clear and descriptive title** for the issue to identify the problem
+- **Describe your project setup**. The easier it is for maintainers to reproduce your problem, the more likely it is to be quickly fixed.
+- **Explain what you expected to see instead and why**
 
 ### Suggestions
 
@@ -44,18 +44,18 @@ Before creating a feature request, please check [this list][suggestions] to see
 
 When creating an enhancement request, explain your use case and ultimate goal. This will make it possible for contributors to suggest existing alternatives which may already meet your requirements.
 
--   **Use a clear and descriptive title** for the issue to identify the suggestion.
--   **Provide an example where this enhancement would improve TypeDoc**
--   **If possible, list another documentation generator where this feature exists**
+- **Use a clear and descriptive title** for the issue to identify the suggestion.
+- **Provide an example where this enhancement would improve TypeDoc**
+- **If possible, list another documentation generator where this feature exists**
 
 ### Documentation
 
 TypeDoc is documented in 4 primary areas.
 
--   This repo's [README.md](https://github.com/TypeStrong/typedoc/blob/master/README.md)
--   The website guides hosted at [TypeStrong/typedoc-site](https://github.com/TypeStrong/typedoc-site/)
--   Doc comments of source files which are rendered in the [api docs](https://typedoc.org/api/)
--   The [option descriptions](https://github.com/TypeStrong/typedoc/blob/ce0654295698e2bb2badf5f93d388bd977da3c46/src/lib/application.ts#L66) used by the `--help` command
+- This repo's [README.md](https://github.com/TypeStrong/typedoc/blob/master/README.md)
+- The website guides hosted at [TypeStrong/typedoc-site](https://github.com/TypeStrong/typedoc-site/)
+- Doc comments of source files which are rendered in the [api docs](https://typedoc.org/api/)
+- The [option descriptions](https://github.com/TypeStrong/typedoc/blob/ce0654295698e2bb2badf5f93d388bd977da3c46/src/lib/application.ts#L66) used by the `--help` command
 
 If you would like to improve the documentation in any of these areas, please open an issue if there isn't one already to discuss what you would like to improve. Then submit a [Pull Request](#pull-requests) to this repo, (or to [TypeStrong/typedoc-site](https://github.com/TypeStrong/typedoc-site/) in the case of guides).
 
@@ -70,29 +70,29 @@ If you have started work on an issue and get stuck or want a second opinion on y
 
 ## Setup - Git, GitHub, and Node
 
-If you don't already have [Git] installed, install it first. You will need it to contribute to TypeDoc. You will also need to install [Node]. TypeDoc requires at least npm 4, so if you are running Node 7.3.0 or older you will need to upgrade npm using `npm install --global npm@^4`.
+If you don't already have [Git] installed, install it first. You will need it to contribute to TypeDoc. You will also need to install [Node] and pnpm.
 
 #### Installation
 
 1. Fork the TypeDoc repository - https://github.com/TypeStrong/typedoc/fork
 1. Open a terminal, or "Git Bash" on Windows.
 1. Use `cd` to move to the directory that you want to work in.
 1. Clone your repository, replace USER with your GitHub username:
-    ```bash
-    git clone https://github.com/USER/typedoc
-    ```
+   ```bash
+   git clone https://github.com/USER/typedoc
+   ```
 1. Add the TypeDoc repo as a remote repository
-    ```bash
-    git remote add typedoc https://github.com/TypeStrong/typedoc
-    ```
+   ```bash
+   git remote add typedoc https://github.com/TypeStrong/typedoc
+   ```
 1. Install dependencies:
-    ```bash
-    npm install
-    ```
+   ```bash
+   pnpm install
+   ```
 1. Build:
-    ```bash
-    npm run build
-    ```
+   ```bash
+   pnpm build
+   ```
 1. Open the typedoc folder in your favorite editor. If you don't have one, try [Visual Studio Code][vscode]
 
 ## Linting, Building, and Testing
@@ -101,21 +101,21 @@ Once you have cloned TypeDoc, you can lint, build, and test the code from your t
 
 #### Linting
 
-To lint the TypeDoc code, run `npm run lint`. This will start eslint and check all files for stylistic problems. You can also install an eslint plugin for your editor to show most style problems as you type.
+To lint the TypeDoc code, run `pnpm run lint`. This will start eslint and check all files for stylistic problems. You can also install an eslint plugin for your editor to show most style problems as you type.
 
-You can automatically fix some style problems by running `npm run lint -- --write`.
+You can automatically fix some style problems by running `pnpx dprint fmt`.
 
 #### Building
 
-To compile the TypeDoc source, run `npm run build`. This will start the TypeScript compiler and output the compiled JavaScript to the `dist` folder.
+To compile the TypeDoc source, run `pnpm build`. This will start the TypeScript compiler and output the compiled JavaScript to the `dist` folder.
 
 #### Testing
 
-TypeDoc includes an extensive set of tests that describe its output. To validate any changes you have made run `npm test`.
+TypeDoc includes an extensive set of tests that describe its output. To validate any changes you have made run `pnpm test`.
 This will run a subset of TypeDoc's tests intended for quick development checks.
-Tests which take more than half a second are located in `src/test/slow`, and will only be run if you run `npm run test:full`.
+Tests which take more than half a second are located in `src/test/slow`, and will only be run if you run `pnpm run test:full`.
 
-If you have changed the TypeDoc output, it will cause tests to fail. Once you have validated that the introduced changes were intended, run `npm run rebuild_specs` to update the spec files for the new output.
+If you have changed the TypeDoc output, it will cause tests to fail. Once you have validated that the introduced changes were intended, run `pnpm run rebuild_specs` to update the spec files for the new output.
 
 Additional tests are contained within the `converter2` directory that look for specific issues with previous
 builds and may be more appropriate for adding a test for a bugfix.
@@ -128,7 +128,7 @@ There is also a script to visually compare the differences between changes. To s
 
 Once you have finished working on an issue, you can submit a pull request to have your changes merged into the TypeDoc repository and included in the next release.
 
-Before submitting a pull request, make sure that there are no linting problems (`npm run lint`), all tests pass (`npm test`), and your branch is up to date. Its also a good idea to join the TypeScript [discord] and visit the `#typedoc` channel to discuss how best to implement changes.
+Before submitting a pull request, make sure that there are no linting problems (`pnpm run lint`), all tests pass (`pnpm test`), and your branch is up to date. Its also a good idea to join the TypeScript [discord] and visit the `#typedoc` channel to discuss how best to implement changes.
 
 If your change is user facing, consider updating `CHANGELOG.md` to describe the change you have made. If you don't, the maintainer who merges your pull request will do it for you.
 

.github/ISSUE_TEMPLATE/bug_report.md

@@ -38,7 +38,7 @@ If this is not possible, include at least:
 
 ## Environment
 
--   Typedoc version:
--   TypeScript version:
--   Node.js version:
--   OS:
+- Typedoc version:
+- TypeScript version:
+- Node.js version:
+- OS:

.github/workflows/build-site.yml

@@ -17,10 +17,12 @@ jobs:
               uses: actions/setup-node@v4
               with:
                   node-version: 20
+            - name: Set up pnpm
+              run: npm i -g pnpm@10
             - name: Install
-              run: npm ci
+              run: pnpm install
             - name: Build
-              run: npm run build
+              run: pnpm run build
             - name: Build Site
               run: ./scripts/build_site.sh
             - name: Upload static files as artifact

.github/workflows/ci.yml

@@ -14,18 +14,20 @@ jobs:
               uses: actions/setup-node@v4
               with:
                   node-version: ${{ matrix.node }}
+            - name: Set up pnpm
+              run: npm i -g pnpm@10
             - name: Install
-              run: npm ci
+              run: pnpm install
             - name: Build
-              run: npm run build
+              run: pnpm run build
             - name: Test
               run: |
                   if node -e "process.exit(Number(+process.versions.node.slice(0, 2) < 23))"; then
                     export NODE_OPTIONS="--no-experimental-strip-types"
                   fi
-                  npm run test:full
+                  pnpm run test:full
             - name: Lint
-              run: npm run lint
+              run: pnpm run lint
             - name: Circular dependency check
               uses: gerrit0/[email protected]
               with:
@@ -40,16 +42,18 @@ jobs:
               uses: actions/setup-node@v4
               with:
                   node-version: 22.4.1
+            - name: Set up pnpm
+              run: npm i -g pnpm@10
             - name: Install
-              run: npm ci
+              run: pnpm install
             - name: Build
               run: |
                   node scripts/set_strict.js false
-                  npm run build
+                  pnpm run build
             - name: Test
-              run: npm run test:full
+              run: pnpm run test:full
             - name: Lint
-              run: npm run lint -- --max-warnings 0
+              run: pnpm run lint
     build-windows:
         runs-on: windows-latest
         name: Node 18 Windows
@@ -60,13 +64,13 @@ jobs:
               uses: actions/setup-node@v4
               with:
                   node-version: 18
-            - name: Upgrade npm
-              run: npm i -g npm@10
+            - name: Set up pnpm
+              run: npm i -g pnpm@10
             - name: Install
-              run: npm ci
+              run: pnpm install
             - name: Build
-              run: npm run build
+              run: pnpm run build
             - name: Test
-              run: npm run test:full
+              run: pnpm run test:full
             - name: Lint
-              run: npm run lint -- --max-warnings 0
+              run: pnpm run lint

.github/workflows/publish-beta.yml

@@ -19,20 +19,20 @@ jobs:
               uses: actions/setup-node@v4
               with:
                   node-version: "18"
-            - name: Upgrade npm
+            - name: Setup pnpm
               if: steps.check.outputs.changed == 'true' && contains(steps.check.outputs.version, 'beta')
-              run: npm i -g npm@latest
+              run: npm i -g pnpm@10
             - name: Install
               if: steps.check.outputs.changed == 'true' && contains(steps.check.outputs.version, 'beta')
-              run: npm ci
+              run: pnpm install
             - name: Test
               if: steps.check.outputs.changed == 'true' && contains(steps.check.outputs.version, 'beta')
-              run: npm test
+              run: pnpm test
             - name: Setup publish token
               if: steps.check.outputs.changed == 'true' && contains(steps.check.outputs.version, 'beta')
               run: echo "//registry.npmjs.org/:_authToken=${NPM_AUTH_TOKEN}" > .npmrc
               env:
                   NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
             - name: Publish
               if: steps.check.outputs.changed == 'true' && contains(steps.check.outputs.version, 'beta')
-              run: npm publish --tag beta
+              run: pnpm publish --tag beta --no-git-checks