summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMD <0xhyoga@cygnusdao.finance>2023-12-08 19:13:37 -0300
committerGitHub <noreply@github.com>2023-12-08 22:13:37 +0000
commit71718722b2a5626b91422a8560bfc90c1d3903a4 (patch)
tree4eddaf885e4bd93b38cf03e8e93591914b416956 /doc
parent32ee7039d0ee7afcc134756cfac78678cffc7017 (diff)
downloadale-71718722b2a5626b91422a8560bfc90c1d3903a4.zip
Add support for Scarb in `cairo` files (#4669)
* Add support for Scarb in `cairo` files * specify if linter should run on saved
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-cairo.txt15
-rw-r--r--doc/ale-supported-languages-and-tools.txt1
-rw-r--r--doc/ale.txt1
3 files changed, 17 insertions, 0 deletions
diff --git a/doc/ale-cairo.txt b/doc/ale-cairo.txt
index 0a78e68a..070b76e5 100644
--- a/doc/ale-cairo.txt
+++ b/doc/ale-cairo.txt
@@ -3,6 +3,19 @@ ALE Cairo Integration *ale-cairo-options*
===============================================================================
+scarb *ale-cairo-scarb*
+
+g:ale_cairo_scarb_executable *g:ale_cairo_scarb_executable*
+ *b:ale_cairo_scarb_executable*
+
+ Default: `'scarb build'`
+
+ For Cairo1 projects using Scarb
+
+ For more information read 'https://docs.swmansion.com/scarb/'
+
+
+===============================================================================
starknet *ale-cairo-starknet*
g:ale_cairo_starknet_executable *g:ale_cairo_starknet_executable*
@@ -13,3 +26,5 @@ g:ale_cairo_starknet_executable *g:ale_cairo_starknet_executable*
Overrides the starknet-compile binary after installing the cairo-language.
For more information read 'https://starknet.io/docs/quickstart.html'
+
+===============================================================================
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index acfdb8d4..aa49a1b1 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -102,6 +102,7 @@ Notes:
* `gcc` (`cc`)
* `uncrustify`
* Cairo
+ * `scarb`!!
* `starknet`
* Chef
* `cookstyle`
diff --git a/doc/ale.txt b/doc/ale.txt
index b577324e..5f7999b8 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -2928,6 +2928,7 @@ documented in additional help files.
flawfinder............................|ale-c-flawfinder|
uncrustify............................|ale-c-uncrustify|
cairo...................................|ale-cairo-options|
+ scarb.................................|ale-cairo-scarb|
starknet..............................|ale-cairo-starknet|
chef....................................|ale-chef-options|
cookstyle.............................|ale-chef-cookstyle|