elias/strudel-docker
1
0
Fork 0
mirror of https://github.com/eliasstepanik/strudel-docker.git synced 2026-01-23 03:28:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

automatically print synonyms in doc

Browse Source
This commit is contained in:
Felix Roos 2023-01-12 13:10:22 +01:00
parent 19982a2ffb
commit 78d14cdfea
2 changed files with 23 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
packages/core/pattern.mjs
View File

@ -733,7 +733,7 @@ export class Pattern {
} }
/** /**
* Appends the given pattern(s) to the current pattern. Synonyms: .sequence .fastcat * Appends the given pattern(s) to the current pattern.
* @name seq * @name seq
* @memberof Pattern * @memberof Pattern
* @synonyms sequence, fastcat * @synonyms sequence, fastcat
@ -747,7 +747,7 @@ export class Pattern {
} }
/** /**
* Appends the given pattern(s) to the next cycle. Synonym: .slowcat * Appends the given pattern(s) to the next cycle.
* @name cat * @name cat
* @memberof Pattern * @memberof Pattern
* @synonyms slowcat * @synonyms slowcat
@ -1191,24 +1191,10 @@ export function slowcatPrime(...pats) {
return new Pattern(query).splitQueries(); return new Pattern(query).splitQueries();
} }
/** Concatenation: as with {@link slowcat}, but squashes a cycle from each pattern into one cycle /** The given items are con**cat**enated, where each one takes one cycle.
*
* Synonyms: {@link Pattern.seq}, {@link Pattern.sequence}
*
* @param {...any} items - The items to concatenate
* @return {Pattern}
* @example
* fastcat(e5, b4, [d5, c5])
* // sequence(e5, b4, [d5, c5])
* // seq(e5, b4, [d5, c5])
*/
export function fastcat(...pats) {
return slowcat(...pats)._fast(pats.length);
}
/** The given items are con**cat**enated, where each one takes one cycle. Synonym: slowcat
* *
* @param {...any} items - The items to concatenate * @param {...any} items - The items to concatenate
* @synonyms slowcat
* @return {Pattern} * @return {Pattern}
* @example * @example
* cat(e5, b4, [d5, c5]).note() // "<e5 b4 [d5 c5]>".note() * cat(e5, b4, [d5, c5]).note() // "<e5 b4 [d5 c5]>".note()
@ -1235,12 +1221,17 @@ export function timeCat(...timepats) {
return stack(...pats); return stack(...pats);
} }
export function fastcat(...pats) {
return slowcat(...pats)._fast(pats.length);
}
/** See {@link fastcat} */ /** See {@link fastcat} */
export function sequence(...pats) { export function sequence(...pats) {
return fastcat(...pats); return fastcat(...pats);
} }
/** Like **cat**, but the items are crammed into one cycle. Synonyms: fastcat, sequence /** Like **cat**, but the items are crammed into one cycle.
* @synonyms fastcat, sequence
* @example * @example
* seq(e5, b4, [d5, c5]).note() // "e5 b4 [d5 c5]".note() * seq(e5, b4, [d5, c5]).note() // "e5 b4 [d5 c5]".note()
* *

14
website/src/docs/JsDoc.jsx
View File

@ -2,12 +2,15 @@ import jsdoc from '../../../doc.json'; // doc.json is built with `npm run jsdoc-
const docs = jsdoc.docs.reduce((acc, obj) => Object.assign(acc, { [obj.longname]: obj }), {}); const docs = jsdoc.docs.reduce((acc, obj) => Object.assign(acc, { [obj.longname]: obj }), {});
import { MiniRepl } from './MiniRepl'; import { MiniRepl } from './MiniRepl';
const getTag = (title, item) => item.tags?.find((t) => t.title === title)?.text;
export function JsDoc({ name, h = 3, hideDescription }) { export function JsDoc({ name, h = 3, hideDescription }) {
const item = docs[name]; const item = docs[name];
if (!item) { if (!item) {
console.warn('Not found: ' + name); console.warn('Not found: ' + name);
return <div />; return <div />;
} }
const synonyms = getTag('synonyms', item)?.split(', ') || [];
const CustomHeading = `h${h}`; const CustomHeading = `h${h}`;
const description = item.description.replaceAll(/\{@link ([a-zA-Z\.]+)?#?([a-zA-Z]*)\}/g, (_, a, b) => { const description = item.description.replaceAll(/\{@link ([a-zA-Z\.]+)?#?([a-zA-Z]*)\}/g, (_, a, b) => {
// console.log(_, 'a', a, 'b', b); // console.log(_, 'a', a, 'b', b);
@ -16,7 +19,16 @@ export function JsDoc({ name, h = 3, hideDescription }) {
return ( return (
<> <>
{!!h && <CustomHeading>{item.longname}</CustomHeading>} {!!h && <CustomHeading>{item.longname}</CustomHeading>}
{!hideDescription && <div dangerouslySetInnerHTML={{ __html: description }} />} {!hideDescription && (
<>
{!!synonyms.length && (
<span>
Synonyms: <code>{synonyms.join(', ')}</code>
</span>
)}
<div dangerouslySetInnerHTML={{ __html: description }} />
</>
)}
<ul> <ul>
{item.params?.map((param, i) => ( {item.params?.map((param, i) => (
<li key={i}> <li key={i}>