Implement hidden nodes blind #89

StoneCypher · 2022-06-15T18:27:53Z

NOT READY FOR MERGE

Please merge #88 first

Some of this PR is actually from parent patch 88, and will disappear when it is merged

This is a blind attempt to implement HIDDEN nodes. It is highly suspect because the author could not build or test the result, and is new to this codebase.

A HIDDEN node is a node which will only render in the page tree if it's currently being viewed. (This behavior is known to currently be incorrect, and will be repaired before merge once buildable.)

The purpose of a HIDDEN node is to allow a category page to include hundreds of pages underneath, and not flood the index on the right. HIDDEN nodes must be found from a listing in another page, or through search.

My personal use case is for the documentation for a state machine library. I want to include more than 200 example state machines, each on their own page, which is prohibitive without a feature like this.

…tomatically, and build once on install. Also, stub the standard build call to point to project build. Currently untested due to KnodesCommunity#82

…the ability to try it due to KnodesCommunity#82

GerkinDev · 2022-06-20T17:03:27Z

Please rebase your branch. You should be good to go now

StoneCypher · 2022-06-20T22:54:24Z

@GerkinDev - I might be being dense, but, the repo doesn't show a push in the last couple weeks; maybe something didn't get pushed? Or maybe I'm not getting it

GerkinDev · 2022-06-20T22:55:40Z

You're supposed to base features on the develop branch, not main. Main is for released code only.

StoneCypher · 2022-06-20T22:55:56Z

oh you use git flow, ok, sorry

StoneCypher · 2022-06-20T23:04:15Z

Sorry, no, the situation is unchanged, I believe.

Because I am noticably bad at things like rebasing and submodules, I established a new clean setup.

In this order, I:

Created a new directory, and worked there
Cloned your repo, instead of my own
Updated submodules
Initialized npm workspaces
Switched to your repo's develop branch, not my PR
Ran npm install
Ran npm run projects:build

The error is the same as previously, I believe.

john@DESKTOP-26H4050 MINGW64 /e/projects
$ mkdir tmp-host-copy

john@DESKTOP-26H4050 MINGW64 /e/projects
$ cd tmp-host-copy/

john@DESKTOP-26H4050 MINGW64 /e/projects/tmp-host-copy
$ git clone https://github.com/KnodesCommunity/typedoc-plugins.git
Cloning into 'typedoc-plugins'...
remote: Enumerating objects: 2026, done.
remote: Counting objects: 100% (470/470), done.
remote: Compressing objects: 100% (170/170), done.
Receiving objects: 100% (2026/2026), 1.22 MiB | 3.40 MiB/s, done.ed 1556

Resolving deltas: 100% (1316/1316), done.

john@DESKTOP-26H4050 MINGW64 /e/projects/tmp-host-copy
$ cd typedoc-plugins/

john@DESKTOP-26H4050 MINGW64 /e/projects/tmp-host-copy/typedoc-plugins (main)
$ git submodule update --init --recursive
Submodule 'typedoc' (https://github.com/TypeStrong/typedoc.git) registered for path 'typedoc'
Cloning into 'E:/projects/tmp-host-copy/typedoc-plugins/typedoc'...
Submodule path 'typedoc': checked out 'abed9a64d674c6c3b20284847c024abd5334547b'

john@DESKTOP-26H4050 MINGW64 /e/projects/tmp-host-copy/typedoc-plugins (main)
$ npm i --workspaces

> @knodes/typedoc-plugins@0.22.5 prepare
> npm run prepare:husky


> @knodes/typedoc-plugins@0.22.5 prepare:husky
> [ -d ./node_modules/husky ] && husky install || true


added 708 packages, and audited 714 packages in 40s

found 0 vulnerabilities

john@DESKTOP-26H4050 MINGW64 /e/projects/tmp-host-copy/typedoc-plugins (main)
$ git checkout develop
Switched to a new branch 'develop'
M       typedoc
Branch 'develop' set up to track remote branch 'develop' from 'origin'.

john@DESKTOP-26H4050 MINGW64 /e/projects/tmp-host-copy/typedoc-plugins (develop)
$ npm install
npm WARN deprecated @types/concurrently@7.0.0: This is a stub types definition. concurrently provides its own type definitions, so you do not need this installed.
npm WARN deprecated @hapi/topo@3.1.6: This version has been deprecated and is no longer supported or maintained
npm WARN deprecated @hapi/bourne@1.3.2: This version has been deprecated and is no longer supported or maintained
npm WARN deprecated @hapi/address@2.1.4: Moved to 'npm install @sideway/address'
npm WARN deprecated @hapi/hoek@8.5.1: This version has been deprecated and is no longer supported or maintained
npm WARN deprecated @hapi/joi@15.1.1: Switch to 'npm install joi'

> @knodes/typedoc-plugins@0.22.5 prepare
> npm run prepare:husky


> @knodes/typedoc-plugins@0.22.5 prepare:husky
> [ -d ./node_modules/husky ] && husky install || true

husky - Git hooks installed

added 108 packages, removed 51 packages, changed 182 packages, and audited 771 packages in 32s

found 0 vulnerabilities

john@DESKTOP-26H4050 MINGW64 /e/projects/tmp-host-copy/typedoc-plugins (develop)
$ npm run projects:build

> @knodes/typedoc-plugins@0.22.5 projects:build
> npm run projects:patch -- apply && node ./tools/s-projects 'npm run build -- --pretty'


> @knodes/typedoc-plugins@0.22.5 projects:patch
> node ./tools/typedoc-patcher --no-stash "apply"

Applying patches from packages/plugin-pages/src/theme-plugins/search/default-pages-javascript-index-plugin.GENERATED.ts.patch
node:internal/process/promises:246
          triggerUncaughtException(err, true /* fromPromise */);
          ^

AssertionError [ERR_ASSERTION]: The expression evaluated to a falsy value:

  assert( match && match[1] )

    at E:\projects\tmp-host-copy\typedoc-plugins\tools\typedoc-patcher.js:28:2
    at async E:\projects\tmp-host-copy\typedoc-plugins\tools\typedoc-patcher.js:123:100
    at async Promise.all (index 0)
    at async E:\projects\tmp-host-copy\typedoc-plugins\tools\typedoc-patcher.js:123:31 {
  generatedMessage: true,
  code: 'ERR_ASSERTION',
  actual: null,
  expected: true,
  operator: '=='
}

Node.js v17.2.0

GerkinDev · 2022-06-21T08:04:15Z

You've checked out typedoc before checking out the develop branch. So I'm not sure the typedoc submodule is at the expected commit to apply the patch.

So, I totally understand this "patch" thing is a hell. It is indeed. It should be simplified for a while when TypeStrong/typedoc#1953 is resolved, until I need to follow the same pattern on another plugin (and I pray I won't)

StoneCypher · 2022-06-21T13:45:48Z

You've checked out typedoc before checking out the develop branch. So I'm not sure the typedoc submodule is at the expected commit to apply the patch.

Wait, the ... the git submodules are different according to branches?

So, I totally understand this "patch" thing is a hell.

Honestly it's mostly the submodules that have been causing me trouble

StoneCypher · 2022-06-21T13:49:48Z

no, the same build failure happens if i check out develop first

GerkinDev · 2022-06-21T13:50:43Z

You've checked out typedoc before checking out the develop branch. So I'm not sure the typedoc submodule is at the expected commit to apply the patch.

Wait, the ... the git submodules are different according to branches?

Yes, it targets the latest typedoc stable release (currently 0.22.17) in order to avoid possibly regressing release as soon as typedoc updates one of the patched files.

Ok this is strange. I'll check on my windows tonight

StoneCypher · 2022-06-27T20:49:54Z

ok, that fix appears to work

GerkinDev · 2023-04-06T22:29:33Z

Hi there;

I'm finally looking for a way to implement this feature.

GerkinDev and others added 3 commits May 28, 2022 19:47

ci(renovate): don't automerge typedoc updates

7788b74

Attempt to install git submodules automatically, set up workspaces au…

154fb37

…tomatically, and build once on install. Also, stub the standard build call to point to project build. Currently untested due to KnodesCommunity#82

Highly suspect draft implementation of HIDDEN nodes, written without …

d3993cf

…the ability to try it due to KnodesCommunity#82

This was referenced Jun 15, 2022

Not sure how to build #84

Closed

Auto submodules, auto workspaces, build on install; support standard build call #87

Closed

GerkinDev mentioned this pull request Jun 23, 2022

plugin-pages: menus are always expanded #100

Open

GerkinDev force-pushed the main branch from 0776bd9 to 5ec724b Compare June 27, 2022 17:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement hidden nodes blind #89

Implement hidden nodes blind #89

StoneCypher commented Jun 15, 2022 •

edited

GerkinDev commented Jun 20, 2022

StoneCypher commented Jun 20, 2022

GerkinDev commented Jun 20, 2022

StoneCypher commented Jun 20, 2022

StoneCypher commented Jun 20, 2022

GerkinDev commented Jun 21, 2022

StoneCypher commented Jun 21, 2022

StoneCypher commented Jun 21, 2022

GerkinDev commented Jun 21, 2022

StoneCypher commented Jun 27, 2022

GerkinDev commented Apr 6, 2023

Implement hidden nodes blind #89

Are you sure you want to change the base?

Implement hidden nodes blind #89

Conversation

StoneCypher commented Jun 15, 2022 • edited

NOT READY FOR MERGE

GerkinDev commented Jun 20, 2022

StoneCypher commented Jun 20, 2022

GerkinDev commented Jun 20, 2022

StoneCypher commented Jun 20, 2022

StoneCypher commented Jun 20, 2022

GerkinDev commented Jun 21, 2022

StoneCypher commented Jun 21, 2022

StoneCypher commented Jun 21, 2022

GerkinDev commented Jun 21, 2022

StoneCypher commented Jun 27, 2022

GerkinDev commented Apr 6, 2023

StoneCypher commented Jun 15, 2022 •

edited