Merge pull request #242 from tidalcycles/example-tests

in source example tests

package.json

@@ -4,6 +4,7 @@
   "private": true,
   "description": "Port of tidalcycles to javascript",
   "scripts": {
+    "pretest": "cd tutorial && npm run jsdoc-json",
     "test": "vitest run --version",
     "test-ui": "vitest --ui",
     "test-coverage": "vitest --coverage",

packages/core/drawLine.mjs

@@ -21,6 +21,7 @@ import Fraction, { gcd } from './fraction.mjs';
  * @example
  * const line = drawLine("0 [1 2 3]", 10); // |0--123|0--123
  * console.log(line);
+ * silence;
  */
 function drawLine(pat, chars = 60) {
   let cycle = 0;

packages/core/index.mjs

@@ -15,6 +15,7 @@ export * from './state.mjs';
 export * from './timespan.mjs';
 export * from './util.mjs';
 export * from './speak.mjs';
+export { default as drawLine } from './drawLine.mjs';
 export { default as gist } from './gist.js';
 // below won't work with runtime.mjs (json import fails)
 /* import * as p from './package.json';

packages/core/pattern.mjs

@@ -32,8 +32,10 @@ export class Pattern {
    * @param {Fraction | number} end to time
    * @returns Hap[]
    * @example
-   * const pattern = sequence('a', ['b', 'c']);
-   * const haps = pattern.queryArc(0, 1);
+   * const pattern = sequence('a', ['b', 'c'])
+   * const haps = pattern.queryArc(0, 1)
+   * console.log(haps)
+   * silence
    */
   queryArc(begin, end) {
     return this.query(new State(new TimeSpan(begin, end)));
@@ -1543,7 +1545,7 @@ export function pure(value) {
 
 export function isPattern(thing) {
   // thing?.constructor?.name !== 'Pattern' // <- this will fail when code is mangled
-  const is = thing instanceof Pattern || thing._Pattern;
+  const is = thing instanceof Pattern || thing?._Pattern;
   if (!thing instanceof Pattern) {
     console.warn(
       `Found Pattern that fails "instanceof Pattern" check.

repl/src/runtime.mjs

@@ -83,7 +83,9 @@ const toneHelpersMocked = {
   highpass: mockNode,
 };
 
-// tone mock
+strudel.Pattern.prototype.osc = function () {
+  return this;
+};
 strudel.Pattern.prototype.tone = function () {
   return this;
 };

tutorial/test/examples.test.mjs

@@ -0,0 +1,15 @@
+import { queryCode } from '../../repl/src/runtime.mjs';
+import { describe, it } from 'vitest';
+import doc from '../../doc.json';
+
+describe('runs examples', () => {
+  const { docs } = doc;
+  docs.forEach(async (doc) => {
+    doc.examples?.forEach((example, i) => {
+      it(`example "${doc.name}" example index ${i}`, async ({ expect }) => {
+        const haps = await queryCode(example, 4);
+        expect(haps).toMatchSnapshot();
+      });
+    });
+  });
+});