Fix: typedoc-plugin-versions not appearing in plugins listing on typedoc.org

[toebeann]

Changes in this pull request

• Adds the keyword typedocplugin to package.json

Reasoning

Currently, this plugin does not appear on https://typedoc.org/guides/plugins/

From a brief peruse over how the typedoc website generates the list of plugins to display, I discovered that it appears to be using the following search string via the npm website: keywords:typedoc-plugin keywords:typedocplugin. The results of this search can be viewed here, and this plugin is not among them.

The problem seems to stem from how npm handles multiple search terms - it is joining them by AND rather than OR, i.e. only displaying results which match all given search terms rather than matching any. Merely changing the search to only include the search term keywords:typedoc-plugin displays this plugin in the results. This means that for a package to appear in the search, it requires both keywords:

• typedoc-plugin
• typedocplugin

Presently, this plugin only lists the keyword typedoc-plugin in package.json, not both.

At some point in the future it might an idea to PR typedoc-site to run individual searches for each keyword and combines the results into a single list of plugins. In the meantime however, the simplest way to display this plugin on the list should be simply to add the missing typedocplugin keyword.

[citkane]

Thanks @toebeann ,

I spotted this as well after the last version bump.
Funny thing is that my plugins used to show up until recently. A bit annoying...

This is merged into dev.
Let me know when you publish your cli extension and I can bump the version here at the same time so that both show up together, or feel free to do so yourself. I think you should have sufficient privilege as collaborator?

[citkane]

Merged into dev.

[toebeann]

Funny thing is that my plugins used to show up until recently. A bit annoying...

Indeed, IIRC that list is how I found this plugin in the first place! Definitely a vital resource for promoting it to the greater typedoc userbase. I can only assume they recently changed how it was handled, possibly in an attempt to be more inclusive, but have unfortunately ended up going the opposite direction!

Let me know when you publish your cli extension and I can bump the version here at the same time so that both show up together

My CLI project is going to take a while yet for the first version to go live on npm, I'd like to get some quality docs and tests in place for at least one of the commands first 😅

or feel free to do so yourself. I think you should have sufficient privilege as collaborator?

Will definitely give you a shout when it goes up just for your own interest, but as for having sufficient privileges, you are indeed correct I should be able to do push to dev and merge to main, and even release to npm thanks to your GitHub workflow :) But of course, I wouldn't want to step on your toes!

Re. the CLI, at some point I might want to PR here to make some codebase changes to unify some of the code across each package (i.e. minimizing duplicate code and reduced chance of CLI tool performing same operations slightly differently), but for now mostly I have everything working quite well at least for one of the commands so far.

[toebeann]

PS: you were definitely right about making the CLI its own project btw, it's pretty beefy so far and would potentially have ended up dwarfing the rest of typedoc-plugin-versions to introduce!

Once it's released, you're more than welcome to join as a collaborator on it as well, if you like, since I would like to consider the two packages as siblings 🙂

[citkane]

Once it's released, you're more than welcome to join as a collaborator on it as well, if you like, since I would like to consider the two packages as siblings

Thanks! I agree that the two are siblings.

I am "all in" at the moment on a new typedoc theme, and I will introduce it to you once it is less messy than it is at the moment. The versions plugin will be a sub-component of this effort.

Suffice to say that I am not a fan of how the default theme looks and feels, and so I am busy with a re-design that keeps the visual representation DRY, with more flexible HTML markup and intuitive navigation.

I am also using this as an excuse to learn native web-components, so I translating all the back-end .jsx templating into the browser, and feeding the app, which will now be a query driven SPA, with .json data reflections instead of HTML pages.

[toebeann]

Sounds interesting, I look forward to it 🙂