refactor(no-release): make ruff standalone (serious-scaffold#630)

huxuan · Jul 4, 2024 · 175f7cd · 175f7cd
1 parent 728b70e
commit 175f7cd
Show file tree

Hide file tree

Showing 17 changed files with 37 additions and 40 deletions.
diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile
@@ -48,6 +48,10 @@ RUN if [ "${PYTHON_VERSION}" = "3.8" ]; then \
         pipx install pre-commit==3.7.1; \
     fi
 
+# Install prerequisites
+RUN --mount=source=Makefile,target=Makefile \
+    make prerequisites
+
 # Create a non-root user with sudo permission
 ARG USERNAME=ss-python
 ARG USER_UID=1000

diff --git a/.devcontainer/Dockerfile.dockerignore b/.devcontainer/Dockerfile.dockerignore
@@ -1,5 +1,6 @@
 *
 .*
+!/Makefile
 !/README.md
 !/pdm.lock
 !/pyproject.toml

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -26,6 +26,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
           version: 2.16.1
       - run: env | sort
+      - run: make prerequisites
       - run: make dev
       - run: make lint test doc build
     strategy:

diff --git a/.gitlab/workflows/ci.yml b/.gitlab/workflows/ci.yml
@@ -26,6 +26,7 @@ ci:
     - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CI_PIPELINE_SOURCE == "push"
     - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
   script:
+    - make prerequisites
     - make dev
     - make lint test doc build
   stage: ci

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -59,15 +59,15 @@ repos:
         require_serial: true
       - id: ruff
         name: ruff
-        entry: pdm run python -m ruff check --force-exclude
+        entry: ruff check --force-exclude
         language: system
         types_or:
           - python
           - pyi
         require_serial: true
       - id: ruff-format
         name: ruff-format
-        entry: pdm run python -m ruff format --force-exclude
+        entry: ruff format --force-exclude
         language: system
         types_or:
           - python

diff --git a/.renovaterc.json b/.renovaterc.json
@@ -10,6 +10,7 @@
             "datasourceTemplate": "pypi",
             "description": "Match Python packages installed with pip/pipx",
             "fileMatch": [
+                "^Makefile$",
                 "^README\\.md$",
                 "^\\.devcontainer/Dockerfile$",
                 "^\\.github/workflows/.+\\.yml$",
@@ -20,6 +21,7 @@
                 "^includes/sample\\.jinja$",
                 "^template/.*\\.github.*/workflows/.+\\.yml(\\.jinja)?$",
                 "^template/.*\\.gitlab.*/workflows/.+\\.yml(\\.jinja)?$",
+                "^template/Makefile\\.jinja$",
                 "^template/\\.devcontainer/Dockerfile\\.jinja$",
                 "^template/\\.readthedocs\\.yaml$",
                 "^template/\\.renovaterc\\.json\\.jinja$",

diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-.PHONY: clean deepclean install dev mypy ruff ruff-format toml-sort lint pre-commit test-run test build publish doc-autobuild doc-gen doc-mypy doc-coverage doc consistency
+.PHONY: clean deepclean install dev prerequisites mypy ruff ruff-format toml-sort lint pre-commit test-run test build publish doc-autobuild doc-gen doc-mypy doc-coverage doc consistency
 
 ########################################################################################
 # Variables
@@ -51,6 +51,10 @@ dev:
 	pdm install
 	if [ "$(CI)" != "true" ] && command -v pre-commit > /dev/null 2>&1; then pre-commit install; fi
 
+# Install standalone tools
+prerequisites:
+	pipx install --force ruff==0.5.0
+
 ########################################################################################
 # Lint and pre-commit
 ########################################################################################
@@ -61,11 +65,11 @@ mypy:
 
 # Lint with ruff.
 ruff:
-	pdm run python -m ruff check .
+	ruff check .
 
 # Format with ruff.
 ruff-format:
-	pdm run python -m ruff format --check .
+	ruff format --check .
 
 # Check lint with toml-sort.
 toml-sort:

diff --git a/pdm.lock b/pdm.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -88,7 +88,6 @@ doc = [
 ]
 lint = [
   "mypy",
-  "ruff",
   "toml-sort",
 ]
 test = [

diff --git a/template/.devcontainer/Dockerfile.dockerignore b/template/.devcontainer/Dockerfile.dockerignore
@@ -1,5 +1,6 @@
 *
 .*
+!/Makefile
 !/README.md
 !/pdm.lock
 !/pyproject.toml

diff --git a/template/.devcontainer/Dockerfile.jinja b/template/.devcontainer/Dockerfile.jinja
@@ -48,6 +48,10 @@ RUN if [ "${PYTHON_VERSION}" = "3.8" ]; then \
         pipx install pre-commit==3.7.1; \
     fi
 
+# Install prerequisites
+RUN --mount=source=Makefile,target=Makefile \
+    make prerequisites
+
 # Create a non-root user with sudo permission
 ARG USERNAME={{ repo_name }}
 ARG USER_UID=1000

diff --git a/template/.pre-commit-config.yaml.jinja b/template/.pre-commit-config.yaml.jinja
@@ -62,15 +62,15 @@ repos:
         require_serial: true
       - id: ruff
         name: ruff
-        entry: pdm run python -m ruff check --force-exclude
+        entry: ruff check --force-exclude
         language: system
         types_or:
           - python
           - pyi
         require_serial: true
       - id: ruff-format
         name: ruff-format
-        entry: pdm run python -m ruff format --force-exclude
+        entry: ruff format --force-exclude
         language: system
         types_or:
           - python

diff --git a/template/.renovaterc.json.jinja b/template/.renovaterc.json.jinja
@@ -11,6 +11,7 @@
             "datasourceTemplate": "pypi",
             "description": "Match Python packages installed with pip/pipx",
             "fileMatch": [
+                "^Makefile$",
                 "^README\\.md$",
                 "^\\.devcontainer/Dockerfile$",
                 "^\\.github/workflows/.+\\.yml$",
@@ -22,6 +23,7 @@
                 "^includes/sample\\.jinja$",
                 "^template/.*\\.github.*/workflows/.+\\.yml(\\.jinja)?$",
                 "^template/.*\\.gitlab.*/workflows/.+\\.yml(\\.jinja)?$",
+                "^template/Makefile\\.jinja$",
                 "^template/\\.devcontainer/Dockerfile\\.jinja$",
                 "^template/\\.readthedocs\\.yaml$",
                 "^template/\\.renovaterc\\.json\\.jinja$",

diff --git a/template/Makefile.jinja b/template/Makefile.jinja
@@ -1,5 +1,5 @@
 [% from pathjoin("includes", "variable.jinja") import page_url with context -%]
-.PHONY: clean deepclean install dev mypy ruff ruff-format toml-sort lint pre-commit test-run test build publish doc-autobuild doc-gen doc-mypy doc-coverage doc
+.PHONY: clean deepclean install dev prerequisites mypy ruff ruff-format toml-sort lint pre-commit test-run test build publish doc-autobuild doc-gen doc-mypy doc-coverage doc
 [%- if project_name == "Serious Scaffold Python" %] consistency[% endif %]
 
 ########################################################################################
@@ -53,6 +53,10 @@ dev:
 	pdm install
 	if [ "$(CI)" != "true" ] && command -v pre-commit > /dev/null 2>&1; then pre-commit install; fi
 
+# Install standalone tools
+prerequisites:
+	pipx install --force ruff==0.5.0
+
 ########################################################################################
 # Lint and pre-commit
 ########################################################################################
@@ -63,11 +67,11 @@ mypy:
 
 # Lint with ruff.
 ruff:
-	pdm run python -m ruff check .
+	ruff check .
 
 # Format with ruff.
 ruff-format:
-	pdm run python -m ruff format --check .
+	ruff format --check .
 
 # Check lint with toml-sort.
 toml-sort:

diff --git a/template/[% if repo_platform == 'github' %].github[% endif %]/workflows/ci.yml.jinja b/template/[% if repo_platform == 'github' %].github[% endif %]/workflows/ci.yml.jinja
@@ -27,6 +27,7 @@ jobs:
           python-version: {{ '${{ matrix.python-version }}' }}
           version: 2.16.1
       - run: env | sort
+      - run: make prerequisites
       - run: make dev
       - run: make lint test doc build
     strategy:

diff --git a/...ab' or repo_platform == 'gitlab-self-managed' %].gitlab[% endif %]/workflows/ci.yml.jinja b/...ab' or repo_platform == 'gitlab-self-managed' %].gitlab[% endif %]/workflows/ci.yml.jinja
@@ -37,6 +37,7 @@ ci:
     - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CI_PIPELINE_SOURCE == "push"
     - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
   script:
+    - make prerequisites
     - make dev
     - make lint test doc build
   stage: ci

diff --git a/template/pyproject.toml.jinja b/template/pyproject.toml.jinja
@@ -129,7 +129,6 @@ doc = [
 ]
 lint = [
   "mypy",
-  "ruff",
   "toml-sort",
 ]
 test = [
-Original file line number
+Diff line change
@@ Expand Up / @@ -88,7 +88,6 @@ doc = [ @@
     ]
     lint = [
       "mypy",
-      "ruff",
       "toml-sort",
     ]
     test = [
@@ Expand Down @@