feat(core): improve parameter and type declaration listings

typedoc2md · Nov 26, 2024 · b323a8a · b323a8a
1 parent 1d33b64
commit b323a8a
Show file tree

Hide file tree

Showing 59 changed files with 7,383 additions and 2,722 deletions.
diff --git a/.changeset/big-teachers-shave.md b/.changeset/big-teachers-shave.md
@@ -3,5 +3,5 @@
 ---
 
 - Implemented typedoc 0.27 compatibility support.
-- Exposed "typeDeclarationFormat=source" option that prints the symbol directly from ts compiler inside a code block (#703).
+- Exposed "typeDeclarationVisibility" option to provide a compacted output structure (#703).
 - The "textContentMappings" option now accepts a string with placeholder or a function with arguments (#693, #715).
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -2,6 +2,7 @@ name: CI
 on:
   push:
     paths:
+      - '.github/workflows/ci.yml'
       - 'packages/typedoc-plugin-markdown/**'
       - '!packages/typedoc-plugin-markdown/README.md'
       - '!packages/typedoc-plugin-markdown/CHANGELOG.md'
@@ -17,17 +18,17 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: ['18']
+        node: ['20']
     name: Node ${{ matrix.node }}
     steps:
       - name: Set Swap Space
         uses: pierotofy/set-swap-space@master
         with:
           swap-size-gb: 10
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
           cache: 'npm'

diff --git a/devtools/packages/fixtures/cli.ts b/devtools/packages/fixtures/cli.ts
@@ -50,7 +50,7 @@ async function main() {
     const outputFileStrategies: ('members' | 'modules')[] =
       config.outputFileStrategies || ['members', 'modules'];
 
-    writeHtml(key, config.entryPoints);
+    //writeHtml(key, config.entryPoints);
     outputFileStrategies.forEach((outputFileStrategy) => {
       config.options.forEach((optionGroup, index: number) => {
         const options = {

diff --git a/docs/pages/docs/options.mdx b/docs/pages/docs/options.mdx
@@ -39,6 +39,7 @@ Options that are used to configure how the output is structured and displayed.
 - [--classPropertiesFormat](./options/display-options.mdx#--classpropertiesformat)
 - [--enumMembersFormat](./options/display-options.mdx#--enummembersformat)
 - [--typeDeclarationFormat](./options/display-options.mdx#--typedeclarationformat)
+- [--typeDeclarationVisibility](./options/display-options.mdx#--typedeclarationvisibility)
 - [--propertyMembersFormat](./options/display-options.mdx#--propertymembersformat)
 - [--tableColumnSettings](./options/display-options.mdx#--tablecolumnsettings)
 

diff --git a/docs/pages/docs/options/display-options.mdx b/docs/pages/docs/options/display-options.mdx
@@ -232,7 +232,7 @@ This option specifies the output format for enumeration members:
   Sets the format of style for type declaration members.
 </Callout>
 
-> Accepts one of `"list"` | `"source"` | `"table"` | `"htmlTable"`. Defaults to `"list"`.
+> Accepts one of `"list"` | `"table"` | `"htmlTable"`. Defaults to `"list"`.
 
 This option specifies the output format for type declaration of variables and type aliases.
 
@@ -246,6 +246,25 @@ This option specifies the output format for type declaration of variables and ty
 }
 ```
 
+## --typeDeclarationVisibility
+
+<Callout emoji="💡">
+  Set the visibility level for type declaration documentation.
+</Callout>
+
+> Accepts either `"compact"` or `"expanded"`. Defaults to `"expanded"`.
+
+Configures the visibility level for type declaration documentation.
+
+- **"expanded"**: Displays all available documentation as text, including nested type declarations.
+- **"compact"**: Omits separate documentation blocks for nested type declarations.
+
+```json filename="typedoc.json"
+{
+  "typeDeclarationVisibility": "expanded"
+}
+```
+
 ## --propertyMembersFormat
 
 <Callout emoji="💡">