Merge pull request #86 from SciML/format

format with SciML Style

Author: YingboMa

.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

@@ -9,31 +9,25 @@ using ModelingToolkitStandardLibrary.Thermal
 
 include("pages.jl")
 
-makedocs(
-    sitename="ModelingToolkitStandardLibrary.jl",
-    authors="Julia Computing",
-    clean=true,
-    doctest=false,
-    strict=[
-        :doctest,
-        :example_block,
-    ],
-    modules=[ModelingToolkitStandardLibrary,
+makedocs(sitename = "ModelingToolkitStandardLibrary.jl",
+         authors = "Julia Computing",
+         clean = true,
+         doctest = false,
+         strict = [
+             :doctest,
+             :example_block,
+         ],
+         modules = [ModelingToolkitStandardLibrary,
              ModelingToolkitStandardLibrary.Blocks,
              ModelingToolkitStandardLibrary.Mechanical,
              ModelingToolkitStandardLibrary.Mechanical.Rotational,
              ModelingToolkitStandardLibrary.Magnetic,
              ModelingToolkitStandardLibrary.Magnetic.FluxTubes,
              ModelingToolkitStandardLibrary.Electrical,
              ModelingToolkitStandardLibrary.Thermal],
+         format = Documenter.HTML(assets = ["assets/favicon.ico"],
+                                  canonical = "https://mtkstdlib.sciml.ai/stable/"),
+         pages = pages)
 
-    format=Documenter.HTML(assets=["assets/favicon.ico"],
-                           canonical="https://mtkstdlib.sciml.ai/stable/"),
-
-    pages=pages
-)
-
-deploydocs(
-    repo="github.com/SciML/ModelingToolkitStandardLibrary.jl";
-    push_preview=true
-)
+deploydocs(repo = "github.com/SciML/ModelingToolkitStandardLibrary.jl";
+           push_preview = true)

docs/pages.jl

@@ -1,17 +1,15 @@
 pages = [
-        "ModelingToolkitStandardLibrary.jl: A Standard Library for ModelingToolkit" => "index.md",
-
-        "Tutorials" => [
-            "RC Circuit" => "tutorials/rc_circuit.md",
-            "Custom Components" => "tutorials/custom_component.md",
-            "Thermal Conduction Model" => "tutorials/thermal_model.md",
-        ],
-
-        "API" => [
-            "Basic Blocks" => "API/blocks.md",
-            "Electrical Components" => "API/electrical.md",
-            "Magnetic Components" => "API/magnetic.md",
-            "Mechanical Components" => "API/mechanical.md",
-            "Thermal Components" => "API/thermal.md"
-        ],
-    ]
+    "ModelingToolkitStandardLibrary.jl: A Standard Library for ModelingToolkit" => "index.md",
+    "Tutorials" => [
+        "RC Circuit" => "tutorials/rc_circuit.md",
+        "Custom Components" => "tutorials/custom_component.md",
+        "Thermal Conduction Model" => "tutorials/thermal_model.md",
+    ],
+    "API" => [
+        "Basic Blocks" => "API/blocks.md",
+        "Electrical Components" => "API/electrical.md",
+        "Magnetic Components" => "API/magnetic.md",
+        "Mechanical Components" => "API/mechanical.md",
+        "Thermal Components" => "API/thermal.md",
+    ],
+]

src/Blocks/Blocks.jl

@@ -26,4 +26,4 @@ export Integrator, Derivative, FirstOrder, SecondOrder, StateSpace
 export PI, LimPI, PID, LimPID
 include("continuous.jl")
 
-end
+end