Feature suggestion: CLI tool for removing old doc builds

[toebeann]

Summary

At the present time, the method of removing old doc builds is to simply delete the folders. While this isn't difficult, it would be nice to be able to automate the process somewhat. A CLI tool makes the most sense to me as this would allow it to be run either via GitHub workflows or package.json scripts, and is relatively simple to achieve via the package.json bin field.

Details

• by default, should automatically purge "stale" dev build docs, as it's probably quite rare that anyone would ever need/want to view them once a dev build gets bumped to stable in most cases
• should have a setting/argument to automatically update relevant metadata files (including versions.js), so that a full doc rebuild isn't needed, but obviously unnecessary if the purge is being run immediately prior to a docs build - therefore by default should probably be off
• should have settings/arguments for specifying how many patch versions to keep per minor version, and how many minor versions to keep per major version, with the default being to keep them all
• should have arguments for only purging specific versions, ideally with range and wildcard support
• ideally, it should also be possible to set arguments in typedoc config file. arguments passed at the CLI should take precedence

Suggested command name/aliases

• typedoc-plugin-versions purge
  • typedoc-plugin-versions p
  • tpversions purge
  • tpversions p
  • tpv purge
  • tpv p

For now will leave this unassigned, but I'm happy to work on this once my current draft PR #10 is completed, at which point I'll assign myself unless someone else wants to volunteer 🙂