refactor: change minimum required Nim version to 1.6.0 (#29)

michaelsbradleyjr · web-flow · commit b44822e5d0cb · 2023-07-07T18:48:45.000-05:00
* chore: import notcurses/abi/coverage in extras/lsp

* build: detect platform and download matching codecov uploader binary

* chore: in extras scripts do not echo unnecessarily for release build

* build: use lcov option `--ignore-errors unused` together with `--extract` in coverage script

* ci: revise usage of choosenim in Builds workflow

* refactor: change minimum required Nim version to 1.6.0
diff --git a/.github/workflows/builds.yml b/.github/workflows/builds.yml
@@ -19,7 +19,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        cache_marker: [ 34 ]
+        cache_marker: [ 40 ]
         platform:
           - {
             icon: 🐧,
@@ -39,7 +39,7 @@ jobs:
             os: windows,
             shell: msys2
           }
-        nim_version: [ v1.2.8, version-1-2, version-1-4, version-1-6, version-2-0, devel ]
+        nim_version: [ v1.6.0, version-1-6, version-2-0, devel ]
     name: ${{ matrix.platform.icon }} ${{ matrix.platform.label }} - Nim ${{ matrix.nim_version }}
     runs-on: ${{ matrix.platform.os }}-latest
     defaults:
@@ -100,7 +100,7 @@ jobs:
               git clone --depth 1 $2 $1 \
                         --branch $3 2>/dev/null && \
               cd $1 && git rev-parse HEAD \
-              | cut -c1-7)" >> ${GITHUB_OUTPUT}
+              | cut -c1-10)" >> ${GITHUB_OUTPUT}
           }
           clone1b choosenim \
                   https://github.com/dom96/choosenim.git \
@@ -194,14 +194,20 @@ jobs:
           if [[ ${{ matrix.platform.os }} = windows ]]; then
             mkdir -p "$(cygpath "${USERPROFILE}")/.nimble/bin"
           fi
-          CHOOSENIM_CHOOSE_VERSION=\#${{ matrix.nim_version }} \
-          CHOOSENIM_NO_ANALYTICS=1 \
+          export CHOOSENIM_CHOOSE_VERSION=\#${{ steps.cache-key.outputs.nim_commit }}
+          export CHOOSENIM_NO_ANALYTICS=1
           ./init.sh -y
           if [[ ${{ matrix.platform.os }} = windows ]]; then
             mv "$(cygpath "${USERPROFILE}")/.nimble" "${HOME}/"
           fi
+          export NIMBLE_DIR="${HOME}/.nimble"
+          export PATH="${NIMBLE_DIR}/bin:${PATH}"
           echo 'export NIMBLE_DIR="${HOME}/.nimble"' >> "${HOME}/.bash_env"
           echo 'export PATH="${NIMBLE_DIR}/bin:${PATH}"' >> "${HOME}/.bash_env"
+          echo
+          nim --version
+          echo
+          nimble --version
 
       # maybe can be reworked (along with caching logic) re: Nimble
       # corresponding to Nim v2, with conditional logic for older Nim/Nimble
@@ -222,14 +228,13 @@ jobs:
       # Nim's version-2-0 branch still sets package search path to pkgs instead
       # of pkgs2 when NIMBLE_DIR environment variable is set
       # https://github.com/nim-lang/nimble/issues/1061
-      # https://github.com/nim-lang/Nim/blob/version-2-0/compiler/commands.nim#L613
+      # https://github.com/nim-lang/Nim/blob/version-2-0/compiler/commands.nim#L614-L616
       # it's harmless to set an additional --nimblePath that isn't relevant
       # (doesn't exist) for a particular version of Nim/Nimble
       - name: Build examples
         run: |
           source "${HOME}/.bash_env"
           extras/build_examples.sh --nimblePath:"${NIMBLE_DIR}/pkgs2"
-          echo
           extras/build_examples.sh -d:release --nimblePath:"${NIMBLE_DIR}/pkgs2"
 
       # Notcurses is currently not able to access Windows ConPTY in GitHub Actions
diff --git a/README.md b/README.md
@@ -149,27 +149,27 @@ $ nim c --passC:"-I${HOME}/repos/notcurses/include" \
 
 To build all the examples do
 
-``` text
+```text
 $ extras/build_examples.sh
 ```
 
 Additional options are supported
 
-``` text
+```text
 $ extras/build_examples.sh -d:release --passC ...
 ```
 
 ## Tests
 
 Unit tests for nim-notcurses can be run with [`nimble`](https://github.com/nim-lang/nimble#readme)
 
-``` text
+```text
 $ nimble test
 ```
 
 You can use additional `nimble` and compiler options
 
-``` text
+```text
 $ nimble --verbose test --passC ...
 ```
 
@@ -183,13 +183,13 @@ Most of Notcurses' facilities expect a proper terminal. Also, given the nature o
 
 Currently, most of the coverage data is generated by building and running the [examples](#examples), with unit [tests](#tests) filling in a few gaps
 
-``` text
+```text
 $ extras/coverage.sh
 ```
 
 Additional options are supported
 
-``` text
+```text
 $ extras/coverage.sh --passC ...
 ```
 
diff --git a/examples/config.nims b/examples/config.nims
@@ -25,14 +25,7 @@ else:
 --threads:on
 --tlsEmulation:off
 
-when (NimMajor, NimMinor) == (1, 2):
-  switch("hint", "Processing:off")
-  switch("hint", "XDeclaredButNotUsed:off")
-  switch("warning", "ObservableStores:off")
-elif (NimMajor, NimMinor) == (1, 4):
-  switch("hint", "XCannotRaiseY:off")
-else:
-  --hint:"XCannotRaiseY:off"
+--hint:"XCannotRaiseY:off"
 when (NimMajor, NimMinor, NimPatch) > (1, 6, 10):
   --warning:"BareExcept:on"
 
diff --git a/extras/build_examples.sh b/extras/build_examples.sh
@@ -7,7 +7,9 @@ source extras/examples.sh
 for module in ${modules[@]}; do
   echo
   echo nim c "$@" examples/${module}.nim
-  echo
+  if [[ ! ("$@" = *"-d:release"* || "$@" = *"--define:release"*) ]]; then
+    echo
+  fi
   nim c "$@" examples/${module}.nim
 done
 
diff --git a/extras/coverage.sh b/extras/coverage.sh
@@ -18,7 +18,9 @@ for module in ${modules[@]}; do
   fi
   echo
   echo nim c -d:coverage "$@" examples/${module}.nim
-  echo
+  if [[ ! ("$@" = *"-d:release"* || "$@" = *"--define:release"*) ]]; then
+    echo
+  fi
   nim c -d:coverage "$@" examples/${module}.nim
 done
 
@@ -84,6 +86,7 @@ lcov --add-tracefile \
 
 echo
 lcov --extract coverage/coverage.info \
+     --ignore-errors unused \
      "${PWD}"/notcurses.nim \
      "${PWD}"/notcurses/\*.nim \
      >> coverage/extracted.info
@@ -97,7 +100,17 @@ genhtml coverage/extracted.info \
 
 if [[ ! -z "${CODECOV_TOKEN}" ]]; then
   cd coverage
-  curl -Os https://uploader.codecov.io/latest/macos/codecov
+  if [[ $(uname) = "Linux" ]]; then
+    curl -Os https://uploader.codecov.io/latest/linux/codecov
+  elif [[ $(uname) = "Darwin" ]]; then
+    curl -Os https://uploader.codecov.io/latest/macos/codecov
+  elif [[ -v MSYSTEM ]]; then
+    curl -Os https://uploader.codecov.io/latest/windows/codecov.exe
+  else
+    echo -e ${bred}Error${none}: codecov uploader binary is only available for \
+            Linux, macOS, and Windows
+    exit 1
+  fi
   chmod +x codecov
   cd - 1>/dev/null
   echo
diff --git a/extras/lsp.nim b/extras/lsp.nim
@@ -25,6 +25,7 @@ import
   notcurses,
   notcurses/abi,
   notcurses/abi/core,
+  notcurses/abi/coverage,
   notcurses/abi/direct,
   notcurses/abi/direct/core as notcurses_abi_direct_core,
   notcurses/core as notcurses_core,
diff --git a/notcurses.nim b/notcurses.nim
@@ -1,9 +1,6 @@
 {.passL: "-lnotcurses -lnotcurses-core".}
 
-when (NimMajor, NimMinor) >= (1, 4):
-  {.push raises: [].}
-else:
-  {.push raises: [Defect].}
+{.push raises: [].}
 
 import ./notcurses/abi/impl as abi_impl
 import ./notcurses/api/impl
diff --git a/notcurses.nimble b/notcurses.nimble
@@ -6,6 +6,7 @@ license      = "Apache License 2.0 or MIT"
 installDirs  = @["notcurses"]
 installFiles = @["LICENSE", "LICENSE-APACHEv2", "LICENSE-MIT", "LICENSE-NOTCURSES", "notcurses.nim"]
 
-requires "nim >= 1.2.8",
+requires "nim >= 1.6.0",
+         "results",
          "stew",
          "unittest2"
diff --git a/notcurses/abi/common.nim b/notcurses/abi/common.nim
@@ -1,10 +1,7 @@
 # L[num] comments below pertain to sources for Notcurses v3.0.9
 # https://github.com/dankamongmen/notcurses/tree/v3.0.9/include
 
-when (NimMajor, NimMinor) >= (1, 4):
-  {.push raises: [].}
-else:
-  {.push raises: [Defect].}
+{.push raises: [].}
 
 import std/[strutils, terminal]
 import ./constants
diff --git a/notcurses/abi/constants/nckeys.nim b/notcurses/abi/constants/nckeys.nim
@@ -3,10 +3,7 @@
 
 # this module uses extra whitespace so it can be visually scanned more easily
 
-when (NimMajor, NimMinor) >= (1, 4):
-  {.push raises: [].}
-else:
-  {.push raises: [Defect].}
+{.push raises: [].}
 
 # L31 - notcurses/nckeys.h
 const PRETERUNICODEBASE* = 1115000'u32
diff --git a/notcurses/abi/direct/impl.nim b/notcurses/abi/direct/impl.nim
@@ -1,10 +1,7 @@
 # L[num] comments below pertain to sources for Notcurses v3.0.9
 # https://github.com/dankamongmen/notcurses/tree/v3.0.9/include
 
-when (NimMajor, NimMinor) >= (1, 4):
-  {.push raises: [].}
-else:
-  {.push raises: [Defect].}
+{.push raises: [].}
 
 import ../common
 import ./constants
diff --git a/notcurses/abi/impl.nim b/notcurses/abi/impl.nim
@@ -3,10 +3,7 @@
 
 # this module uses extra whitespace so it can be visually scanned more easily
 
-when (NimMajor, NimMinor) >= (1, 4):
-  {.push raises: [].}
-else:
-  {.push raises: [Defect].}
+{.push raises: [].}
 
 import std/[macros, posix]
 import pkg/stew/endians2
diff --git a/notcurses/abi/locale.nim b/notcurses/abi/locale.nim
@@ -1,10 +1,7 @@
 # https://en.cppreference.com/w/c/locale/LC_categories
 # https://en.cppreference.com/w/c/locale/setlocale
 
-when (NimMajor, NimMinor) >= (1, 4):
-  {.push raises: [].}
-else:
-  {.push raises: [Defect].}
+{.push raises: [].}
 
 const locale_header = "<locale.h>"
 
@@ -19,25 +16,14 @@ else:
 
 {.pragma: locale_const, header: locale_header, importc, nodecl.}
 
-when (NimMajor, NimMinor) >= (1, 4):
-  let
-    LC_ALL* {.locale_const.}: cint
-    LC_COLLATE* {.locale_const.}: cint
-    LC_CTYPE* {.locale_const.}: cint
-    LC_MONETARY* {.locale_const.}: cint
-    LC_NUMERIC* {.locale_const.}: cint
-    LC_TIME* {.locale_const.}: cint
-  when defined(posix):
-    let LC_MESSAGES* {.locale_const.}: cint
-else:
-  var
-    LC_ALL* {.locale_const.}: cint
-    LC_COLLATE* {.locale_const.}: cint
-    LC_CTYPE* {.locale_const.}: cint
-    LC_MONETARY* {.locale_const.}: cint
-    LC_NUMERIC* {.locale_const.}: cint
-    LC_TIME* {.locale_const.}: cint
-  when defined(posix):
-    var LC_MESSAGES* {.locale_const.}: cint
+let
+  LC_ALL* {.locale_const.}: cint
+  LC_COLLATE* {.locale_const.}: cint
+  LC_CTYPE* {.locale_const.}: cint
+  LC_MONETARY* {.locale_const.}: cint
+  LC_NUMERIC* {.locale_const.}: cint
+  LC_TIME* {.locale_const.}: cint
+when defined(posix):
+  let LC_MESSAGES* {.locale_const.}: cint
 
 proc setlocale*(category: cint, locale: cstring): cstring {.locale.}
diff --git a/notcurses/abi/wide.nim b/notcurses/abi/wide.nim
@@ -1,7 +1,4 @@
-when (NimMajor, NimMinor) >= (1, 4):
-  {.push raises: [].}
-else:
-  {.push raises: [Defect].}
+{.push raises: [].}
 
 import std/[bitops, macros, typetraits]
 import pkg/stew/byteutils
@@ -143,11 +140,8 @@ macro L*(s: static string): untyped =
       for i, wc in `wcs`:
         # when (NimMajor, NimMinor) < (2, 0):
         when (NimMajor, NimMinor, NimPatch) < (1, 9, 3):
-          # at this point in macro expansion `wc` is a literal so must
-          # explicitly convert to Wchar
           ws[i] = wc.wchar
         else:
-          # not an issue in Nim 2.0+
           ws[i] = wc
       ws
     `toArrayW`()
diff --git a/notcurses/api/common.nim b/notcurses/api/common.nim
@@ -1,10 +1,7 @@
-when (NimMajor, NimMinor) >= (1, 4):
-  {.push raises: [].}
-else:
-  {.push raises: [Defect].}
+{.push raises: [].}
 
 import std/[hashes, sets]
-import pkg/stew/results
+import pkg/results
 import ../abi/common
 import ../locale
 import ../wide
diff --git a/notcurses/api/constants/nckeys.nim b/notcurses/api/constants/nckeys.nim
@@ -1,7 +1,4 @@
-when (NimMajor, NimMinor) >= (1, 4):
-  {.push raises: [].}
-else:
-  {.push raises: [Defect].}
+{.push raises: [].}
 
 import std/[sequtils, sets]
 import ../../abi/constants/nckeys
diff --git a/notcurses/api/direct/impl.nim b/notcurses/api/direct/impl.nim
@@ -1,10 +1,7 @@
-when (NimMajor, NimMinor) >= (1, 4):
-  {.push raises: [].}
-else:
-  {.push raises: [Defect].}
+{.push raises: [].}
 
 import std/[bitops, macros, sequtils, sets]
-import pkg/stew/results
+import pkg/results
 import ../../abi/direct/impl
 import ../common
 import ./constants
@@ -45,13 +42,13 @@ proc init*(T: typedesc[NotcursesDirect], init: Init, initName: string,
   let failedMsg = initName & " failed"
   if options.term != "": termtype = options.term.cstring
   when (NimMajor, NimMinor, NimPatch) > (1, 6, 10):
-    {.warning[BareExcept]: off.}
+    {.push warning[BareExcept]: off.}
   try:
     cPtr = init(termtype, file, options.flags)
   except Exception:
     raise (ref ApiDefect)(msg: failedMsg)
   when (NimMajor, NimMinor, NimPatch) > (1, 6, 10):
-    {.warning[BareExcept]: on.}
+    {.pop.}
   if cPtr.isNil: raise (ref ApiDefect)(msg: failedMsg)
   T(cPtr: cPtr)
 
diff --git a/notcurses/api/impl.nim b/notcurses/api/impl.nim
diff --git a/notcurses/core.nim b/notcurses/core.nim
diff --git a/notcurses/direct.nim b/notcurses/direct.nim
diff --git a/notcurses/direct/core.nim b/notcurses/direct/core.nim
diff --git a/notcurses/locale.nim b/notcurses/locale.nim
diff --git a/notcurses/wide.nim b/notcurses/wide.nim
diff --git a/tests/config.nims b/tests/config.nims
