summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorymap <ymap.dev@gmail.com>2023-09-13 23:53:24 +0900
committerGitHub <noreply@github.com>2023-09-13 15:53:24 +0100
commit9092af9ad6a5c93a759be571323ea1d0cafa8d6e (patch)
tree6c58290794d91819fb2d80d2da8752997627537b /doc
parentac615e7f656fb379cfe7cd205842b0f089a060d6 (diff)
downloadale-9092af9ad6a5c93a759be571323ea1d0cafa8d6e.zip
Add support for Packwerk (#4594)
Packwerk (https://github.com/Shopify/packwerk) is a Ruby gem used to enforce boundaries and modularize Rails applications.
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-ruby.txt20
-rw-r--r--doc/ale-supported-languages-and-tools.txt1
-rw-r--r--doc/ale.txt1
3 files changed, 22 insertions, 0 deletions
diff --git a/doc/ale-ruby.txt b/doc/ale-ruby.txt
index b0773fdd..ff9aa798 100644
--- a/doc/ale-ruby.txt
+++ b/doc/ale-ruby.txt
@@ -49,6 +49,26 @@ g:ale_ruby_debride_options *g:ale_ruby_debride_options*
===============================================================================
+packwerk *ale-ruby-packwerk*
+
+g:ale_ruby_packwerk_executable *g:ale_ruby_packwerk_executable*
+ *b:ale_ruby_packwerk_executable*
+ Type: |String|
+ Default: `'packwerk'`
+
+ Override the invoked packwerk binary. Set this to `'bundle'` to invoke
+ `'bundle` `exec` packwerk'.
+
+
+g:ale_ruby_packwerk_options *g:ale_ruby_packwerk_options*
+ *b:ale_ruby_packwerk_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be changed to modify flags given to packwerk.
+
+
+===============================================================================
prettier *ale-ruby-prettier*
See |ale-javascript-prettier| for information about the available options.
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index ff5a914f..b973b8b4 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -547,6 +547,7 @@ Notes:
* `brakeman`!!
* `cspell`
* `debride`
+ * `packwerk`!!
* `prettier`
* `rails_best_practices`!!
* `reek`
diff --git a/doc/ale.txt b/doc/ale.txt
index ded91aa3..423204a3 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -3324,6 +3324,7 @@ documented in additional help files.
brakeman..............................|ale-ruby-brakeman|
cspell................................|ale-ruby-cspell|
debride...............................|ale-ruby-debride|
+ packwerk..............................|ale-ruby-packwerk|
prettier..............................|ale-ruby-prettier|
rails_best_practices..................|ale-ruby-rails_best_practices|
reek..................................|ale-ruby-reek|