Merge pull request #88 from SciML/dw/scimlstyle

Use JuliaFormatter with SciML style

Author: ChrisRackauckas

.JuliaFormatter.toml

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

.github/workflows/FormatCheck.yml

@@ -0,0 +1,41 @@
+name: format-check
+
+on:
+  push:
+    branches:
+      - 'master'
+      - 'release-'
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: 1
+      - name: Install JuliaFormatter
+        run: |
+          using Pkg
+          name = "JuliaFormatter"
+          uuid = "98e50ef6-434e-11e9-1051-2b60c6c9e899"
+          Pkg.add(; name, uuid)
+        shell: julia --color=yes {0}
+      - name: Format Julia code
+        run: |
+          using JuliaFormatter
+          format("."; verbose = true)
+        shell: julia --color=yes {0}
+      - name: Format check
+        run: |
+          out = Cmd(`git diff --name-only`) |> read |> String
+          if out == ""
+              exit(0)
+          else
+              @error "Some files have not been formatted !!!"
+              write(stdout, out)
+              exit(1)
+          end
+        shell: julia --color=yes {0}

README.md

@@ -1,10 +1,10 @@
 # DiffEqProblemLibrary.jl
 
-[![Join the chat at https://gitter.im/JuliaDiffEq/Lobby](https://badges.gitter.im/JuliaDiffEq/Lobby.svg)](https://gitter.im/JuliaDiffEq/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Build Status](https://github.com/SciML/DiffEqProblemLibrary.jl/workflows/CI/badge.svg)](https://github.com/SciML/DiffEqProblemLibrary.jl/actions?query=workflow%3ACI)
+[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
 
-DiffEqProblemLibrary.jl is a component package in the DifferentialEquations ecosystem. It premade
+DiffEqProblemLibrary.jl is a component package in the DifferentialEquations ecosystem. It contains premade
 problems for the differential equations solvers. These can either be used as tests
 or as examples to show how to use the the solvers. Check out the problems in the
 src directory. Users interested in using this
-functionality should check out [DifferentialEquations.jl](https://github.com/JuliaDiffEq/DifferentialEquations.jl).
+functionality should check out [DifferentialEquations.jl](https://github.com/SciML/DifferentialEquations.jl).

src/DiffEqProblemLibrary.jl

@@ -3,41 +3,41 @@ module DiffEqProblemLibrary
 module ODEProblemLibrary
 using Latexify
 function importodeproblems()
-  @isdefined(prob_ode_linear) ||
-  include(joinpath(@__DIR__, "ode/ode_premade_problems.jl"));
-  nothing
+    @isdefined(prob_ode_linear) ||
+        include(joinpath(@__DIR__, "ode/ode_premade_problems.jl"))
+    nothing
 end
 end # module
 
 module DAEProblemLibrary
 function importdaeproblems()
-  @isdefined(prob_dae_resrob) ||
-  include(joinpath(@__DIR__, "dae_premade_problems.jl"));
-  nothing
+    @isdefined(prob_dae_resrob) ||
+        include(joinpath(@__DIR__, "dae_premade_problems.jl"))
+    nothing
 end
 end # module
 
 module DDEProblemLibrary
 function importddeproblems()
-  @isdefined(prob_dde_1delay) ||
-  include(joinpath(@__DIR__, "dde/dde_premade_problems.jl"));
-  nothing
+    @isdefined(prob_dde_1delay) ||
+        include(joinpath(@__DIR__, "dde/dde_premade_problems.jl"))
+    nothing
 end
 end # module
 
 module SDEProblemLibrary
 function importsdeproblems()
-  @isdefined(prob_sde_wave) ||
-  include(joinpath(@__DIR__, "sde_premade_problems.jl"));
-  nothing
+    @isdefined(prob_sde_wave) ||
+        include(joinpath(@__DIR__, "sde_premade_problems.jl"))
+    nothing
 end
 end # module
 
 module JumpProblemLibrary
 function importjumpproblems()
-  @isdefined(prob_jump_dnarepressor) ||
-  include(joinpath(@__DIR__, "jump_premade_problems.jl"));
-  nothing
+    @isdefined(prob_jump_dnarepressor) ||
+        include(joinpath(@__DIR__, "jump_premade_problems.jl"))
+    nothing
 end
 end # module
 

src/dae_premade_problems.jl

@@ -6,10 +6,10 @@ export prob_dae_resrob
 ### DAE Problems
 
 f = function (r, yp, y, p, tres)
-    r[1]  = -0.04*y[1] + 1.0e4*y[2]*y[3]
-    r[2]  = -r[1] - 3.0e7*y[2]*y[2] - yp[2]
-    r[1] -=  yp[1]
-    r[3]  =  y[1] + y[2] + y[3] - 1.0
+    r[1] = -0.04 * y[1] + 1.0e4 * y[2] * y[3]
+    r[2] = -r[1] - 3.0e7 * y[2] * y[2] - yp[2]
+    r[1] -= yp[1]
+    r[3] = y[1] + y[2] + y[3] - 1.0
 end
 u0 = [1.0, 0, 0]
 du0 = [-0.04, 0.04, 0.0]
@@ -30,4 +30,4 @@ where ``k₁=0.04``, ``k₂=3\times10^7``, ``k₃=10^4``. For details, see:
 Hairer Norsett Wanner Solving Ordinary Differential Equations I - Nonstiff Problems Page 129
 Usually solved on ``[0,1e11]``
 """
-prob_dae_resrob = DAEProblem(f,du0,u0,(0.0,100000.0))
+prob_dae_resrob = DAEProblem(f, du0, u0, (0.0, 100000.0))