Apply JuliaFormatter with BlueStyle and add it to tests (#327)

* Set up JuliaFormatter

* Apply formatting with blue style

* Add blue style badge

* No JuliaFormatter on 1.0

Author: gdalle

.JuliaFormatter.toml

@@ -0,0 +1 @@
+style = "blue"

BenchmarkPlots/src/BenchmarkPlots.jl

@@ -7,7 +7,7 @@ using BenchmarkTools: Trial, BenchmarkGroup
     legend --> false
     yguide --> "t / ns"
     xticks --> false
-    t.times
+    return t.times
 end
 
 @recipe function f(g::BenchmarkGroup, keys=keys(g))

Project.toml

@@ -16,8 +16,9 @@ julia = "1"
 
 [extras]
 Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
+JuliaFormatter = "98e50ef6-434e-11e9-1051-2b60c6c9e899"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Aqua", "Statistics", "Test"]
+test = ["Aqua", "JuliaFormatter", "Statistics", "Test"]

README.md

@@ -9,6 +9,7 @@
 [![][docs-dev-img]][docs-dev-url]
 [![Build Status](https://github.com/JuliaCI/BenchmarkTools.jl/workflows/CI/badge.svg)](https://github.com/JuliaCI/BenchmarkTools.jl/actions/workflows/CI.yml?query=branch%3Amaster)
 [![Code Coverage](https://codecov.io/gh/JuliaCI/BenchmarkTools.jl/branch/master/graph/badge.svg?label=codecov&token=ccN7NZpkBx)](https://codecov.io/gh/JuliaCI/BenchmarkTools.jl)
+[![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
 [![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
 
 BenchmarkTools makes **performance tracking of Julia code easy** by supplying a framework for **writing and running groups of benchmarks** as well as **comparing benchmark results**.

benchmark/benchmarks.jl

@@ -13,8 +13,8 @@ suite["dot"] = BenchmarkGroup(["broadcast", "elementwise"])
 teststr = join(rand(MersenneTwister(1), 'a':'d', 10^4))
 
 # Add some benchmarks to the "string" group
-suite["string"]["replace"] = @benchmarkable replace($teststr, "a", "b") seconds=Float64(π)
-suite["string"]["join"] = @benchmarkable join($teststr, $teststr) samples=42
+suite["string"]["replace"] = @benchmarkable replace($teststr, "a", "b") seconds = Float64(π)
+suite["string"]["join"] = @benchmarkable join($teststr, $teststr) samples = 42
 
 # Add some benchmarks to the "trig"/"dot" group
 for f in (sin, cos, tan)
@@ -30,8 +30,8 @@ end
 paramspath = joinpath(dirname(@__FILE__), "params.json")
 
 if isfile(paramspath)
-    loadparams!(suite, BenchmarkTools.load(paramspath)[1], :evals);
+    loadparams!(suite, BenchmarkTools.load(paramspath)[1], :evals)
 else
     tune!(suite)
-    BenchmarkTools.save(paramspath, params(suite));
+    BenchmarkTools.save(paramspath, params(suite))
 end

docs/generate_logo.jl

@@ -8,7 +8,7 @@ JULIA_COLORS = [Luxor.julia_blue, Luxor.julia_green, Luxor.julia_red, Luxor.juli
 function draw_logo(; path, dark=false)
     Drawing(500, 500, path)
     origin()
-    squircle(O, 250, 250, :clip, rt=0.3)
+    squircle(O, 250, 250, :clip; rt=0.3)
     sethue(dark ? "black" : "white")
     paint()
 
@@ -20,11 +20,14 @@ function draw_logo(; path, dark=false)
 
         for n in 1:4
             setblend(blend(O - (240, 0), O + (240, 0), "white", JULIA_COLORS[n]))
-            sector(O,
+            sector(
+                O,
                 rescale(n, 1, 3, rmin, rmax),
                 rescale(n, 1, 3, rmin, rmax) + band,
-                3π / 2 - deg2rad(45), 3π / 2 + deg2rad(45),
-                :fill)
+                3π / 2 - deg2rad(45),
+                3π / 2 + deg2rad(45),
+                :fill,
+            )
         end
 
         sethue(dark ? "black" : "white")
@@ -37,8 +40,8 @@ function draw_logo(; path, dark=false)
     end
 
     finish()
-    preview()
+    return preview()
 end
 
-draw_logo(path=joinpath(@__DIR__, "src", "assets", "logo.svg"), dark=false)
-draw_logo(path=joinpath(@__DIR__, "src", "assets", "logo-dark.svg"), dark=true)
+draw_logo(; path=joinpath(@__DIR__, "src", "assets", "logo.svg"), dark=false)
+draw_logo(; path=joinpath(@__DIR__, "src", "assets", "logo-dark.svg"), dark=true)

docs/make.jl

@@ -21,6 +21,4 @@ makedocs(;
     ],
 )
 
-deploydocs(;
-    repo="github.com/JuliaCI/BenchmarkTools.jl",
-)
+deploydocs(; repo="github.com/JuliaCI/BenchmarkTools.jl")

src/BenchmarkTools.jl

@@ -9,7 +9,6 @@ using UUIDs: uuid4
 using Printf
 using Profile
 
-
 const BENCHMARKTOOLS_VERSION = v"1.0.0"
 
 ##############
@@ -27,19 +26,19 @@ export loadparams!
 include("trials.jl")
 
 export gctime,
-       memory,
-       allocs,
-       params,
-       ratio,
-       judge,
-       isinvariant,
-       isregression,
-       isimprovement,
-       median,
-       mean,
-       rmskew!,
-       rmskew,
-       trim
+    memory,
+    allocs,
+    params,
+    ratio,
+    judge,
+    isinvariant,
+    isregression,
+    isimprovement,
+    median,
+    mean,
+    rmskew!,
+    rmskew,
+    trim
 
 ##################
 # Benchmark Data #
@@ -48,30 +47,23 @@ export gctime,
 include("groups.jl")
 
 export BenchmarkGroup,
-       invariants,
-       regressions,
-       improvements,
-       @tagged,
-       addgroup!,
-       leaves,
-       @benchmarkset,
-       @case,
-       clear_empty!
+    invariants,
+    regressions,
+    improvements,
+    @tagged,
+    addgroup!,
+    leaves,
+    @benchmarkset,
+    @case,
+    clear_empty!
 
 ######################
 # Execution Strategy #
 ######################
 
 include("execution.jl")
 
-export tune!,
-       warmup,
-       @ballocated,
-       @benchmark,
-       @benchmarkable,
-       @belapsed,
-       @btime,
-       @bprofile
+export tune!, warmup, @ballocated, @benchmark, @benchmarkable, @belapsed, @btime, @bprofile
 
 #################
 # Serialization #