Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the Visual Studio Code Extension #710

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[![flowR logo](https://raw.githubusercontent.com/wiki/Code-Inspect/flowr/img/flowR.png)](https://github.com/Code-Inspect/flowr/wiki)\
[![QA (and potentially deploy)](https://github.com/Code-Inspect/flowr/actions/workflows/qa.yaml/badge.svg)](https://github.com/Code-Inspect/flowr/actions/workflows/qa.yaml) [![codecov](https://codecov.io/gh/Code-Inspect/flowr/graph/badge.svg)](https://codecov.io/gh/Code-Inspect/flowr) [![Docker Image Version (latest semver)](https://img.shields.io/docker/v/eagleoutice/flowr?logo=docker&logoColor=white&label=dockerhub)](https://hub.docker.com/r/eagleoutice/flowr) [![latest tag](https://badgen.net/github/tag/Code-Inspect/flowr?label=latest&color=purple)](https://github.com/Code-Inspect/flowr/releases/latest)
[![QA (and potentially deploy)](https://github.com/Code-Inspect/flowr/actions/workflows/qa.yaml/badge.svg)](https://github.com/Code-Inspect/flowr/actions/workflows/qa.yaml) [![codecov](https://codecov.io/gh/Code-Inspect/flowr/graph/badge.svg)](https://codecov.io/gh/Code-Inspect/flowr) [![Docker Image Version (latest semver)](https://img.shields.io/docker/v/eagleoutice/flowr?logo=docker&logoColor=white&label=dockerhub)](https://hub.docker.com/r/eagleoutice/flowr) [![latest tag](https://badgen.net/github/tag/Code-Inspect/flowr?label=latest&color=purple)](https://github.com/Code-Inspect/flowr/releases/latest) [![Marketplace](https://badgen.net/vs-marketplace/v/code-inspect.vscode-flowr)](https://marketplace.visualstudio.com/items?itemName=code-inspect.vscode-flowr)


*flowR* is a static [dataflow analyzer](https://en.wikipedia.org/wiki/Data-flow_analysis) and [program slicer](https://github.com/Code-Inspect/flowr/wiki/Terminology#program-slice) for the [*R*](https://www.r-project.org/) programming language (currently tested for versions `4.x`).
*flowR* is a static [dataflow analyzer](https://en.wikipedia.org/wiki/Data-flow_analysis) and [program slicer](https://github.com/Code-Inspect/flowr/wiki/Terminology#program-slice) for the [*R*](https://www.r-project.org/) programming language (currently tested for versions `4.x`). It is available as a [Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=code-inspect.vscode-flowr) and as a [docker image](https://hub.docker.com/r/eagleoutice/flowr).

## ⭐ Getting Started

To get started with _flowR_, please check out the [Overview](https://github.com/Code-Inspect/flowr/wiki/Overview). The [Setup](https://github.com/Code-Inspect/flowr/wiki/Setup) wiki page explains how you can download and setup _flowR_ on your system. With docker 🐳️, the following line should be enough (and drop you directly into the REPL):
To get started with _flowR_, please check out the [Overview](https://github.com/Code-Inspect/flowr/wiki/Overview). The [Setup](https://github.com/Code-Inspect/flowr/wiki/Setup) wiki page explains how you can download and setup _flowR_ on your system. For Visual Studio Code, please see the [marketplace entry](https://marketplace.visualstudio.com/items?itemName=code-inspect.vscode-flowr). With docker 🐳️, the following line should be enough (and drop you directly into the REPL):

```shell
docker run -it --rm eagleoutice/flowr
Expand Down
8 changes: 5 additions & 3 deletions wiki/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ This page focuses on the features presented by *flowR* and how to use them.
If you have never used *flowR* before, please refer to the [setup](https://github.com/Code-Inspect/flowr/wiki/Setup) wiki page first, for instructions on how to install *flowR*.

<!-- TOC -->
- [FlowR's Modules](#flowrs-modules)
- [*flowR*'s Modules](#flowrs-modules)
- [Using *flowR*](#using-flowr)
- [The Read-Eval-Print Loop (REPL)](#the-read-eval-print-loop-repl)
- [The Server](#the-server)
Expand All @@ -14,7 +14,7 @@ If you have never used *flowR* before, please refer to the [setup](https://githu
- [Export RDF N-Quads](#export-rdf-n-quads)
<!-- TOC -->

## FlowR's Modules
## *flowR*'s Modules

```mermaid
flowchart TD
Expand Down Expand Up @@ -64,11 +64,13 @@ The following sections explain how to use these features.

## Using *flowR*

*flowR* has two main ways to operate:
*flowR* itself has two main ways to operate:

- as a server which processes analysis and slicing requests (`--server` option)
- as a read-eval-print loop (REPL) that can be accessed directly from the command line (default option)

Besides these there is a [Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=code-inspect.vscode-flowr) that allows you to use *flowR* directly from within the editor.

🐳️ If you use the docker-version, simply starting the docker container in interactive mode drops you right into the REPL (`docker run -it --rm eagleoutice/flowr:latest`), while launching with the `--server` argument starts the server (`docker run -it --rm eagleoutice/flowr:latest --server`).\
⚒️ If you compile the *flowR* sources yourself, you can access *flowR* by first building the sources (`npm run build`) and executing then the root script (`node dist/src/flowr.js`).

Expand Down
9 changes: 7 additions & 2 deletions wiki/Setup.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
There are two main ways to use *flowR*.
You can download and build it from source, or download the accompanying docker image.
There are several ways to use *flowR*.
You can download and build it from source, download the accompanying docker image, or use its Visual Studio Code extension.

<!-- TOC -->
- [🗒️ Using the Visual Studio Code Extension](#️-using-the-visual-studio-code-extension)
- [🐳️ Using the Docker Image](#️-using-the-docker-image)
- [⚒️ Building From Scratch](#️-building-from-scratch)
- [📜 Developing for *flowR*](#-developing-for-flowr)
<!-- TOC -->

## 🗒️ Using the Visual Studio Code Extension

The easiest way to use *flowR* is to install the [Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=code-inspect.vscode-flowr). Please check out the marketplace entry for more information.

## 🐳️ Using the Docker Image

You can get the image from [docker hub](https://hub.docker.com/r/eagleoutice/flowr) by running:
Expand Down
Loading