harmonyc 0.7.1 → 0.8.0

package/README.md

@@ -56,11 +56,11 @@ The lines of a file are nodes of a tree. The tree is specified with the indentat
 
 `+` means a fork: the node directly follows its parent node. All siblings with `+` are separate branches, they will generate separate scenarios.
 
-### Actions and responses (phrases)
+### Phrases (actions and responses)
 
-After the mark, every node can contain an action and zero or more responses. The action is the text before the `=>`, and the responses are the text after the `=>`.
+After the mark, every node can contain an **action** and zero or more **responses**, together called **phrases**. The action is the text before the `=>`, and the responses are the text after the `=>`.
 
-Both actions and responses get compiled to simple function calls - in JavaScript, awaited function calls. The return value of the action is passed to the responses of the same step as the last argument.
+Both actions and responses get compiled to simple function calls - in JavaScript, awaited function calls. Actions will become `When_*` functions, and responses will become `Then_*` functions. The return value of the action is passed to the responses of the same step as the last argument.
 
 ### Arguments
 
@@ -75,11 +75,6 @@ They are not included in the test case, but the test case name is generated from
 
 Lines starting with `#` or `//` are comments and are ignored.
 
-### Steps
-
-All other lines are steps. A step consists of an action, and one or more responses denoted by `=>`.
-Actions will become `When` steps, and responses will become `Then` steps.
-
 ### Error matching
 
 You can use `!!` to denote an error response. This will verify that the action throws an error. You can specify the error message after the `!!`.

package/code_generator/JavaScript.js

@@ -11,18 +11,18 @@ export class NodeTest {
         this.extraArgs = [];
     }
     feature(feature) {
-        const stepsModule = './' + basename(this.sf.name.replace(/.(js|ts)$/, ''));
+        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';`);
         }
-        this.tf.print(`import ${fn}Steps from ${str(stepsModule)};`);
+        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)}Steps {`);
+        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);
@@ -72,7 +72,7 @@ export class NodeTest {
             let f = this.featureVars.get(feature);
             if (!f) {
                 f = toId(feature, abbrev, this.featureVars);
-                this.tf.print(`const ${f} = new ${pascalCase(feature)}Steps();`);
+                this.tf.print(`const ${f} = new ${pascalCase(feature)}Phrases();`);
             }
         }
         if (responses.length === 0) {

package/compiler/compile.js

@@ -1,7 +1,7 @@
 import { NodeTest } from "../code_generator/JavaScript.js";
 import { OutFile } from "../code_generator/outFile.js";
 import { parse } from "../parser/parser.js";
-import { base, stepsFileName, testFileName } from "../filenames/filenames.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";
@@ -24,9 +24,9 @@ export function compileFeature(fileName, src) {
     autoLabel(feature.root);
     const testFn = testFileName(fileName);
     const testFile = new OutFile(testFn);
-    const stepsFn = stepsFileName(fileName);
-    const stepsFile = new OutFile(stepsFn);
-    const cg = new NodeTest(testFile, stepsFile);
+    const phrasesFn = phrasesFileName(fileName);
+    const phrasesFile = new OutFile(phrasesFn);
+    const cg = new NodeTest(testFile, phrasesFile);
     feature.toCode(cg);
-    return { outFile: testFile, stepsFile };
+    return { outFile: testFile, phrasesFile };
 }

package/compiler/compiler.js

@@ -14,7 +14,7 @@ export async function compileFiles(pattern) {
         console.log((_a = error.message) !== null && _a !== void 0 ? _a : error);
     }
     console.log(`Compiled ${fns.length} file${fns.length === 1 ? '' : 's'}.`);
-    const generated = features.filter((f) => f.stepsFileAction === 'generated');
+    const generated = features.filter((f) => f.phrasesFileAction === 'generated');
     if (generated.length) {
         console.log(`Generated ${generated.length} steps file${generated.length === 1 ? '' : 's'}.`);
     }
@@ -26,12 +26,12 @@ export async function compileFile(fn) {
         .toString()
         .replace(/\r\n/g, '\n')
         .replace(/\r/g, '\n');
-    const { outFile, stepsFile } = compileFeature(fn, src);
+    const { outFile, phrasesFile } = compileFeature(fn, src);
     writeFileSync(outFile.name, outFile.value);
-    let stepsFileAction = 'ignored';
-    if (!existsSync(stepsFile.name)) {
-        stepsFileAction = 'generated';
-        writeFileSync(stepsFile.name, stepsFile.value);
+    let phrasesFileAction = 'ignored';
+    if (!existsSync(phrasesFile.name)) {
+        phrasesFileAction = 'generated';
+        writeFileSync(phrasesFile.name, phrasesFile.value);
     }
-    return { stepsFileAction, outFile, stepsFile };
+    return { phrasesFileAction, outFile, phrasesFile };
 }

package/filenames/filenames.js

@@ -6,12 +6,12 @@ export function base(fn) {
 export function testFileName(fn) {
     return base(fn) + '.test.mjs';
 }
-export function stepsFileName(fn) {
+export function phrasesFileName(fn) {
     const baseFn = base(fn);
     const pattern = convertPathToPattern(baseFn);
-    const existing = globSync(`${pattern}.steps.{tsx,jsx,ts,js}`);
+    const existing = globSync(`${pattern}.phrases.{tsx,jsx,ts,js}`);
     if (existing.length) {
         return existing.sort().at(-1);
     }
-    return `${baseFn}.steps.ts`;
+    return `${baseFn}.phrases.ts`;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "harmonyc",
   "description": "Harmony Code - model-driven BDD for Vitest",
-  "version": "0.7.1",
+  "version": "0.8.0",
   "author": "Bernát Kalló",
   "type": "module",
   "bin": {
@@ -22,10 +22,9 @@
     "url": "https://github.com/harmony-ac/code/issues"
   },
   "dependencies": {
-    "@cucumber/cucumber-expressions": "^17.1.0",
     "fast-glob": "^3.3.2",
-    "remark-parse": "^11.0.0",
-    "source-map-js": "^1.2.0"
+    "typescript-parsec": "0.3.4",
+    "watcher": "^2.3.1"
   },
   "license": "MIT",
   "keywords": [