Merge pull request #57 from SciML/format

format SciML Style

Author: ChrisRackauckas

.JuliaFormatter.toml

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

.github/workflows/FormatCheck.yml

@@ -0,0 +1,42 @@
+name: format-check
+
+on:
+  push:
+    branches:
+      - 'master'
+      - 'release-'
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        julia-version: [1]
+        julia-arch: [x86]
+        os: [ubuntu-latest]
+    steps:
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: ${{ matrix.julia-version }}
+
+      - uses: actions/checkout@v1
+      - name: Install JuliaFormatter and format
+        # This will use the latest version by default but you can set the version like so:
+        #
+        # julia  -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter", version="0.13.0"))'
+        run: |
+          julia  -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter"))'
+          julia  -e 'using JuliaFormatter; format(".", verbose=true)'
+      - name: Format check
+        run: |
+          julia -e '
+          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'

docs/make.jl

@@ -2,18 +2,14 @@ using Documenter, MultiScaleArrays
 
 include("pages.jl")
 
-makedocs(
-    sitename="MultiScaleArrays.jl",
-    authors="Chris Rackauckas",
-    modules=[MultiScaleArrays],
-    clean=true,doctest=false,
-    format = Documenter.HTML(analytics = "UA-90474609-3",
-                             assets = ["assets/favicon.ico"],
-                             canonical="https://multiscalearrays.sciml.ai/stable/"),
-    pages=pages
-)
+makedocs(sitename = "MultiScaleArrays.jl",
+         authors = "Chris Rackauckas",
+         modules = [MultiScaleArrays],
+         clean = true, doctest = false,
+         format = Documenter.HTML(analytics = "UA-90474609-3",
+                                  assets = ["assets/favicon.ico"],
+                                  canonical = "https://multiscalearrays.sciml.ai/stable/"),
+         pages = pages)
 
-deploydocs(
-   repo = "github.com/SciML/MultiScaleArrays.jl.git";
-   push_preview = true
-)
+deploydocs(repo = "github.com/SciML/MultiScaleArrays.jl.git";
+           push_preview = true)

docs/pages.jl

@@ -1,6 +1,6 @@
 # Put in a separate page so it can be used by SciMLDocs.jl
 
-pages=[
+pages = [
     "Home" => "index.md",
-    "multiscalearray.md"
-]
+    "multiscalearray.md",
+]

src/MultiScaleArrays.jl

@@ -3,10 +3,10 @@ __precompile__()
 module MultiScaleArrays
 
 import Base: length, push!, deleteat!, getindex, setindex!, eachindex, ndims,
-       size, print_matrix, similar, hcat, vcat,
-       ==, *, +, /, -, show, vec, reshape
+             size, print_matrix, similar, hcat, vcat,
+             ==, *, +, /, -, show, vec, reshape
 
-import RecursiveArrayTools: recursivecopy,recursivecopy!
+import RecursiveArrayTools: recursivecopy, recursivecopy!
 
 import RecursiveArrayTools: chain
 
@@ -161,7 +161,7 @@ scenario = construct(Scenario, (deepcopy(community),))
 
 (of course at the cost of mutability).
 """
-abstract type AbstractMultiScaleArray{B}     <: AbstractVector{B} end
+abstract type AbstractMultiScaleArray{B} <: AbstractVector{B} end
 abstract type AbstractMultiScaleArrayLeaf{B} <: AbstractMultiScaleArray{B} end
 abstract type AbstractMultiScaleArrayHead{B} <: AbstractMultiScaleArray{B} end
 
@@ -183,8 +183,6 @@ using TreeViews
 TreeViews.hastreeview(x::AbstractMultiScaleArray) = true
 Base.show(io::IO, ::MIME"application/prs.juno.inline", x::AbstractMultiScaleArray) = x
 
-
-
 # Types
 export AbstractMultiScaleArray, AbstractMultiScaleArrayLeaf,
        AbstractMultiScaleArrayHead

src/addition_deletion.jl

@@ -5,7 +5,7 @@ function __add_node!(m::AbstractMultiScaleArray, node::AbstractMultiScaleArray)
 end
 
 function __update_lengths(m::AbstractMultiScaleArray, beg, len)
-    for j = beg:num_nodes(m)
+    for j in beg:num_nodes(m)
         m.end_idxs[j] += len
     end
     isempty(m.values) || (m.end_idxs[end] += len)
@@ -17,25 +17,30 @@ function __add_node!(m::AbstractMultiScaleArray, node::AbstractMultiScaleArray,
     __update_lengths(m, i, length(node))
 end
 
-function __add_node!(m::AbstractMultiScaleArray, node::AbstractMultiScaleArray, i, I::Int...)
+function __add_node!(m::AbstractMultiScaleArray, node::AbstractMultiScaleArray, i,
+                     I::Int...)
     __add_node!(m.nodes[i], node, I...)
     __update_lengths(m, i, length(node))
 end
 
-add_node!(m::AbstractMultiScaleArrayHead, node::AbstractMultiScaleArray) =
+function add_node!(m::AbstractMultiScaleArrayHead, node::AbstractMultiScaleArray)
     __add_node!(m, node)
+end
 
-add_node!(m::AbstractMultiScaleArrayHead, node::AbstractMultiScaleArray, i::Int) =
+function add_node!(m::AbstractMultiScaleArrayHead, node::AbstractMultiScaleArray, i::Int)
     __add_node!(m, node, i)
+end
 
-add_node!(m::AbstractMultiScaleArrayHead, node::AbstractMultiScaleArray, i, I::Int...) =
+function add_node!(m::AbstractMultiScaleArrayHead, node::AbstractMultiScaleArray, i,
+                   I::Int...)
     __add_node!(m, node, i, I...)
+end
 
 function __remove_node!(m::AbstractMultiScaleArray, i::Int)
     del_length = length(m.nodes[i])
     deleteat!(m.nodes, i)
     deleteat!(m.end_idxs, i)
-    for j = i:num_nodes(m)
+    for j in i:num_nodes(m)
         m.end_idxs[j] -= del_length
     end
     isempty(m.values) || (m.end_idxs[end] -= del_length)
@@ -49,11 +54,11 @@ end
 
 function remove_node!(m::AbstractMultiScaleArrayHead, i, I::Int...)
     del_length = __remove_node!(m.nodes[i], I...)
-    for j = i:num_nodes(m)
+    for j in i:num_nodes(m)
         m.end_idxs[j] -= del_length
     end
     isempty(m.values) || (m.end_idxs[end] -= del_length)
-    if size(m.nodes[i].nodes) == (0, )
+    if size(m.nodes[i].nodes) == (0,)
         deleteat!(m.nodes, i)
         deleteat!(m.end_idxs, i)
     end
@@ -62,13 +67,12 @@ end
 
 function __remove_node!(m::AbstractMultiScaleArray, i, I::Int...)
     del_length = __remove_node!(m.nodes[i], I...)
-    for j = i:num_nodes(m)
+    for j in i:num_nodes(m)
         m.end_idxs[j] -= del_length
     end
     isempty(m.values) || (m.end_idxs[end] -= del_length)
     isempty(m.nodes[i]) && deleteat!(m.nodes, i)
     del_length
 end
 
-remove_node!(m::AbstractMultiScaleArrayHead, i::Int) =
-    (__remove_node!(m, i); nothing)
+remove_node!(m::AbstractMultiScaleArrayHead, i::Int) = (__remove_node!(m, i); nothing)