run Runic on codebase and do some basic maintaince (#200)

Author: KristofferC

.github/workflows/Checks.yml

@@ -0,0 +1,30 @@
+name: Code checks
+
+on:
+  pull_request:
+  push:
+    branches: ["master"]
+
+jobs:
+
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # v3.0.1
+        env:
+          # Skip runic-pre-commit since we use runic-action below instead
+          SKIP: runic
+
+  runic:
+    name: "Runic"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: '1.11'
+      - uses: julia-actions/cache@v2
+      - uses: fredrikekre/runic-action@v1
+        with:
+          version: "1.4" # Keep version in sync with .pre-commit-config.yaml

.github/workflows/CompatHelper.yml

@@ -23,4 +23,4 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
-          # COMPATHELPER_PRIV: ${{ secrets.COMPATHELPER_PRIV }}
+          # COMPATHELPER_PRIV: ${{ secrets.COMPATHELPER_PRIV }}

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+repos:
+  - repo: 'https://github.com/pre-commit/pre-commit-hooks'
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      # - id: check-toml # we have tomls with invalid syntax for tests
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+  - repo: 'https://github.com/fredrikekre/runic-pre-commit'
+    rev: v2.0.1
+    hooks:
+      - id: runic
+        additional_dependencies:
+          - '[email protected]' # Keep version in sync with .github/workflows/Check.yml

README.md

@@ -1,6 +1,6 @@
 # TimerOutputs
 
-[![Build Status](https://travis-ci.com/KristofferC/TimerOutputs.jl.svg?branch=master)](https://travis-ci.com/KristofferC/TimerOutputs.jl) [![codecov](https://codecov.io/gh/KristofferC/TimerOutputs.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/KristofferC/TimerOutputs.jl)
+[![Build Status](https://github.com/KristofferC/TimerOutputs.jl/workflows/CI/badge.svg)](https://github.com/KristofferC/TimerOutputs.jl/actions) [![codecov](https://codecov.io/gh/KristofferC/TimerOutputs.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/KristofferC/TimerOutputs.jl)
 
 `TimerOutputs` is a small Julia package that is used to generate formatted output from timings made in different sections of a program.
 It's main functionality is the `@timeit` macro, similar to the `@time` macro in Base except one also assigns a label to the code section being timed.

ext/FlameGraphsExt/FlameGraphsExt.jl

@@ -16,7 +16,7 @@ Use `crop_root = true` to crop the root node to the first and last child nodes.
 function FlameGraphs.flamegraph(to::TimerOutput; crop_root = false)
     # Skip the very top-level node, which contains no useful data
     very_start = crop_root ? min_start_time(to) : to.start_data.time
-    node_data = _flamegraph_frame(to, very_start; toplevel=true, crop_root)
+    node_data = _flamegraph_frame(to, very_start; toplevel = true, crop_root)
     root = Node(node_data)
     return _to_flamegraph(to, root, very_start)
 end
@@ -47,7 +47,7 @@ function _flamegraph_frame(to::TimerOutput, start_ns; toplevel = false, crop_roo
     tt = Symbol(tt_str)
     # Set the pointer to ensure the sf is unique
     sf = StackFrame(tt, Symbol("none"), 0, nothing, false, false, Base.objectid(to))
-    status = 0x0  # "default" status -- See FlameGraphs.jl
+    status = 0x00  # "default" status -- See FlameGraphs.jl
     # TODO: is this supposed to be inclusive or exclusive?
     if toplevel
         # The root frame covers the total time being measured, so start when the first node
@@ -59,7 +59,7 @@ function _flamegraph_frame(to::TimerOutput, start_ns; toplevel = false, crop_roo
         _start = to.start_data.time
         _end = to.start_data.time + to.accumulated_data.time
     end
-    range = (Int(_start) : Int(_end)) .- start_ns
+    range = (Int(_start):Int(_end)) .- start_ns
     return FlameGraphs.NodeData(sf, status, range)
 end