Rewrite with JuliaSyntax (#870)

* use JuliaSyntax for document + state * CSTParser is bad at this part * wip * same api * wip * first format working * rm DataStructures * options * good progress * works * ok * Disable for now * fixes * progress - unicode is being an issue * ok * ok * more tests pass * ok i think it's time to use julia syntax for more now all tests pass except some alignment ones and that's due to unicode length/ncodeunits stuff * k * precompile * hmmm * progress * wip * wip * wip * fmt * wio * lineage * lfg * wip * coming together * dwadaw * wow * parameters working better * more tests passing * almost got initial tests passing * wip * let passing * format * ok * more tests passing * fmt * fix * foo * format * more stuff working * wip * wip * almost there * fmt * hmmmm * looking good * almost * tests pass * save * add warning to skip file if it's a parse error * ok * ok * ok * progress * ok * another binary shortcircuit test * ok * blue * test * ok * passes * pass * fix * kwargs fix * wip * src * ok * ok * lazy op * more fixes * standalone binary * comment out * jfmt src * for * format * another test * kw * simplify * parameters * Cleanup * src done * another fix * fmt * a * fixes * fmt * fmt test files * works * rm line * fix * ok * ok * precompile * merged from master * ok * ok * ok * wip * updates docs * fmt * int/uint * methods * version check * version checks * fix * fmt * test * ok * format * ok * ok * fixes * using jet * jet * fmt * wip * nospecialize * ok * more stuff * ok * reduce precompilation time by a decent amount * remove kwargs * rename * ok * cleanup * ok * precompile * progress * allow hash eq comments to be placed whereever * fix * ok * try this * stuff * this too * more * ok * shouldn't go crazy with @nospecialize * get rid of precompietools for now * seems to be working * ok * seems good * hmm * jet * hmm * fmt * allocs * update * type stable * kwdef * ok * ok * -1 -> 0 * ok * style update * another format change * fix short-circuit to if pass ? * format works * ok * update * ok * docs update * simplify * fix * format * this seems to be it * keep semicolons in quote/begin blocks * some updates * format * improve runtime of strings and docstring formatting * remove @nospecialize * reduce compilation time * greater workload * rm old format.jl file * workload * minor edit * more precompilation stuff * format * fix test * 1.10 is the new LTS * tuple blocks * format
domluna · Oct 16, 2024 · 2242a32 · 2242a32 · domluna · Oct 16, 2024
1 parent 965ab02
commit 2242a32
Show file tree

Hide file tree

Showing 61 changed files with 7,650 additions and 5,877 deletions.
diff --git a/.JuliaFormatter.toml b/.JuliaFormatter.toml
@@ -1,3 +1,5 @@
 remove_extra_newlines = true
 always_for_in = true
 conditional_to_if = true
+separate_kwargs_with_semicolon = true
+short_to_long_function_def = true
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -15,11 +15,8 @@ jobs:
     strategy:
       matrix:
         version:
-          - '1.6'
-          - '1.7'
-          - '1.8'
-          - '1.9'
           - '1.10'
+          - '1.11'
           # - 'nightly'
         arch: [x64, x86]
         os: [ubuntu-latest, windows-latest, macos-13]

diff --git a/Project.toml b/Project.toml
@@ -1,26 +1,22 @@
 name = "JuliaFormatter"
 uuid = "98e50ef6-434e-11e9-1051-2b60c6c9e899"
 authors = ["Dominique Luna <[email protected]>"]
-version = "1.0.62"
+version = "2.0.0"
 
 [deps]
-CSTParser = "00ebfdb7-1f24-5e51-bd34-a7502290713f"
 CommonMark = "a80b9123-70ca-4bc0-993e-6e3bcb318db6"
-DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
 Glob = "c27321d9-0574-5035-807b-f59d2c89b15c"
+JuliaSyntax = "70703baa-626e-46a2-a12c-08ffd08c73b4"
 PrecompileTools = "aea7be01-6a6a-4083-8856-8a6e6704d82a"
 TOML = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
-Tokenize = "0796e94c-ce3b-5d07-9a54-7f471281c624"
 
 [compat]
-CSTParser = "^3.4.2"
 CommonMark = "0.5, 0.6, 0.7, 0.8"
-DataStructures = "0.17, 0.18"
 Glob = "1.3"
+JuliaSyntax = "^0.4.10"
 PrecompileTools = "1"
 TOML = "1"
-Tokenize = "^0.5.16"
-julia = "1.0"
+julia = "1.10"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

diff --git a/bin/format.jl b/bin/format.jl
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,8 +1,8 @@
 using Documenter, JuliaFormatter
 
-makedocs(
+makedocs(;
     sitename = "JuliaFormatter",
-    format = Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true"),
+    format = Documenter.HTML(; prettyurls = get(ENV, "CI", nothing) == "true"),
     modules = [JuliaFormatter],
     pages = [
         "Introduction" => "index.md",
@@ -11,7 +11,6 @@ makedocs(
         "Skipping Formatting" => "skipping_formatting.md",
         "Syntax Transforms" => "transforms.md",
         "Custom Alignment" => "custom_alignment.md",
-        "Custom Styles" => "custom_styles.md",
         "YAS Style" => "yas_style.md",
         "Blue Style" => "blue_style.md",
         "SciML Style" => "sciml_style.md",
@@ -21,4 +20,4 @@ makedocs(
     warnonly = true,
 )
 
-deploydocs(repo = "github.com/domluna/JuliaFormatter.jl.git", push_preview = true)
+deploydocs(; repo = "github.com/domluna/JuliaFormatter.jl.git", push_preview = true)
diff --git a/docs/src/config.md b/docs/src/config.md
@@ -25,21 +25,23 @@ margin = 100
 
 then files under `somedir` will be formatted with 2 spaces indentation and the maximum line length 100.
 
-!!! warning "Custom Style"
+## Non Default Style
 
-    Currently the configuration file doesn't support user-defined [Custom Styles](@ref).
-    For the time being, we only provide specs for [YAS Style](@ref), [Blue Style](@ref) and [SciML Style](@ref) in configuration file.
-    In order to use YAS style instead of the default style, you can just specify:
+If you would use another style, such as `YASStyle` you can write this in your configuration like so:
 
-    > .JuliaFormatter.toml
+```toml
+style = "yas"
+```
+
+Styles choices are:
+
+- "default" (default choice if nothing is specified)
+- "yas"
+- "blue"
+- "sciml"
+- "minimal"
 
-    ```toml
-    ...
-    style = "yas"
-    ...
-    ```
 
-    In the same way as above, you can specify `style = "blue"` to use Blue style.
 
 ## Search Rule
 

diff --git a/docs/src/custom_styles.md b/docs/src/custom_styles.md
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -527,18 +527,28 @@ end
 You can convert short circuit expressions to the equivalent if expression.
 
 ```julia
-b0 && foo()
-b1 || bar()
-```
+function foo(a, b)
+    a || return "bar"
 
-respectively become
+    "hello"
 
-```julia
-if b0
-    foo()
+    b && return "ooo"
 end
-if !b1
-    bar()
+
+BECOMES
+
+function foo(a, b)
+    if !(a)
+        return "bar"
+    end
+
+    "hello"
+
+    if b
+        return "ooo"
+    else
+        false
+    end
 end
 ```