6067bdb24e
Rework documentation URLs as inline markdown. Redesign documentations with markdown text. Redesign way to document scripts/categories and present the documentation. Documentation is showed in an expandable box instead of tooltip. This is to allow writing longer documentation (tooltips are meant to be used for short text) and have better experience on mobile. If a node (script/category) has documentation it's now shown with single information icon (ℹ) aligned to right. Add support for rendering documentation as markdown. It automatically converts plain URLs to URLs with display names (e.g. https://docs.microsoft.com/..) will be rendered automatically like "docs.microsoft.com - Windows 11 Privacy...".
49 lines
1.4 KiB
TypeScript
49 lines
1.4 KiB
TypeScript
import { BaseEntity } from '../infrastructure/Entity/BaseEntity';
|
|
import { IScript } from './IScript';
|
|
import { ICategory } from './ICategory';
|
|
|
|
export class Category extends BaseEntity<number> implements ICategory {
|
|
private allSubScripts: ReadonlyArray<IScript> = undefined;
|
|
|
|
constructor(
|
|
id: number,
|
|
public readonly name: string,
|
|
public readonly docs: ReadonlyArray<string>,
|
|
public readonly subCategories?: ReadonlyArray<ICategory>,
|
|
public readonly scripts?: ReadonlyArray<IScript>,
|
|
) {
|
|
super(id);
|
|
validateCategory(this);
|
|
}
|
|
|
|
public includes(script: IScript): boolean {
|
|
return this.getAllScriptsRecursively().some((childScript) => childScript.id === script.id);
|
|
}
|
|
|
|
public getAllScriptsRecursively(): readonly IScript[] {
|
|
if (!this.allSubScripts) {
|
|
this.allSubScripts = parseScriptsRecursively(this);
|
|
}
|
|
return this.allSubScripts;
|
|
}
|
|
}
|
|
|
|
function parseScriptsRecursively(category: ICategory): ReadonlyArray<IScript> {
|
|
return [
|
|
...category.scripts,
|
|
...category.subCategories.flatMap((c) => c.getAllScriptsRecursively()),
|
|
];
|
|
}
|
|
|
|
function validateCategory(category: ICategory) {
|
|
if (!category.name) {
|
|
throw new Error('missing name');
|
|
}
|
|
if (
|
|
(!category.subCategories || category.subCategories.length === 0)
|
|
&& (!category.scripts || category.scripts.length === 0)
|
|
) {
|
|
throw new Error('A category must have at least one sub-category or script');
|
|
}
|
|
}
|