harmonyc 0.19.0 → 0.20.0

package/package.json

@@ -1,49 +1,46 @@
 {
   "name": "harmonyc",
-  "description": "Harmony Code - model-driven BDD for Vitest",
-  "version": "0.19.0",
-  "author": "Bernát Kalló",
+  "version": "0.20.0",
   "type": "module",
-  "bin": {
-    "harmonyc": "./cli.js"
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "harmonyc": "tsx ./src/cli/cli",
+    "test": "vitest --run",
+    "test:compile": "tsx ./src/cli/cli 'src/**/*.harmony'",
+    "dev": "vitest --watch",
+    "publish": "npm publish",
+    "release": "npm run build && release publish"
   },
+  "files": [
+    "dist"
+  ],
   "exports": {
     "./vitest": {
-      "types": "./vitest/index.d.ts",
-      "default": "./vitest/index.js"
+      "types": "./dist/vitest/index.d.ts",
+      "default": "./dist/vitest/index.js"
     }
   },
-  "homepage": "https://github.com/harmony-ac/code#readme",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/harmony-ac/code.git"
-  },
-  "bugs": {
-    "url": "https://github.com/harmony-ac/code/issues"
+  "bin": {
+    "harmonyc": "./dist/cli/cli.js"
   },
   "dependencies": {
     "fast-glob": "^3.3.2",
     "tinyrainbow": "1",
+    "ts-morph": "^27.0.2",
     "typescript-parsec": "0.3.4"
   },
   "optionalDependencies": {
     "watcher": "^2.3.1"
   },
-  "license": "MIT",
-  "keywords": [
-    "unit test",
-    "unit testing",
-    "bdd",
-    "behavior-driven",
-    "test design",
-    "test design automation",
-    "harmony.ac",
-    "test framework",
-    "model-based test",
-    "model-based testing",
-    "test model",
-    "test modeling",
-    "test modelling",
-    "vitest"
-  ]
-}
+  "devDependencies": {
+    "@ossjs/release": "^0.10.0",
+    "@types/debug": "^4.1.12",
+    "@types/node": "^22.10.6",
+    "expect": "^29.7.0",
+    "tsx": "^4.7.1",
+    "typescript": "^5.3.3",
+    "vite": "^7.1.10",
+    "vitest": "^3.2.4"
+  }
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024-2025 Bernát Kalló
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/README.md

@@ -1,142 +0,0 @@
-# Harmony Code
-
-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
-
-You need to have Node.js installed. Then you can install Harmony Code in your project folder by:
-
-```bash
-npm install harmonyc
-```
-
-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()],
-  include: ['src/**/*.harmony'],
-}
-```
-
-This will run .harmony files in vitest.
-
-## VSCode plugin
-
-Harmony Code has a [VSCode plugin](https://marketplace.visualstudio.com/items?itemName=harmony-ac.harmony-code) that supports syntax highlighting.
-
-Harmony Code is compatible with Vitest's VSCode plugin, so you can run and debug tests from the editor.
-
-## Syntax
-
-A `.harmony` file is a text file with a syntax that looks like this:
-
-```
-+ Products API:
-  + Create:
-    + Anonymous:
-      - create product => !! "unauthorized"
-    + Admin:
-      - authenticate with "admin" => product count `0`
-      - create product
-        => product created
-        => product count `1`
-      - Delete:
-        - delete product => product deleted => product count `0`
-```
-
-### Indentation
-
-The lines of a file are nodes of a tree. The tree is specified with the indentation of the lines, which is n times 2 spaces and a `+` or `-` with one more space. The `+` or `-` sign is considered to be part of the indentation.
-
-### Sequences and forks
-
-`-` means a sequence: the node follows the previous sibling node and its descendants.
-
-`+` means a fork: the node directly follows its parent node. All siblings with `+` are separate branches, they will generate separate scenarios.
-
-### Phrases (actions and responses)
-
-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. 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
-
-Phrases (actions and responses) can have arguments which are passed to the implementation function. There are two types of arguments: strings and code fragments:
-
-```harmony
-+ strings:
-  + hello "John"
-+ code fragment:
-  + greet `3` times
-```
-
-becomes
-
-```javascript
-test('T1 - strings', async () => {
-  const P = new Phrases()
-  await P.When_hello_('John')
-})
-test('T2 - code fragment', async () => {
-  const P = new Phrases()
-  await P.When_greet__times(3)
-})
-```
-
-### Labels
-
-Labels are lines that start with `-` or `+` and end with `:`. You can use them to structure your test design.
-They are not included in the test case, but the test case name is generated from the labels.
-
-### Comments
-
-Lines starting with `#` or `//` are comments and are ignored.
-
-### Switches
-
-You can generate multiple test cases by adding a `{ A / B / C }` syntax into action(s) and possibly response(s).
-
-```harmony
-+ password is { "A" / "asdf" / "password123" } => !! "password is too weak"
-```
-
-### 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 `!!`.
-
-### Variables
-
-You can set variables in the tests and use them in strings and code fragments:
-
-```
-+ set variable:
-  + ${name} "John"
-    + greet "${name}" => "hello John"
-+ store result into variable:
-  + run process => ${result}
-    + "${result}" is "success"
-```
-
-becomes
-
-```javascript
-test('T1 - set variable', (context) => {
-  const P = new Phrases();
-  (context.task.meta.variables ??= {})['name'] = "John";
-  await P.When_greet_(context.task.meta.variables?.['name']);
-})
-test('T2 - store result in variable', (context) => {
-  const P = new Phrases();
-  const r = await P.When_run_process();
-  (context.task.meta.variables ??= {})['result'] = r;
-  await P.Then__is_(`${context.task.meta.variables?.['result']});
-})
-```
-
-## License
-
-MIT