build: add ruff linter (#332)

* fix: lowercase whats changed label

* fix: update commit message for release

* build: add ruff linter

* fix python linting errors

* fix: github workflow script

Author: anonrig

.github/workflows/lint_and_format_check.yml

@@ -1,12 +1,6 @@
 name: Lint and Format Check (Ubuntu Latest)
 
-on:
-  push:
-    branches:
-      - "*"
-  pull_request:
-    branches:
-      - "*"
+on: [push, pull_request]
 
 permissions:
   contents: read
@@ -15,7 +9,7 @@ jobs:
   lint-and-format:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # v3.1.0
 
       - name: Install clang-format
         run: |
@@ -28,3 +22,8 @@ jobs:
         env:
           CXX: clang++-14
           LINT_AND_FORMAT_CHECK: true
+
+      - uses: @chartboost/ruff-action@v1
+        name: Lint with Ruff
+        with:
+          version: 0.0.261

.github/workflows/release.yml

@@ -75,7 +75,7 @@ jobs:
 
           git add doxygen include/ada/ada_version.h CMakeLists.txt
 
-          git commit -m "New Release: ${{ env.NEXT_RELEASE_TAG }}"
+          git commit -m "chore: release ${{ env.NEXT_RELEASE_TAG }}"
           git push
 
       - name: "Create Release"

pyproject.toml

@@ -0,0 +1,28 @@
+[tool.ruff]
+select = [
+  "C90",    # McCabe cyclomatic complexity
+  "E",      # pycodestyle
+  "F",      # Pyflakes
+  "ICN",    # flake8-import-conventions
+  "INT",    # flake8-gettext
+  "PLC",    # Pylint conventions
+  "PLE",    # Pylint errors
+  "PLR09",  # Pylint refactoring: max-args, max-branches, max returns, max-statements
+  "PYI",    # flake8-pyi
+  "RSE",    # flake8-raise
+  "RUF",    # Ruff-specific rules
+  "T10",    # flake8-debugger
+  "TCH",    # flake8-type-checking
+  "TID",    # flake8-tidy-imports
+  "W",      # pycodestyle
+  "YTT",    # flake8-2020
+]
+exclude = [
+  "docs",
+  "tests",
+]
+ignore = [
+  "E722"   # Do not use bare `except`
+]
+line-length = 120
+target-version = "py37"

singleheader/amalgamate.py

@@ -3,6 +3,7 @@
 # Creates the amalgamated source files.
 #
 
+import zipfile
 import sys
 import os.path
 import subprocess
@@ -18,9 +19,6 @@
 PROJECTPATH = os.path.dirname(SCRIPTPATH)
 print(f"SCRIPTPATH={SCRIPTPATH} PROJECTPATH={PROJECTPATH}")
 
-
-print("We are about to amalgamate all ada files into one source file.")
-print("See https://www.sqlite.org/amalgamation.html and https://en.wikipedia.org/wiki/Single_Compilation_Unit for rationale.")
 if "AMALGAMATE_SOURCE_PATH" not in os.environ:
     AMALGAMATE_SOURCE_PATH = os.path.join(PROJECTPATH, "src")
 else:
@@ -71,7 +69,7 @@ def dofile(fid, prepath, filename):
     RELFILE = os.path.relpath(file, PROJECTPATH)
     # Last lines are always ignored. Files should end by an empty lines.
     print(f"/* begin file {RELFILE} */", file=fid)
-    includepattern = re.compile('\s*#\s*include "(.*)"')
+    includepattern = re.compile('\\s*#\\s*include "(.*)"')
     with open(file, 'r') as fid2:
         for line in fid2:
             line = line.rstrip('\n')
@@ -84,7 +82,7 @@ def dofile(fid, prepath, filename):
 
                 if includedfile.startswith('../'):
                     includedfile = includedfile[2:]
-                # we explicitly include ada headers, one time each 
+                # we explicitly include ada headers, one time each
                 doinclude(fid, includedfile, line, filename)
             else:
                 print(line, file=fid)
@@ -132,7 +130,6 @@ def dofile(fid, prepath, filename):
   shutil.copy2(os.path.join(SCRIPTPATH,"demo.cpp"),AMALGAMATE_OUTPUT_PATH)
   shutil.copy2(os.path.join(SCRIPTPATH,"README.md"),AMALGAMATE_OUTPUT_PATH)
 
-import zipfile
 zf = zipfile.ZipFile(os.path.join(AMALGAMATE_OUTPUT_PATH,'singleheader.zip'), 'w', zipfile.ZIP_DEFLATED)
 zf.write(os.path.join(AMALGAMATE_OUTPUT_PATH,"ada.cpp"), "ada.cpp")
 zf.write(os.path.join(AMALGAMATE_OUTPUT_PATH,"ada.h"), "ada.h")

tools/release/create_release.py

@@ -11,7 +11,7 @@
 TOKEN = os.environ["GITHUB_TOKEN"]
 if not NEXT_TAG or not REPO_NAME or not TOKEN:
     raise Exception(
-        f"Bad environment variables. Invalid GITHUB_REPOSITORY, GITHUB_TOKEN or NEXT_RELEASE_TAG"
+        "Bad environment variables. Invalid GITHUB_REPOSITORY, GITHUB_TOKEN or NEXT_RELEASE_TAG"
     )
 
 g = Github(TOKEN)

tools/release/lib/release.py

@@ -110,7 +110,7 @@ def contruct_release_notes(repository, next_tag_name):
         repository.full_name, last_tag.title, next_tag_name
     )
 
-    notes = "## What's Changed\n"
+    notes = "## What's changed\n"
     for changes in whats_changed:
         notes += changes + "\n"
 

tools/release/lib/tests/test_release.py

@@ -211,7 +211,7 @@ def test_contruct_release_notes():
     notes = release.contruct_release_notes(repo_stub, "v3.0.0")
     assert (
         notes
-        == "## What's Changed\n"
+        == "## What's changed\n"
         + "* Feature 2 by @new_contr_1 in https://github.com/ada-url/ada/pull/12\n"
         + "* Refactoring by @new_contr_2 in https://github.com/ada-url/ada/pull/15\n"
         + "* Feature 10 by @contr_2 in https://github.com/ada-url/ada/pull/22\n"