From 941926c9d0702b1b3b84e418a57f1acf00eaf015 Mon Sep 17 00:00:00 2001 From: OmarFourati Date: Sun, 10 Dec 2023 17:28:41 +0100 Subject: [PATCH 01/15] add information about updating jayvee extension --- apps/docs/docs/user/intro.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/apps/docs/docs/user/intro.md b/apps/docs/docs/user/intro.md index 2832707c..93f66995 100644 --- a/apps/docs/docs/user/intro.md +++ b/apps/docs/docs/user/intro.md @@ -4,7 +4,7 @@ sidebar_position: 1 # Introduction to Jayvee -Jayvee is a domain-specific language (DSL) for data engineering - the cleaning and preprocessing of data for later activities like data science or machine learning. You can use Jayvee to **model an ETL pipeline** and the command-line interpreter to **run the ETL pipeline** on your local machine. +Jayvee is a domain-specific language (DSL) for data engineering - the cleaning and preprocessing of data for later activities like data science or machine learning. You can use Jayvee to **model an ETL pipeline** and the command-line interpreter to **run the ETL pipeline** on your local machine. ## Installation @@ -15,6 +15,7 @@ npm install -g @jvalue/jayvee-interpreter ``` You can install a specific version using the `@`-syntax, e.g., version `0.0.17`: + ```bash npm install -g @jvalue/jayvee-interpreter@0.0.17 ``` @@ -23,6 +24,9 @@ npm install -g @jvalue/jayvee-interpreter@0.0.17 Updating the interpreter is done by reinstalling it using `npm`. Make sure to also update the [VSCode plugin](#vscode-plugin) to match the installed interpreter if you use it. +IMPORTANT: If a new Jayvee update is available, you need to update your `Jayvee` extension as well +Extensions and updates can be found [here](https://github.com/jvalue/jayvee/releases/tag/v0.2.0-alpha) + ```bash npm install -g @jvalue/jayvee-interpreter ``` @@ -47,7 +51,6 @@ Run with **additional debug output**: jv -d ``` - With **runtime parameters**: ```console @@ -61,35 +64,37 @@ Print debugging is further configured by the parameters `--debug-granularity` an ```console jv -d -dg peek ``` + The value of the parameter `--debug-granularity` (short `-dg`) can have the following values: -- `peek` to log a short summary, including a small subset of data + +- `peek` to log a short summary, including a small subset of data - `exhaustive` to log a summary, including the full data - `minimal` to log a summary, including no additional data (default). -To see logs, debugging has to be enabled using the `-d` flag. + To see logs, debugging has to be enabled using the `-d` flag. ```console jv -d --debug-granularity peek ``` + The parameter `--debug-target` (short `-dt`) allows to specify which blocks should be logged for debugging. Separate block names by comma if multiple blocks are targeted. All blocks are logged if the parameter is omitted. + ```console jv -d --debug-granularity peek --debug-target MyExtractorBlock,MySinkBlock ``` - ## Examples You can find multiple examples [here](https://github.com/jvalue/jayvee/tree/main/example). Copy them to your local file system and execute them with the `jv` command on your command line (see [usage](#usage)). - ## VSCode Plugin To set up Jayvee locally in VS Code, you need to install the latest Jayvee VS Code extension. -To install the most recent extension, go to our [latest release](https://github.com/jvalue/jayvee/releases/latest) +To install the most recent extension, go to our [latest release](https://github.com/jvalue/jayvee/releases/latest) and download the `jayvee.vsix` file from the release assets. -Next, go to [this page](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix) and +Next, go to [this page](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix) and follow the instructions for installing the downloaded extension. ## Troubleshooting 1. Error `structuredClone is not defined` - * Please make sure you use node version 17+. + - Please make sure you use node version 17+. From ee4103f6450a728ada6dfde58ac8f458346fd510 Mon Sep 17 00:00:00 2001 From: OmarFourati Date: Sun, 10 Dec 2023 17:43:37 +0100 Subject: [PATCH 02/15] refactor: small enhancement on added documentation --- apps/docs/docs/user/intro.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/apps/docs/docs/user/intro.md b/apps/docs/docs/user/intro.md index 93f66995..2775b391 100644 --- a/apps/docs/docs/user/intro.md +++ b/apps/docs/docs/user/intro.md @@ -24,8 +24,9 @@ npm install -g @jvalue/jayvee-interpreter@0.0.17 Updating the interpreter is done by reinstalling it using `npm`. Make sure to also update the [VSCode plugin](#vscode-plugin) to match the installed interpreter if you use it. -IMPORTANT: If a new Jayvee update is available, you need to update your `Jayvee` extension as well -Extensions and updates can be found [here](https://github.com/jvalue/jayvee/releases/tag/v0.2.0-alpha) +IMPORTANT: If a new Jayvee update is available, you need to update your Jayvee extension as well. + +Extensions and updates can be found [here](https://github.com/jvalue/jayvee/releases/tag/v0.2.0-alpha). ```bash npm install -g @jvalue/jayvee-interpreter From 3108169384309f327d63bd3af5db32a49541ae53 Mon Sep 17 00:00:00 2001 From: OmarFourati Date: Mon, 11 Dec 2023 19:19:48 +0100 Subject: [PATCH 03/15] refactor: update documentation for updating jayvee --- apps/docs/docs/user/intro.md | 6 +++-- apps/docs/docs/user/update.md | 45 +++++++++++++++++++++++++++++++++++ 2 files changed, 49 insertions(+), 2 deletions(-) create mode 100644 apps/docs/docs/user/update.md diff --git a/apps/docs/docs/user/intro.md b/apps/docs/docs/user/intro.md index 2775b391..f70615d4 100644 --- a/apps/docs/docs/user/intro.md +++ b/apps/docs/docs/user/intro.md @@ -24,9 +24,11 @@ npm install -g @jvalue/jayvee-interpreter@0.0.17 Updating the interpreter is done by reinstalling it using `npm`. Make sure to also update the [VSCode plugin](#vscode-plugin) to match the installed interpreter if you use it. -IMPORTANT: If a new Jayvee update is available, you need to update your Jayvee extension as well. +IMPORTANT: If a new Jayvee update is available, you need to update your VSCode extension for Jayvee as well. -Extensions and updates can be found [here](https://github.com/jvalue/jayvee/releases/tag/v0.2.0-alpha). +Extensions and updates can be found [here](https://github.com/jvalue/jayvee/releases/latest). + +For more detailed information, go to the [update page](). ```bash npm install -g @jvalue/jayvee-interpreter diff --git a/apps/docs/docs/user/update.md b/apps/docs/docs/user/update.md new file mode 100644 index 00000000..ea06656b --- /dev/null +++ b/apps/docs/docs/user/update.md @@ -0,0 +1,45 @@ +# How to update Jayvee + +Jayvee is constently getting **updates** as a dedicated team of developers diligently addresses **performance issues** and incorporates **new features** to meet the evolving needs of its user base. + +### Update Jayvee the right way. + +To update Jayvee, you need: + +1. Update the interprestere by reinstalling it using npm: + +```bash +npm install -g @jvalue/jayvee-interpreter +``` + +Note: Updating to a specific version works using the `@`-syntax, e.g., version `0.0.17`: + +```bash +npm install -g @jvalue/jayvee-interpreter@0.0.17 +``` + +2. Update your VSCode Extension: + +- Go [here](https://github.com/jvalue/jayvee/releases/latest) to find the latest (or a specific) version of the VSCode Extenstion. + +- Then, download the latest `jayvee.vsix` file. + +- Finally, open your Command Prompt(terminal), and paste the code below: + +```bash +code --install-extension jayvee.vsix +``` + +### Version Checks. + +To verify wether the wanted version of Jayvee and VSCode extension where installed successfully, you can run in your Command Prompt(terminal): + +For **Jayvee**: + +```bash +jv -V +``` + +For the **VSCode extension**: + +In VSCode: Go to the extensions menu, and look for `Jayvee`. The version is then displayed on the information page of the extension. From 7b719b49aa912b9973fb07db7b171619ae6fc2dc Mon Sep 17 00:00:00 2001 From: OmarFourati Date: Tue, 12 Dec 2023 16:54:37 +0100 Subject: [PATCH 04/15] refactor: add link to the new update page --- apps/docs/docs/user/intro.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/apps/docs/docs/user/intro.md b/apps/docs/docs/user/intro.md index f70615d4..d2508f7f 100644 --- a/apps/docs/docs/user/intro.md +++ b/apps/docs/docs/user/intro.md @@ -26,9 +26,7 @@ Updating the interpreter is done by reinstalling it using `npm`. Make sure to al IMPORTANT: If a new Jayvee update is available, you need to update your VSCode extension for Jayvee as well. -Extensions and updates can be found [here](https://github.com/jvalue/jayvee/releases/latest). - -For more detailed information, go to the [update page](). +More details on updating can be found [here](./update.md) ```bash npm install -g @jvalue/jayvee-interpreter From e7e99343dd399b542bec7be7b217ed5150f2c4c1 Mon Sep 17 00:00:00 2001 From: OmarFourati Date: Tue, 12 Dec 2023 17:00:27 +0100 Subject: [PATCH 05/15] fix: fix typo --- apps/docs/docs/user/update.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/apps/docs/docs/user/update.md b/apps/docs/docs/user/update.md index ea06656b..21e5505e 100644 --- a/apps/docs/docs/user/update.md +++ b/apps/docs/docs/user/update.md @@ -4,9 +4,9 @@ Jayvee is constently getting **updates** as a dedicated team of developers dilig ### Update Jayvee the right way. -To update Jayvee, you need: +To update Jayvee, you need to: -1. Update the interprestere by reinstalling it using npm: +1. Update the interpreter by reinstalling it using npm: ```bash npm install -g @jvalue/jayvee-interpreter @@ -20,7 +20,7 @@ npm install -g @jvalue/jayvee-interpreter@0.0.17 2. Update your VSCode Extension: -- Go [here](https://github.com/jvalue/jayvee/releases/latest) to find the latest (or a specific) version of the VSCode Extenstion. +- Go [here](https://github.com/jvalue/jayvee/releases/latest) to find the latest(or a specific) version of the VSCode Extenstion. - Then, download the latest `jayvee.vsix` file. From ba669e1dee57b8318af2bd4eecf8afd00da82a81 Mon Sep 17 00:00:00 2001 From: OmarFourati Date: Tue, 12 Dec 2023 17:08:57 +0100 Subject: [PATCH 06/15] vscode extension manual update documentation --- apps/docs/docs/user/update.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/apps/docs/docs/user/update.md b/apps/docs/docs/user/update.md index 21e5505e..8d59d8bf 100644 --- a/apps/docs/docs/user/update.md +++ b/apps/docs/docs/user/update.md @@ -30,6 +30,8 @@ npm install -g @jvalue/jayvee-interpreter@0.0.17 code --install-extension jayvee.vsix ``` +For manual installation, follow this [link](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix) for the official VSCode documentation. + ### Version Checks. To verify wether the wanted version of Jayvee and VSCode extension where installed successfully, you can run in your Command Prompt(terminal): From e2d02e2995c18bd753e556ef50da04ba082907fa Mon Sep 17 00:00:00 2001 From: OmarFourati Date: Thu, 21 Dec 2023 15:11:15 +0100 Subject: [PATCH 07/15] update new page postion and create license info --- apps/docs/docs/user/intro.md | 2 +- apps/docs/docs/user/update.md | 6 +++++- apps/docs/docs/user/update.md.license | 3 +++ 3 files changed, 9 insertions(+), 2 deletions(-) create mode 100644 apps/docs/docs/user/update.md.license diff --git a/apps/docs/docs/user/intro.md b/apps/docs/docs/user/intro.md index d2508f7f..2cd0b724 100644 --- a/apps/docs/docs/user/intro.md +++ b/apps/docs/docs/user/intro.md @@ -26,7 +26,7 @@ Updating the interpreter is done by reinstalling it using `npm`. Make sure to al IMPORTANT: If a new Jayvee update is available, you need to update your VSCode extension for Jayvee as well. -More details on updating can be found [here](./update.md) +More details on updating can be found [here](./update.md). ```bash npm install -g @jvalue/jayvee-interpreter diff --git a/apps/docs/docs/user/update.md b/apps/docs/docs/user/update.md index 8d59d8bf..a8bd4bf9 100644 --- a/apps/docs/docs/user/update.md +++ b/apps/docs/docs/user/update.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 1 +--- + # How to update Jayvee Jayvee is constently getting **updates** as a dedicated team of developers diligently addresses **performance issues** and incorporates **new features** to meet the evolving needs of its user base. @@ -32,7 +36,7 @@ code --install-extension jayvee.vsix For manual installation, follow this [link](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix) for the official VSCode documentation. -### Version Checks. +### Version Check. To verify wether the wanted version of Jayvee and VSCode extension where installed successfully, you can run in your Command Prompt(terminal): diff --git a/apps/docs/docs/user/update.md.license b/apps/docs/docs/user/update.md.license new file mode 100644 index 00000000..42737858 --- /dev/null +++ b/apps/docs/docs/user/update.md.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg + +SPDX-License-Identifier: AGPL-3.0-only \ No newline at end of file From d341ba53c2880486eb9e9fa73bfa40cce2d27036 Mon Sep 17 00:00:00 2001 From: OmarFourati Date: Thu, 21 Dec 2023 15:14:56 +0100 Subject: [PATCH 08/15] resolve conflicts --- apps/docs/docs/user/intro.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/apps/docs/docs/user/intro.md b/apps/docs/docs/user/intro.md index 2cd0b724..470f5faa 100644 --- a/apps/docs/docs/user/intro.md +++ b/apps/docs/docs/user/intro.md @@ -4,7 +4,9 @@ sidebar_position: 1 # Introduction to Jayvee -Jayvee is a domain-specific language (DSL) for data engineering - the cleaning and preprocessing of data for later activities like data science or machine learning. You can use Jayvee to **model an ETL pipeline** and the command-line interpreter to **run the ETL pipeline** on your local machine. +Jayvee is a domain-specific language (DSL) for automated processing of data pipelines. +The Jayvee interpreter allows executing such data pipelines on local machines. +Data engineers can use Jayvee and its interpreter to clean and preprocess data for later activities like data science or machine learning. ## Installation From 88af75c3f7a517762dd55194962685daf49cae44 Mon Sep 17 00:00:00 2001 From: OmarFourati Date: Tue, 26 Dec 2023 10:51:51 +0100 Subject: [PATCH 09/15] update docus with introduction to jayvee and update page --- apps/docs/docs/user/intro.md | 103 ------------------ apps/docs/docs/user/intro/.gitignore | 5 + apps/docs/docs/user/intro/_category_.json | 8 ++ .../_category_.json.license} | 0 apps/docs/docs/user/update.md | 51 --------- apps/docs/docs/user/update.md.license | 3 - 6 files changed, 13 insertions(+), 157 deletions(-) delete mode 100644 apps/docs/docs/user/intro.md create mode 100644 apps/docs/docs/user/intro/.gitignore create mode 100644 apps/docs/docs/user/intro/_category_.json rename apps/docs/docs/user/{intro.md.license => intro/_category_.json.license} (100%) delete mode 100644 apps/docs/docs/user/update.md delete mode 100644 apps/docs/docs/user/update.md.license diff --git a/apps/docs/docs/user/intro.md b/apps/docs/docs/user/intro.md deleted file mode 100644 index 470f5faa..00000000 --- a/apps/docs/docs/user/intro.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Introduction to Jayvee - -Jayvee is a domain-specific language (DSL) for automated processing of data pipelines. -The Jayvee interpreter allows executing such data pipelines on local machines. -Data engineers can use Jayvee and its interpreter to clean and preprocess data for later activities like data science or machine learning. - -## Installation - -Install the interpreter via `npm`. You will need a **nodejs version >= 17.0.0**. - -```bash -npm install -g @jvalue/jayvee-interpreter -``` - -You can install a specific version using the `@`-syntax, e.g., version `0.0.17`: - -```bash -npm install -g @jvalue/jayvee-interpreter@0.0.17 -``` - -## Update - -Updating the interpreter is done by reinstalling it using `npm`. Make sure to also update the [VSCode plugin](#vscode-plugin) to match the installed interpreter if you use it. - -IMPORTANT: If a new Jayvee update is available, you need to update your VSCode extension for Jayvee as well. - -More details on updating can be found [here](./update.md). - -```bash -npm install -g @jvalue/jayvee-interpreter -``` - -## Usage - -### Show help - -```console -jv -h -``` - -### Run a `.jv` file - -```console -jv -``` - -Run with **additional debug output**: - -```console -jv -d -``` - -With **runtime parameters**: - -```console -jv -e = -e = ... -``` - -### Debug a `.jv` file - -Print debugging is further configured by the parameters `--debug-granularity` and `--debug-target`. - -```console -jv -d -dg peek -``` - -The value of the parameter `--debug-granularity` (short `-dg`) can have the following values: - -- `peek` to log a short summary, including a small subset of data -- `exhaustive` to log a summary, including the full data -- `minimal` to log a summary, including no additional data (default). - To see logs, debugging has to be enabled using the `-d` flag. - -```console -jv -d --debug-granularity peek -``` - -The parameter `--debug-target` (short `-dt`) allows to specify which blocks should be logged for debugging. Separate block names by comma if multiple blocks are targeted. All blocks are logged if the parameter is omitted. - -```console -jv -d --debug-granularity peek --debug-target MyExtractorBlock,MySinkBlock -``` - -## Examples - -You can find multiple examples [here](https://github.com/jvalue/jayvee/tree/main/example). Copy them to your local file system and execute them with the `jv` command on your command line (see [usage](#usage)). - -## VSCode Plugin - -To set up Jayvee locally in VS Code, you need to install the latest Jayvee VS Code extension. -To install the most recent extension, go to our [latest release](https://github.com/jvalue/jayvee/releases/latest) -and download the `jayvee.vsix` file from the release assets. -Next, go to [this page](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix) and -follow the instructions for installing the downloaded extension. - -## Troubleshooting - -1. Error `structuredClone is not defined` - - Please make sure you use node version 17+. diff --git a/apps/docs/docs/user/intro/.gitignore b/apps/docs/docs/user/intro/.gitignore new file mode 100644 index 00000000..277e9bb1 --- /dev/null +++ b/apps/docs/docs/user/intro/.gitignore @@ -0,0 +1,5 @@ +# SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg +# +# SPDX-License-Identifier: AGPL-3.0-only + +*.md \ No newline at end of file diff --git a/apps/docs/docs/user/intro/_category_.json b/apps/docs/docs/user/intro/_category_.json new file mode 100644 index 00000000..478d4d8f --- /dev/null +++ b/apps/docs/docs/user/intro/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Introduction to Jayvee", + "position": 1, + "link": { + "type": "generated-index", + "description": "All the essentials Information to get started with Javee." + } +} diff --git a/apps/docs/docs/user/intro.md.license b/apps/docs/docs/user/intro/_category_.json.license similarity index 100% rename from apps/docs/docs/user/intro.md.license rename to apps/docs/docs/user/intro/_category_.json.license diff --git a/apps/docs/docs/user/update.md b/apps/docs/docs/user/update.md deleted file mode 100644 index a8bd4bf9..00000000 --- a/apps/docs/docs/user/update.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -sidebar_position: 1 ---- - -# How to update Jayvee - -Jayvee is constently getting **updates** as a dedicated team of developers diligently addresses **performance issues** and incorporates **new features** to meet the evolving needs of its user base. - -### Update Jayvee the right way. - -To update Jayvee, you need to: - -1. Update the interpreter by reinstalling it using npm: - -```bash -npm install -g @jvalue/jayvee-interpreter -``` - -Note: Updating to a specific version works using the `@`-syntax, e.g., version `0.0.17`: - -```bash -npm install -g @jvalue/jayvee-interpreter@0.0.17 -``` - -2. Update your VSCode Extension: - -- Go [here](https://github.com/jvalue/jayvee/releases/latest) to find the latest(or a specific) version of the VSCode Extenstion. - -- Then, download the latest `jayvee.vsix` file. - -- Finally, open your Command Prompt(terminal), and paste the code below: - -```bash -code --install-extension jayvee.vsix -``` - -For manual installation, follow this [link](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix) for the official VSCode documentation. - -### Version Check. - -To verify wether the wanted version of Jayvee and VSCode extension where installed successfully, you can run in your Command Prompt(terminal): - -For **Jayvee**: - -```bash -jv -V -``` - -For the **VSCode extension**: - -In VSCode: Go to the extensions menu, and look for `Jayvee`. The version is then displayed on the information page of the extension. diff --git a/apps/docs/docs/user/update.md.license b/apps/docs/docs/user/update.md.license deleted file mode 100644 index 42737858..00000000 --- a/apps/docs/docs/user/update.md.license +++ /dev/null @@ -1,3 +0,0 @@ -SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg - -SPDX-License-Identifier: AGPL-3.0-only \ No newline at end of file From ca06b6f9fab567e1b3bd0386a59e637f9db0ef61 Mon Sep 17 00:00:00 2001 From: OmarFourati Date: Tue, 26 Dec 2023 10:54:08 +0100 Subject: [PATCH 10/15] place intro and update page under introduction to jayvee --- apps/docs/docs/user/intro/.gitignore | 5 -- apps/docs/docs/user/intro/intro.md | 104 +++++++++++++++++++++++++++ apps/docs/docs/user/intro/update.md | 52 ++++++++++++++ 3 files changed, 156 insertions(+), 5 deletions(-) delete mode 100644 apps/docs/docs/user/intro/.gitignore create mode 100644 apps/docs/docs/user/intro/intro.md create mode 100644 apps/docs/docs/user/intro/update.md diff --git a/apps/docs/docs/user/intro/.gitignore b/apps/docs/docs/user/intro/.gitignore deleted file mode 100644 index 277e9bb1..00000000 --- a/apps/docs/docs/user/intro/.gitignore +++ /dev/null @@ -1,5 +0,0 @@ -# SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg -# -# SPDX-License-Identifier: AGPL-3.0-only - -*.md \ No newline at end of file diff --git a/apps/docs/docs/user/intro/intro.md b/apps/docs/docs/user/intro/intro.md new file mode 100644 index 00000000..797e8d38 --- /dev/null +++ b/apps/docs/docs/user/intro/intro.md @@ -0,0 +1,104 @@ +--- +sidebar_position: 1 +title: Getting Started +--- + +# Introduction to Jayvee + +Jayvee is a domain-specific language (DSL) for automated processing of data pipelines. +The Jayvee interpreter allows executing such data pipelines on local machines. +Data engineers can use Jayvee and its interpreter to clean and preprocess data for later activities like data science or machine learning. + +## Installation + +Install the interpreter via `npm`. You will need a **nodejs version >= 17.0.0**. + +```bash +npm install -g @jvalue/jayvee-interpreter +``` + +You can install a specific version using the `@`-syntax, e.g., version `0.0.17`: + +```bash +npm install -g @jvalue/jayvee-interpreter@0.0.17 +``` + +## Update + +Updating the interpreter is done by reinstalling it using `npm`. Make sure to also update the [VSCode plugin](#vscode-plugin) to match the installed interpreter if you use it. + +IMPORTANT: If a new Jayvee update is available, you need to update your VSCode extension for Jayvee as well. + +More details on updating can be found [here](./update.md). + +```bash +npm install -g @jvalue/jayvee-interpreter +``` + +## Usage + +### Show help + +```console +jv -h +``` + +### Run a `.jv` file + +```console +jv +``` + +Run with **additional debug output**: + +```console +jv -d +``` + +With **runtime parameters**: + +```console +jv -e = -e = ... +``` + +### Debug a `.jv` file + +Print debugging is further configured by the parameters `--debug-granularity` and `--debug-target`. + +```console +jv -d -dg peek +``` + +The value of the parameter `--debug-granularity` (short `-dg`) can have the following values: + +- `peek` to log a short summary, including a small subset of data +- `exhaustive` to log a summary, including the full data +- `minimal` to log a summary, including no additional data (default). + To see logs, debugging has to be enabled using the `-d` flag. + +```console +jv -d --debug-granularity peek +``` + +The parameter `--debug-target` (short `-dt`) allows to specify which blocks should be logged for debugging. Separate block names by comma if multiple blocks are targeted. All blocks are logged if the parameter is omitted. + +```console +jv -d --debug-granularity peek --debug-target MyExtractorBlock,MySinkBlock +``` + +## Examples + +You can find multiple examples [here](https://github.com/jvalue/jayvee/tree/main/example). Copy them to your local file system and execute them with the `jv` command on your command line (see [usage](#usage)). + +## VSCode Plugin + +To set up Jayvee locally in VS Code, you need to install the latest Jayvee VS Code extension. +To install the most recent extension, go to our [latest release](https://github.com/jvalue/jayvee/releases/latest) +and download the `jayvee.vsix` file from the release assets. +Next, go to [this page](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix) and +follow the instructions for installing the downloaded extension. + +## Troubleshooting + +1. Error `structuredClone is not defined` + - Please make sure you use node version 17+. diff --git a/apps/docs/docs/user/intro/update.md b/apps/docs/docs/user/intro/update.md new file mode 100644 index 00000000..3b80dafe --- /dev/null +++ b/apps/docs/docs/user/intro/update.md @@ -0,0 +1,52 @@ +--- +sidebar_position: 2 +title: Update Jayvee +--- + +# How to update Jayvee + +Jayvee is constently getting **updates** as a dedicated team of developers diligently addresses **performance issues** and incorporates **new features** to meet the evolving needs of its user base. + +### Update Jayvee the right way. + +To update Jayvee, you need to: + +1. Update the interpreter by reinstalling it using npm: + +```bash +npm install -g @jvalue/jayvee-interpreter +``` + +Note: Updating to a specific version works using the `@`-syntax, e.g., version `0.0.17`: + +```bash +npm install -g @jvalue/jayvee-interpreter@0.0.17 +``` + +2. Update your VSCode Extension: + +- Go [here](https://github.com/jvalue/jayvee/releases/latest) to find the latest(or a specific) version of the VSCode Extenstion. + +- Then, download the latest `jayvee.vsix` file. + +- Finally, open your Command Prompt(terminal), and paste the code below: + +```bash +code --install-extension jayvee.vsix +``` + +For manual installation, follow this [link](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix) for the official VSCode documentation. + +### Version Check. + +To verify wether the wanted version of Jayvee and VSCode extension where installed successfully, you can run in your Command Prompt(terminal): + +For **Jayvee**: + +```bash +jv -V +``` + +For the **VSCode extension**: + +In VSCode: Go to the extensions menu, and look for `Jayvee`. The version is then displayed on the information page of the extension. From 408c707ffaef859c90ec8f11412e504931d98168 Mon Sep 17 00:00:00 2001 From: OmarFourati Date: Tue, 26 Dec 2023 11:00:41 +0100 Subject: [PATCH 11/15] last typo update --- apps/docs/docs/user/intro/update.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/apps/docs/docs/user/intro/update.md b/apps/docs/docs/user/intro/update.md index 3b80dafe..679ed628 100644 --- a/apps/docs/docs/user/intro/update.md +++ b/apps/docs/docs/user/intro/update.md @@ -5,9 +5,9 @@ title: Update Jayvee # How to update Jayvee -Jayvee is constently getting **updates** as a dedicated team of developers diligently addresses **performance issues** and incorporates **new features** to meet the evolving needs of its user base. +Jayvee is constently getting updates as a dedicated team of developers diligently addresses performance issues and incorporates new features to meet the evolving needs of its user base. -### Update Jayvee the right way. +### Update Jayvee + Extension To update Jayvee, you need to: @@ -37,7 +37,7 @@ code --install-extension jayvee.vsix For manual installation, follow this [link](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix) for the official VSCode documentation. -### Version Check. +### Version Check To verify wether the wanted version of Jayvee and VSCode extension where installed successfully, you can run in your Command Prompt(terminal): From 027c0b85e2cff139fa4f6b912e515a5e0aa0323c Mon Sep 17 00:00:00 2001 From: OmarFourati Date: Wed, 27 Dec 2023 19:47:36 +0100 Subject: [PATCH 12/15] fix: review changes --- apps/docs/docs/user/intro/_category_.json | 2 +- apps/docs/docs/user/intro/intro.md | 10 +--------- apps/docs/docs/user/intro/update.md | 10 +++++----- 3 files changed, 7 insertions(+), 15 deletions(-) diff --git a/apps/docs/docs/user/intro/_category_.json b/apps/docs/docs/user/intro/_category_.json index 478d4d8f..9da536e2 100644 --- a/apps/docs/docs/user/intro/_category_.json +++ b/apps/docs/docs/user/intro/_category_.json @@ -3,6 +3,6 @@ "position": 1, "link": { "type": "generated-index", - "description": "All the essentials Information to get started with Javee." + "description": "All the essential information to get started with Jayvee." } } diff --git a/apps/docs/docs/user/intro/intro.md b/apps/docs/docs/user/intro/intro.md index 797e8d38..b4ba3597 100644 --- a/apps/docs/docs/user/intro/intro.md +++ b/apps/docs/docs/user/intro/intro.md @@ -25,15 +25,7 @@ npm install -g @jvalue/jayvee-interpreter@0.0.17 ## Update -Updating the interpreter is done by reinstalling it using `npm`. Make sure to also update the [VSCode plugin](#vscode-plugin) to match the installed interpreter if you use it. - -IMPORTANT: If a new Jayvee update is available, you need to update your VSCode extension for Jayvee as well. - -More details on updating can be found [here](./update.md). - -```bash -npm install -g @jvalue/jayvee-interpreter -``` +Details about how to update Jayvee and the VSCode extension can be found [here](./update.md). ## Usage diff --git a/apps/docs/docs/user/intro/update.md b/apps/docs/docs/user/intro/update.md index 679ed628..3dd746c9 100644 --- a/apps/docs/docs/user/intro/update.md +++ b/apps/docs/docs/user/intro/update.md @@ -5,7 +5,7 @@ title: Update Jayvee # How to update Jayvee -Jayvee is constently getting updates as a dedicated team of developers diligently addresses performance issues and incorporates new features to meet the evolving needs of its user base. +Jayvee is consistently getting updates. To ensure you use the most recent version, please regularly update the interpreter and VSCode extension. ### Update Jayvee + Extension @@ -29,17 +29,17 @@ npm install -g @jvalue/jayvee-interpreter@0.0.17 - Then, download the latest `jayvee.vsix` file. -- Finally, open your Command Prompt(terminal), and paste the code below: +- Finally, to install the extension using the CLI, paste the code below into your command line: ```bash code --install-extension jayvee.vsix ``` -For manual installation, follow this [link](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix) for the official VSCode documentation. +If you'd rather use the manual installation, follow this [link](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix) for the official VSCode documentation. ### Version Check -To verify wether the wanted version of Jayvee and VSCode extension where installed successfully, you can run in your Command Prompt(terminal): +To verify wether the wanted version of Jayvee and VSCode extension where installed successfully, you can run in your command line: For **Jayvee**: @@ -49,4 +49,4 @@ jv -V For the **VSCode extension**: -In VSCode: Go to the extensions menu, and look for `Jayvee`. The version is then displayed on the information page of the extension. +Go to the extensions menu, and look for `Jayvee`. The version is then displayed on the information page of the extension. From 82000d24e822ce964533ed40cb0aca530a401b02 Mon Sep 17 00:00:00 2001 From: OmarFourati Date: Mon, 22 Jan 2024 16:10:51 +0100 Subject: [PATCH 13/15] fix: create license files --- apps/docs/docs/user/intro/intro.md.license | 3 +++ apps/docs/docs/user/intro/update.md.license | 3 +++ 2 files changed, 6 insertions(+) create mode 100644 apps/docs/docs/user/intro/intro.md.license create mode 100644 apps/docs/docs/user/intro/update.md.license diff --git a/apps/docs/docs/user/intro/intro.md.license b/apps/docs/docs/user/intro/intro.md.license new file mode 100644 index 00000000..17c5d2ba --- /dev/null +++ b/apps/docs/docs/user/intro/intro.md.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg + +SPDX-License-Identifier: AGPL-3.0-only diff --git a/apps/docs/docs/user/intro/update.md.license b/apps/docs/docs/user/intro/update.md.license new file mode 100644 index 00000000..17c5d2ba --- /dev/null +++ b/apps/docs/docs/user/intro/update.md.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg + +SPDX-License-Identifier: AGPL-3.0-only From f27bbb39a16c5e91f5dd6f225ae82f79eae9add4 Mon Sep 17 00:00:00 2001 From: OmarFourati Date: Mon, 22 Jan 2024 16:53:37 +0100 Subject: [PATCH 14/15] fix: revert change with linking example and not github --- apps/docs/docs/user/intro/intro.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/docs/docs/user/intro/intro.md b/apps/docs/docs/user/intro/intro.md index b4ba3597..aa4f009b 100644 --- a/apps/docs/docs/user/intro/intro.md +++ b/apps/docs/docs/user/intro/intro.md @@ -80,7 +80,7 @@ jv -d --debug-granularity peek --debug-target MyExtractorBlock,MySinkBloc ## Examples -You can find multiple examples [here](https://github.com/jvalue/jayvee/tree/main/example). Copy them to your local file system and execute them with the `jv` command on your command line (see [usage](#usage)). +You can find multiple examples with inline explanations [here](./examples/README.mdx). You can copy them to your local file system and execute them with the `jv` command on your command line (see [usage](#usage)). ## VSCode Plugin From aa661980be1b9ab1450d3bfb02de24410cb0fbfb Mon Sep 17 00:00:00 2001 From: OmarFourati Date: Wed, 24 Jan 2024 16:02:48 +0100 Subject: [PATCH 15/15] fix: fix examples link --- apps/docs/docs/user/intro/intro.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/docs/docs/user/intro/intro.md b/apps/docs/docs/user/intro/intro.md index aa4f009b..c2b4bc05 100644 --- a/apps/docs/docs/user/intro/intro.md +++ b/apps/docs/docs/user/intro/intro.md @@ -80,7 +80,7 @@ jv -d --debug-granularity peek --debug-target MyExtractorBlock,MySinkBloc ## Examples -You can find multiple examples with inline explanations [here](./examples/README.mdx). You can copy them to your local file system and execute them with the `jv` command on your command line (see [usage](#usage)). +You can find multiple examples with inline explanations [here](../examples/README.mdx). You can copy them to your local file system and execute them with the `jv` command on your command line (see [usage](#usage)). ## VSCode Plugin