Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement hidden nodes blind #89

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@knodes/typedoc-plugins",
"version": "0.22.5",
"version": "0.22.7",
"description": "A monorepo containing all knodes-published TypeDoc plugins",
"license": "MIT",
"private": true,
Expand All @@ -24,6 +24,8 @@
"./packages/*"
],
"scripts": {
"postinstall": "git submodule update --init --recursive && npm i --workspaces && npm run projects:build",
"build": "npm run projects:build",
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
"docs": "typedoc",
"format:pkg": "format-package --write",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,13 @@ describe( APageTreeBuilder.name, () => {
matchReflection( PageReflection, { name: 'Baz', depth: 0, module: testHost.project, sourceFilePath: 'baz.md', content: 'Baz content', url: 'baz.html' } ),
] );
} );
it( 'should map hidden item', () => {
setVirtualFs( {
'foo.md': 'Foo content'
} );
const out = testHost.mapPagesToReflections( [ { title: 'HIDDEN', source: 'foo.md' } ] );
expect( out ).toHaveLength( 1 );
} );
it( 'should map page with children', () => {
setVirtualFs( {
'foo.md': 'Foo content',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,12 @@ export abstract class APageTreeBuilder implements IPageTreeBuilder {
}
this.project.registerReflection( nodeReflection );
this.addNodeToProjectAsChild( nodeReflection );
// strip a hidden node, but *after* adding its source to the project as a child
if( node.title === 'HIDDEN' ){
return node.children ?
this._mapPagesToReflections( node.children, parent, childrenIO ) :
[];
}
const children = node.children ?
this._mapPagesToReflections(
node.children,
Expand Down
4 changes: 4 additions & 0 deletions renovate.json5
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,9 @@
"matchDatasources": ["npm"],
"stabilityDays": 3
},
{ // Prevent automerge for typedoc updates
"matchPackagePatterns": ["typedoc"],
"automerge": false
},
]
}