harmonyc 0.16.4 → 0.18.0

package/README.md

@@ -1,6 +1,6 @@
 # Harmony Code
 
-A test design & BDD tool that helps you separate the _what_ to test from the _how_ to automate it. You write test cases in a simple easy-to-read format, and then automate them with Vitest (and soon with other frameworks and languages).
+A test design & BDD tool that helps you separate _what_ you test and _how_ you automate it. You write test cases in a simple easy-to-read format, and then automate them with Vitest.
 
 ## Setup
 
@@ -10,23 +10,24 @@ You need to have Node.js installed. Then you can install Harmony Code in your pr
 npm install harmonyc
 ```
 
-Then add it to your `vitest.config.js` or `vite.config.js` file, and specify which folder to watch for `.harmony` files:
+Then add it as a plugin to your `vitest.config.js` or `vite.config.js` file, and make sure to include your `.harmony` files:
 
 ```js
 import harmony from 'harmonyc/vitest'
 
 export default {
-  plugins: [harmony({ watchDir: 'src' })],
+  plugins: [harmony()],
+  include: ['src/**/*.harmony'],
 }
 ```
 
-You can run it manually for all `.harmony` files in your `src` folder:
+This will run .harmony files in vitest.
 
-```bash
-harmonyc src/**/*.harmony
-```
+## VSCode plugin
+
+Harmony Code has a [VSCode plugin](https://marketplace.visualstudio.com/items?itemName=harmony-ac.harmony-code) that supports syntax highlighting.
 
-This will generate `.test.mjs` files next to the `.harmony` files, and generate empty definition files for you.
+Harmony Code is compatible with Vitest's VSCode plugin, so you can run and debug tests from the editor.
 
 ## Syntax
 
@@ -77,12 +78,12 @@ becomes
 
 ```javascript
 test('T1 - strings', async () => {
-  const P = new Phrases();
-  await P.When_hello_("John");
+  const P = new Phrases()
+  await P.When_hello_('John')
 })
 test('T2 - code fragment', async () => {
-  const P = new Phrases();
-  await P.When_greet__times(3);
+  const P = new Phrases()
+  await P.When_greet__times(3)
 })
 ```
 
@@ -136,7 +137,6 @@ test('T2 - store result in variable', (context) => {
 })
 ```
 
-
 ## License
 
 MIT

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "harmonyc",
   "description": "Harmony Code - model-driven BDD for Vitest",
-  "version": "0.16.4",
+  "version": "0.18.0",
   "author": "Bernát Kalló",
   "type": "module",
   "bin": {
     "harmonyc": "./cli.js"
   },
+  "files": [
+    "."
+  ],
   "exports": {
     "./vitest": {
       "types": "./vitest/index.d.ts",
@@ -24,7 +27,9 @@
   "dependencies": {
     "fast-glob": "^3.3.2",
     "tinyrainbow": "1",
-    "typescript-parsec": "0.3.4",
+    "typescript-parsec": "0.3.4"
+  },
+  "optionalDependencies": {
     "watcher": "^2.3.1"
   },
   "license": "MIT",

package/cli/cli.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/cli/cli.js

@@ -1,32 +0,0 @@
-#!/usr/bin/env node
-import { compileFiles } from "../compiler/compiler.js";
-import { parseArgs } from 'node:util';
-import { watchFiles } from "./watch.js";
-import { run, runWatch } from "./run.js";
-const args = parseArgs({
-    options: {
-        help: { type: 'boolean' },
-        watch: { type: 'boolean', short: 'w' },
-        run: { type: 'boolean', short: 'r' },
-    },
-    allowPositionals: true,
-});
-if (args.positionals.length === 0 || args.values.help) {
-    console.error('Usage: harmonyc <input files glob pattern>');
-    process.exit(1);
-}
-;
-(async () => {
-    if (args.values.watch) {
-        const outFns = await watchFiles(args.positionals);
-        if (args.values.run) {
-            runWatch(outFns);
-        }
-    }
-    else {
-        const { outFns } = await compileFiles(args.positionals);
-        if (args.values.run) {
-            run(outFns);
-        }
-    }
-})();

package/cli/run.d.ts

@@ -1,2 +0,0 @@
-export declare function run(patterns: string[]): void;
-export declare function runWatch(patterns: string[]): void;

package/cli/run.js

@@ -1,21 +0,0 @@
-import { exec, spawn } from 'child_process';
-function runCommand(patterns) {
-    return `npx vitest run ${args(patterns)}`;
-}
-function runWatchCommand(patterns) {
-    return `npx vitest ${args(patterns)}`;
-}
-function args(patterns) {
-    return patterns.map((s) => JSON.stringify(s)).join(' ');
-}
-export function run(patterns) {
-    var _a, _b;
-    const cmd = runCommand(patterns);
-    const p = exec(cmd, { cwd: process.cwd() });
-    (_a = p.stdout) === null || _a === void 0 ? void 0 : _a.pipe(process.stdout);
-    (_b = p.stderr) === null || _b === void 0 ? void 0 : _b.pipe(process.stderr);
-}
-export function runWatch(patterns) {
-    const cmd = runWatchCommand(patterns);
-    spawn(cmd, { cwd: process.cwd(), stdio: 'inherit', shell: true });
-}

package/cli/watch.d.ts

@@ -1 +0,0 @@
-export declare function watchFiles(patterns: string[]): Promise<string[]>;

package/cli/watch.js

@@ -1,35 +0,0 @@
-import Watcher from 'watcher';
-import { compileFile, compileFiles } from "../compiler/compiler.js";
-export async function watchFiles(patterns) {
-    const { fns, outFns } = await compileFiles(patterns);
-    for (const file of fns) {
-        const watcher = new Watcher(file, { debounce: 20, ignoreInitial: true });
-        watcher.on('all', async () => {
-            var _a;
-            try {
-                await compileFile(file);
-            }
-            catch (e) {
-                process.stdout.write(`\n`);
-                console.log((_a = e.message) !== null && _a !== void 0 ? _a : e);
-                process.stdout.write(`\n`);
-            }
-            logger.log(`Compiled ${file}`);
-        });
-    }
-    return outFns;
-}
-const logger = {
-    last: '',
-    n: 0,
-    log(msg) {
-        if (msg === this.last) {
-            process.stdout.write(`\r${msg} ${++this.n}x`);
-        }
-        else {
-            process.stdout.write(`\r${msg}`);
-            this.last = msg;
-            this.n = 1;
-        }
-    },
-};

package/code_generator/VitestGenerator.d.ts

@@ -1,31 +0,0 @@
-import { Action, CodeGenerator, ErrorResponse, Feature, Phrase, Response, SaveToVariable, SetVariable, Test, TestGroup } from '../model/model.ts';
-import { OutFile } from './outFile.ts';
-export declare class VitestGenerator implements CodeGenerator {
-    private tf;
-    private sf;
-    static error(message: string, stack: string): string;
-    framework: string;
-    phraseFns: Map<string, Phrase>;
-    currentFeatureName: string;
-    constructor(tf: OutFile, sf: OutFile);
-    feature(feature: Feature): void;
-    testGroup(g: TestGroup): void;
-    featureVars: Map<string, string>;
-    resultCount: number;
-    test(t: Test): void;
-    errorStep(action: Action, errorResponse: ErrorResponse): void;
-    extraArgs: string[];
-    step(action: Action, responses: Response[]): void;
-    private declareFeatureVariables;
-    phrase(p: Phrase): void;
-    setVariable(action: SetVariable): void;
-    saveToVariable(s: SaveToVariable, what?: string): void;
-    stringLiteral(text: string, { withVariables }: {
-        withVariables: boolean;
-    }): string;
-    codeLiteral(src: string): string;
-    private paramName;
-    stringParamDeclaration(index: number): string;
-    variantParamDeclaration(index: number): string;
-}
-export declare function functionName(phrase: Phrase): string;

package/code_generator/VitestGenerator.js

@@ -1,212 +0,0 @@
-import { basename } from 'path';
-import { Arg, Response, Word, } from "../model/model.js";
-export class VitestGenerator {
-    static error(message, stack) {
-        return `const e = new SyntaxError(${str(message)});
-    e.stack = undefined;
-    throw e;
-    ${stack ? `/* ${stack} */` : ''}`;
-    }
-    constructor(tf, sf) {
-        this.tf = tf;
-        this.sf = sf;
-        this.framework = 'vitest';
-        this.phraseFns = new Map();
-        this.currentFeatureName = '';
-        this.resultCount = 0;
-        this.extraArgs = [];
-    }
-    feature(feature) {
-        const phrasesModule = './' + basename(this.sf.name.replace(/.(js|ts)$/, ''));
-        const fn = (this.currentFeatureName = pascalCase(feature.name));
-        this.phraseFns = new Map();
-        if (this.framework === 'vitest') {
-            this.tf.print(`import { describe, test, expect } from "vitest";`);
-        }
-        if (feature.tests.length === 0) {
-            this.tf.print('');
-            this.tf.print(`describe.todo(${str(feature.name)});`);
-            return;
-        }
-        this.tf.print(`import ${fn}Phrases from ${str(phrasesModule)};`);
-        this.tf.print(``);
-        for (const item of feature.testGroups) {
-            item.toCode(this);
-        }
-        this.sf.print(`export default class ${pascalCase(feature.name)}Phrases {`);
-        this.sf.indent(() => {
-            for (const ph of this.phraseFns.keys()) {
-                const p = this.phraseFns.get(ph);
-                const params = p.args.map((a, i) => a.toDeclaration(this, i)).join(', ');
-                this.sf.print(`async ${ph}(${params}) {`);
-                this.sf.indent(() => {
-                    this.sf.print(`throw new Error(${str(`Pending: ${ph}`)});`);
-                });
-                this.sf.print(`}`);
-            }
-        });
-        this.sf.print(`};`);
-    }
-    testGroup(g) {
-        this.tf.print(`describe(${str(g.name)}, () => {`);
-        this.tf.indent(() => {
-            for (const item of g.items) {
-                item.toCode(this);
-            }
-        });
-        this.tf.print('});');
-    }
-    test(t) {
-        this.resultCount = 0;
-        this.featureVars = new Map();
-        // avoid shadowing this import name
-        this.featureVars.set(new Object(), this.currentFeatureName);
-        this.tf.print(`test(${str(t.name)}, async (context) => {`);
-        this.tf.indent(() => {
-            this.tf.print(`context.task.meta.phrases ??= [];`);
-            for (const step of t.steps) {
-                step.toCode(this);
-            }
-        });
-        this.tf.print('});');
-    }
-    errorStep(action, errorResponse) {
-        this.declareFeatureVariables([action]);
-        this.tf.print(`await expect(async () => {`);
-        this.tf.indent(() => {
-            action.toCode(this);
-            this.tf.print(`context.task.meta.phrases.push(${str(errorResponse.toSingleLineString())});`);
-        });
-        this.tf.print(`}).rejects.toThrow(${(errorResponse === null || errorResponse === void 0 ? void 0 : errorResponse.message) !== undefined
-            ? str(errorResponse.message.text)
-            : ''});`);
-    }
-    step(action, responses) {
-        this.declareFeatureVariables([action, ...responses]);
-        if (responses.length === 0) {
-            action.toCode(this);
-            return;
-        }
-        if (action.isEmpty) {
-            for (const response of responses) {
-                response.toCode(this);
-            }
-            return;
-        }
-        const res = `r${this.resultCount++ || ''}`;
-        this.tf.print(`const ${res} =`);
-        this.tf.indent(() => {
-            action.toCode(this);
-            try {
-                this.extraArgs = [res];
-                for (const response of responses) {
-                    response.toCode(this);
-                }
-            }
-            finally {
-                this.extraArgs = [];
-            }
-        });
-    }
-    declareFeatureVariables(phrases) {
-        for (const p of phrases) {
-            const feature = p.feature.name;
-            let f = this.featureVars.get(feature);
-            if (!f) {
-                f = toId(feature, abbrev, this.featureVars);
-                this.tf.print(`const ${f} = new ${pascalCase(feature)}Phrases(context);`);
-            }
-        }
-    }
-    phrase(p) {
-        const phrasefn = functionName(p);
-        if (!this.phraseFns.has(phrasefn))
-            this.phraseFns.set(phrasefn, p);
-        const f = this.featureVars.get(p.feature.name);
-        const args = p.args.map((a) => a.toCode(this));
-        args.push(...this.extraArgs);
-        if (p instanceof Response && p.parts.length === 1 && p.saveToVariable) {
-            return this.saveToVariable(p.saveToVariable);
-        }
-        this.tf.print(`(context.task.meta.phrases.push(${str(p.toString())}),`);
-        if (p instanceof Response && p.saveToVariable) {
-            this.saveToVariable(p.saveToVariable, '');
-        }
-        this.tf.print(`await ${f}.${functionName(p)}(${args.join(', ')}));`);
-    }
-    setVariable(action) {
-        this.tf.print(`(context.task.meta.variables ??= {})[${str(action.variableName)}] = ${action.value.toCode(this)};`);
-    }
-    saveToVariable(s, what = this.extraArgs[0] + ';') {
-        this.tf.print(`(context.task.meta.variables ??= {})[${str(s.variableName)}] = ${what}`.trimEnd());
-    }
-    stringLiteral(text, { withVariables }) {
-        if (withVariables && text.match(/\$\{/)) {
-            return templateStr(text).replace(/\\\$\{([^\s}]+)\}/g, (_, x) => `\${context.task.meta.variables?.[${str(x)}]}`);
-        }
-        return str(text);
-    }
-    codeLiteral(src) {
-        return src.replace(/\$\{([^\s}]+)\}/g, (_, x) => `context.task.meta.variables?.[${str(x)}]`);
-    }
-    paramName(index) {
-        return 'xyz'.charAt(index) || `a${index + 1}`;
-    }
-    stringParamDeclaration(index) {
-        return `${this.paramName(index)}: string`;
-    }
-    variantParamDeclaration(index) {
-        return `${this.paramName(index)}: any`;
-    }
-}
-function str(s) {
-    if (s.includes('\n'))
-        return '\n' + templateStr(s);
-    let r = JSON.stringify(s);
-    return r;
-}
-function templateStr(s) {
-    return '`' + s.replace(/([`$\\])/g, '\\$1') + '`';
-}
-function capitalize(s) {
-    return s.charAt(0).toUpperCase() + s.slice(1);
-}
-function toId(s, transform, previous) {
-    if (previous.has(s))
-        return previous.get(s);
-    let base = transform(s);
-    let id = base;
-    if ([...previous.values()].includes(id)) {
-        let i = 1;
-        while ([...previous.values()].includes(id + i))
-            i++;
-        id = base + i;
-    }
-    previous.set(s, id);
-    return id;
-}
-function words(s) {
-    return s.split(/[^0-9\p{L}]+/gu);
-}
-function pascalCase(s) {
-    return words(s).map(capitalize).join('');
-}
-function underscore(s) {
-    return words(s).join('_');
-}
-function abbrev(s) {
-    return words(s)
-        .map((x) => x.charAt(0).toUpperCase())
-        .join('');
-}
-export function functionName(phrase) {
-    const { kind } = phrase;
-    return ((kind === 'response' ? 'Then_' : 'When_') +
-        (phrase.parts
-            .flatMap((c) => c instanceof Word
-            ? words(c.text).filter((x) => x)
-            : c instanceof Arg
-                ? ['']
-                : [])
-            .join('_') || ''));
-}

package/code_generator/outFile.d.ts

@@ -1,17 +0,0 @@
-import { Location } from '../model/model.ts';
-import { SourceMapGenerator } from 'source-map-js';
-export declare class OutFile {
-    name: string;
-    lines: string[];
-    level: number;
-    sm: SourceMapGenerator;
-    indentSpaces: number;
-    private currentLoc;
-    constructor(name: string);
-    indent(fn: () => void): void;
-    print(...lines: string[]): this;
-    loc({ location }: {
-        location?: Location;
-    }): this;
-    get value(): string;
-}

package/code_generator/outFile.js

@@ -1,51 +0,0 @@
-import { SourceMapGenerator } from 'source-map-js';
-export class OutFile {
-    constructor(name) {
-        this.name = name;
-        this.lines = [];
-        this.level = 0;
-        this.sm = new SourceMapGenerator();
-        this.indentSpaces = 2;
-    }
-    indent(fn) {
-        this.level++;
-        try {
-            fn();
-        }
-        finally {
-            this.level--;
-        }
-    }
-    print(...lines) {
-        const l = this.lines.length;
-        this.lines.push(...lines.map((line) => ' '.repeat(this.level * this.indentSpaces) + line));
-        if (this.currentLoc)
-            for (const i of lines.keys()) {
-                this.sm.addMapping({
-                    source: this.currentLoc.fileName,
-                    original: {
-                        line: this.currentLoc.line,
-                        column: this.currentLoc.column,
-                    },
-                    generated: {
-                        line: l + i,
-                        column: this.level * this.indentSpaces,
-                    },
-                });
-            }
-        return this;
-    }
-    loc({ location }) {
-        this.currentLoc = location;
-        return this;
-    }
-    get value() {
-        let res = this.lines.join('\n');
-        if (this.currentLoc) {
-            res +=
-                `\n\n//# sour` + // not for this file ;)
-                    `ceMappingURL=data:application/json,${encodeURIComponent(this.sm.toString())}`;
-        }
-        return res;
-    }
-}

package/code_generator/test_phrases.d.ts

@@ -1,11 +0,0 @@
-export declare class TestPhrases {
-    private context;
-    constructor(context: any);
-    When_goodbye(): void;
-    When_hello(): string;
-    When_greet_(name: string): void;
-    Then__is_(x: string, y: string): Promise<void>;
-    Then_last_char(s: string): string;
-    Then_last_char_of_greeting(): any;
-    Then_(s: string, r: string): void;
-}

package/code_generator/test_phrases.js

@@ -1,27 +0,0 @@
-import { expect } from 'vitest';
-export class TestPhrases {
-    constructor(context) {
-        this.context = context;
-    }
-    When_goodbye() {
-        throw new Error('Goodbye, World!');
-    }
-    When_hello() {
-        return (this.context.task.meta.greeting = 'Hello!');
-    }
-    When_greet_(name) {
-        this.context.task.meta.greeting = `Hello, ${name}!`;
-    }
-    async Then__is_(x, y) {
-        expect(x).toBe(y);
-    }
-    Then_last_char(s) {
-        return s.slice(-1);
-    }
-    Then_last_char_of_greeting() {
-        return this.context.task.meta.greeting.slice(-1);
-    }
-    Then_(s, r) {
-        expect(s).toBe(r);
-    }
-}

package/compiler/compile.d.ts

@@ -1,9 +0,0 @@
-import { OutFile } from '../code_generator/outFile.ts';
-export interface CompiledFeature {
-    name: string;
-    code: Record<string, string>;
-}
-export declare function compileFeature(fileName: string, src: string): {
-    outFile: OutFile;
-    phrasesFile: OutFile;
-};

package/compiler/compile.js

@@ -1,32 +0,0 @@
-import { VitestGenerator } from "../code_generator/VitestGenerator.js";
-import { OutFile } from "../code_generator/outFile.js";
-import { parse } from "../parser/parser.js";
-import { base, phrasesFileName, testFileName } from "../filenames/filenames.js";
-import { Feature } from "../model/model.js";
-import { basename } from 'node:path';
-import { autoLabel } from "../optimizations/autoLabel/autoLabel.js";
-export function compileFeature(fileName, src) {
-    const feature = new Feature(basename(base(fileName)));
-    try {
-        feature.root = parse(src);
-    }
-    catch (e) {
-        if (e.pos && e.errorMessage) {
-            e.message =
-                e.stack = `Error in ${fileName}:${e.pos.rowBegin}:${e.pos.columnBegin}\n${e.errorMessage}`;
-        }
-        else {
-            e.stack = `Error in ${fileName}\n${e.stack}`;
-        }
-        throw e;
-    }
-    feature.root.setFeature(feature);
-    autoLabel(feature.root);
-    const testFn = testFileName(fileName);
-    const testFile = new OutFile(testFn);
-    const phrasesFn = phrasesFileName(fileName);
-    const phrasesFile = new OutFile(phrasesFn);
-    const cg = new VitestGenerator(testFile, phrasesFile);
-    feature.toCode(cg);
-    return { outFile: testFile, phrasesFile };
-}

package/compiler/compiler.d.ts

@@ -1,9 +0,0 @@
-export declare function compileFiles(pattern: string | string[]): Promise<{
-    fns: string[];
-    outFns: string[];
-}>;
-export declare function compileFile(fn: string): Promise<{
-    phrasesFileAction: string;
-    outFile: import("../code_generator/outFile.ts").OutFile;
-    phrasesFile: import("../code_generator/outFile.ts").OutFile;
-} | undefined>;

package/compiler/compiler.js

@@ -1,48 +0,0 @@
-import glob from 'fast-glob';
-import { existsSync, readFileSync, writeFileSync } from 'fs';
-import { resolve } from 'path';
-import { compileFeature } from "./compile.js";
-import { testFileName } from "../filenames/filenames.js";
-import { VitestGenerator } from "../code_generator/VitestGenerator.js";
-export async function compileFiles(pattern) {
-    var _a;
-    const fns = await glob(pattern);
-    if (!fns.length)
-        throw new Error(`No files found for pattern: ${String(pattern)}`);
-    const results = await Promise.allSettled(fns.map((fn) => compileFile(fn)));
-    const compiled = results.flatMap((r) => r.status === 'fulfilled' ? [r.value] : []);
-    const errored = results.flatMap((r) => r.status === 'rejected' && r.reason ? [r.reason] : []);
-    for (const error of errored) {
-        console.error((_a = error.message) !== null && _a !== void 0 ? _a : error);
-    }
-    console.log(`Compiled ${compiled.length} file${compiled.length === 1 ? '' : 's'}.`);
-    const features = compiled.filter((f) => f !== undefined);
-    const generated = features.filter((f) => f.phrasesFileAction === 'generated');
-    if (generated.length) {
-        console.log(`Generated ${generated.length} phrases file${generated.length === 1 ? '' : 's'}.`);
-    }
-    return { fns, outFns: features.map((f) => f.outFile.name) };
-}
-export async function compileFile(fn) {
-    var _a;
-    fn = resolve(fn);
-    const src = readFileSync(fn, 'utf8')
-        .toString()
-        .replace(/\r\n/g, '\n')
-        .replace(/\r/g, '\n');
-    try {
-        const { outFile, phrasesFile } = compileFeature(fn, src);
-        writeFileSync(outFile.name, outFile.value);
-        let phrasesFileAction = 'ignored';
-        if (!existsSync(phrasesFile.name)) {
-            phrasesFileAction = 'generated';
-            writeFileSync(phrasesFile.name, phrasesFile.value);
-        }
-        return { phrasesFileAction, outFile, phrasesFile };
-    }
-    catch (e) {
-        const outFileName = testFileName(fn);
-        writeFileSync(outFileName, VitestGenerator.error((_a = e.message) !== null && _a !== void 0 ? _a : `${e}`, e.stack));
-        return undefined;
-    }
-}

package/filenames/filenames.d.ts

@@ -1,3 +0,0 @@
-export declare function base(fn: string): string;
-export declare function testFileName(fn: string): string;
-export declare function phrasesFileName(fn: string): string;

package/filenames/filenames.js

@@ -1,17 +0,0 @@
-import glob from 'fast-glob';
-const { globSync, convertPathToPattern } = glob;
-export function base(fn) {
-    return fn.replace(/\.harmony(\.\w+)?$/i, '');
-}
-export function testFileName(fn) {
-    return base(fn) + '.test.mjs';
-}
-export function phrasesFileName(fn) {
-    const baseFn = base(fn);
-    const pattern = convertPathToPattern(baseFn);
-    const existing = globSync(`${pattern}.phrases.{tsx,jsx,ts,js}`);
-    if (existing.length) {
-        return existing.sort().at(-1);
-    }
-    return `${baseFn}.phrases.ts`;
-}