-
${label || getDocLabel(doc)}
+
${getDocLabel(doc)}
+ ${doc.synonyms_text ? `
Synonyms: ${doc.synonyms_text}
` : ''}
${doc.description ? `
${doc.description}
` : ''}
${buildParamsList(doc.params)}
${buildExamples(doc.examples)}
@@ -74,15 +75,43 @@ const isValidDoc = (doc) => {
const hasExcludedTags = (doc) =>
['superdirtOnly', 'noAutocomplete'].some((tag) => doc.tags?.find((t) => t.originalTitle === tag));
-const jsdocCompletions = jsdoc.docs
- .filter((doc) => isValidDoc(doc) && !hasExcludedTags(doc))
- // https://codemirror.net/docs/ref/#autocomplete.Completion
- .map((doc) => ({
- label: getDocLabel(doc),
- // detail: 'xxx', // An optional short piece of information to show (with a different style) after the label.
- info: () => Autocomplete({ doc }),
- type: 'function', // https://codemirror.net/docs/ref/#autocomplete.Completion.type
- }));
+export const getSynonymDoc = (doc, synonym) => {
+ const synonyms = doc.synonyms || [];
+ const docLabel = getDocLabel(doc);
+ // Swap `doc.name` in for `s` in the list of synonyms
+ const synonymsWithDoc = [docLabel, ...synonyms].filter((x) => x && x !== synonym);
+ return {
+ ...doc,
+ name: synonym,
+ longname: synonym,
+ synonyms: synonymsWithDoc,
+ synonyms_text: synonymsWithDoc.join(', '),
+ };
+};
+
+const jsdocCompletions = (() => {
+ const seen = new Set(); // avoid repetition
+ const completions = [];
+ for (const doc of jsdoc.docs) {
+ if (!isValidDoc(doc) || hasExcludedTags(doc)) continue;
+ const docLabel = getDocLabel(doc);
+ // Remove duplicates
+ const synonyms = doc.synonyms || [];
+ let labels = [docLabel, ...synonyms];
+ for (const label of labels) {
+ // https://codemirror.net/docs/ref/#autocomplete.Completion
+ if (label && !seen.has(label)) {
+ seen.add(label);
+ completions.push({
+ label,
+ info: () => Autocomplete(getSynonymDoc(doc, label)),
+ type: 'function', // https://codemirror.net/docs/ref/#autocomplete.Completion.type
+ });
+ }
+ }
+ }
+ return completions;
+})();
export const strudelAutocomplete = (context) => {
const word = context.matchBefore(/\w*/);
diff --git a/packages/codemirror/tooltip.mjs b/packages/codemirror/tooltip.mjs
index f67e6d14a..d1d0479b2 100644
--- a/packages/codemirror/tooltip.mjs
+++ b/packages/codemirror/tooltip.mjs
@@ -1,6 +1,6 @@
import { hoverTooltip } from '@codemirror/view';
import jsdoc from '../../doc.json';
-import { Autocomplete } from './autocomplete.mjs';
+import { Autocomplete, getSynonymDoc } from './autocomplete.mjs';
const getDocLabel = (doc) => doc.name || doc.longname;
@@ -52,10 +52,11 @@ export const strudelTooltip = hoverTooltip(
let entry = jsdoc.docs.filter((doc) => getDocLabel(doc) === word)[0];
if (!entry) {
// Try for synonyms
- entry = jsdoc.docs.filter((doc) => doc.synonyms && doc.synonyms.includes(word))[0];
- if (!entry) {
+ const doc = jsdoc.docs.filter((doc) => doc.synonyms && doc.synonyms.includes(word))[0];
+ if (!doc) {
return null;
}
+ entry = getSynonymDoc(doc, word);
}
return {
@@ -66,7 +67,7 @@ export const strudelTooltip = hoverTooltip(
create(view) {
let dom = document.createElement('div');
dom.className = 'strudel-tooltip';
- const ac = Autocomplete({ doc: entry, label: word });
+ const ac = Autocomplete(entry);
dom.appendChild(ac);
return { dom };
},
diff --git a/packages/core/controls.mjs b/packages/core/controls.mjs
index 473ea82d1..92a40db41 100644
--- a/packages/core/controls.mjs
+++ b/packages/core/controls.mjs
@@ -91,6 +91,7 @@ export const { s, sound } = registerControl(['s', 'n', 'gain'], 'sound');
* Define a custom webaudio node to use as a sound source.
*
* @name source
+ * @synonyms src
* @param {function} getSource
* @synonyms src
*
@@ -536,6 +537,7 @@ export const { tremolophase } = registerControl('tremolophase', 'tremphase');
* shape of amplitude modulation
*
* @name tremoloshape
+ * @synonyms tremshape
* @param {number | Pattern} shape tri | square | sine | saw | ramp
* @example
* note("{f g c d}%16").tremsync(4).tremoloshape("
").s("sawtooth")
@@ -551,11 +553,13 @@ export const { tremoloshape } = registerControl('tremoloshape', 'tremshape');
* note("{f g g c d a a#}%16".sub(17)).s("supersaw").lpenv(8).lpf(150).lpq(.8).ftype('ladder').drive("<.5 4>")
*
*/
+export const { drive } = registerControl('drive');
/**
* modulate the amplitude of an orbit to create a "sidechain" like effect
*
* @name duckorbit
+ * @synonyms duck
* @param {number | Pattern} orbit target orbit
* @example
* $: n(run(16)).scale("c:minor:pentatonic").s("sawtooth").delay(.7).orbit(2)
@@ -580,6 +584,7 @@ export const { duckdepth } = registerControl('duckdepth');
* the attack time of the duck effect
*
* @name duckattack
+ * @synonyms duckatt
* @param {number | Pattern} time
* @example
* stack( n(run(8)).scale("c:minor").s("sawtooth").delay(.7).orbit(2), s("bd:4!4").beat("0,4,8,11,14",16).duckorbit(2).duckattack("<0.2 0 0.4>").duckdepth(1))
@@ -587,8 +592,6 @@ export const { duckdepth } = registerControl('duckdepth');
*/
export const { duckattack } = registerControl('duckattack', 'duckatt');
-export const { drive } = registerControl('drive');
-
/**
* Create byte beats with custom expressions
*
@@ -711,7 +714,7 @@ export const { phasercenter, phc } = registerControl('phasercenter', 'phc');
* The amount the signal is affected by the phaser effect. Defaults to 0.75
*
* @name phaserdepth
- * @synonyms phd
+ * @synonyms phd, phasdp
* @param {number | Pattern} depth number between 0 and 1
* @example
* n(run(8)).scale("D:pentatonic").s("sawtooth").release(0.5)
@@ -1206,6 +1209,7 @@ export const { dry } = registerControl('dry');
* Used when using `begin`/`end` or `chop`/`striate` and friends, to change the fade out time of the 'grain' envelope.
*
* @name fadeTime
+ * @synonyms fadeOutTime
* @param {number | Pattern} time between 0 and 1
* @example
* s("oh*4").end(.1).fadeTime("<0 .2 .4 .8>").osc()
diff --git a/packages/core/pattern.mjs b/packages/core/pattern.mjs
index addc301d5..39790f8a0 100644
--- a/packages/core/pattern.mjs
+++ b/packages/core/pattern.mjs
@@ -1246,7 +1246,8 @@ export const silence = gap(1);
/* Like silence, but with a 'steps' (relative duration) of 0 */
export const nothing = gap(0);
-/** A discrete value that repeats once per cycle.
+/**
+ * A discrete value that repeats once per cycle.
*
* @returns {Pattern}
* @example
@@ -1299,7 +1300,8 @@ export function sequenceP(pats) {
return result;
}
-/** The given items are played at the same time at the same length.
+/**
+ * The given items are played at the same time at the same length.
*
* @return {Pattern}
* @synonyms polyrhythm, pr
@@ -1382,11 +1384,11 @@ export function stackBy(by, ...pats) {
.setSteps(steps);
}
-/** Concatenation: combines a list of patterns, switching between them successively, one per cycle:
- *
- * synonyms: `cat`
+/**
+ * Concatenation: combines a list of patterns, switching between them successively, one per cycle.
*
* @return {Pattern}
+ * @synonyms cat
* @example
* slowcat("e5", "b4", ["d5", "c5"])
*
diff --git a/website/src/repl/Repl.css b/website/src/repl/Repl.css
index 498679090..9cf51ff85 100644
--- a/website/src/repl/Repl.css
+++ b/website/src/repl/Repl.css
@@ -112,6 +112,13 @@
margin: 0 0 8px 0;
}
+.autocomplete-info-function-synonyms {
+ margin: 0 0 12px 0;
+ color: var(--foreground);
+ line-height: 1.5;
+ opacity: 0.8;
+}
+
.autocomplete-info-function-description {
margin: 0 0 12px 0;
color: var(--foreground);
diff --git a/website/src/repl/components/panel/Reference.jsx b/website/src/repl/components/panel/Reference.jsx
index 1b617341b..6007667fa 100644
--- a/website/src/repl/components/panel/Reference.jsx
+++ b/website/src/repl/components/panel/Reference.jsx
@@ -2,9 +2,32 @@ import { useMemo, useState } from 'react';
import jsdocJson from '../../../../../doc.json';
import { Textbox } from '../textbox/Textbox';
-const availableFunctions = jsdocJson.docs
- .filter(({ name, description }) => name && !name.startsWith('_') && !!description)
- .sort((a, b) => /* a.meta.filename.localeCompare(b.meta.filename) + */ a.name.localeCompare(b.name));
+
+const isValid = ({ name, description }) => name && !name.startsWith('_') && !!description;
+
+const availableFunctions = (() => {
+ const seen = new Set(); // avoid repetition
+ const functions = [];
+ for (const doc of jsdocJson.docs) {
+ if (!isValid(doc)) continue;
+ functions.push(doc);
+ const synonyms = doc.synonyms || [];
+ for (const s of synonyms) {
+ if (!s || seen.has(s)) continue;
+ seen.add(s);
+ // Swap `doc.name` in for `s` in the list of synonyms
+ const synonymsWithDoc = [doc.name, ...synonyms].filter((x) => x && x !== s);
+ functions.push({
+ ...doc,
+ name: s, // update names for the synonym
+ longname: s,
+ synonyms: synonymsWithDoc,
+ synonyms_text: synonymsWithDoc.join(', '),
+ });
+ }
+ }
+ return functions.sort((a, b) => /* a.meta.filename.localeCompare(b.meta.filename) + */ a.name.localeCompare(b.name));
+})();
const getInnerText = (html) => {
var div = document.createElement('div');