Update dependencies and add Ruff (#34)

Author: artnc

.dockerignore

@@ -1,5 +1,6 @@
 *
 !.editorconfig
 !entry.ts
+!ruff.toml
 !stylesheet.xml
 !svgo.config.js

Dockerfile

@@ -1,4 +1,4 @@
-FROM alpine:3.16.0
+FROM alpine:3.18.4
 
 ENV PIP_DISABLE_PIP_VERSION_CHECK=1
 ENV PIP_NO_CACHE_DIR=1
@@ -13,36 +13,36 @@ RUN apk add --no-cache --virtual .build-deps \
     clang-extra-tools \
     libxslt \
     nodejs \
-    openjdk11-jre-headless \
+    openjdk17-jre-headless \
     py3-pip \
     python3 \
   && pip3 install \
-    autoflake==1.4 \
-    black==22.3.0 \
-    isort==5.10.1 \
+    autoflake==1.7.8 \
+    isort==5.12.0 \
+    ruff==0.1.5 \
   && python3 -m venv /black21-venv \
   && source /black21-venv/bin/activate \
   && pip3 install black==21.12b0 click==8.0.4 \
   && deactivate \
   && echo 'source /black21-venv/bin/activate && black "$@"' > /usr/bin/black21 \
   && chmod +x /usr/bin/black21 \
   && npm install -g \
-    @prettier/plugin-xml@2.2.0 \
-    @types/node@18.16.0 \
-    prettier@2.8.8 \
-    svgo@2.8.0 \
-    typescript@5.0.4 \
+    @prettier/plugin-xml@3.2.2 \
+    @types/node@20.9.0 \
+    prettier@3.1.0 \
+    svgo@3.0.3 \
+    typescript@5.2.2 \
   && apk del .build-deps \
-  && wget https://github.com/google/google-java-format/releases/download/v1.15.0/google-java-format-1.15.0-all-deps.jar -O google-java-format \
-  && wget https://search.maven.org/remotecontent?filepath=com/facebook/ktfmt/0.35/ktfmt-0.35-jar-with-dependencies.jar -O ktfmt \
-  && wget https://github.com/mvdan/sh/releases/download/v3.4.3/shfmt_v3.4.3_linux_amd64 -O shfmt \
+  && wget https://github.com/google/google-java-format/releases/download/v1.18.1/google-java-format-1.18.1-all-deps.jar -O google-java-format \
+  && wget https://search.maven.org/remotecontent?filepath=com/facebook/ktfmt/0.46/ktfmt-0.46-jar-with-dependencies.jar -O ktfmt \
+  && wget https://github.com/mvdan/sh/releases/download/v3.7.0/shfmt_v3.7.0_linux_amd64 -O shfmt \
   && chmod +x shfmt \
-  && wget https://releases.hashicorp.com/terraform/1.1.8/terraform_1.1.8_linux_amd64.zip -O tf.zip \
+  && wget https://releases.hashicorp.com/terraform/1.6.3/terraform_1.6.3_linux_amd64.zip -O tf.zip \
   && unzip tf.zip \
   && rm tf.zip \
-  && wget https://github.com/coursier/coursier/releases/download/v2.0.16/coursier -O /bin/coursier \
+  && wget https://github.com/coursier/coursier/releases/download/v2.1.7/coursier -O /bin/coursier \
   && chmod +x /bin/coursier \
-  && coursier bootstrap org.scalameta:scalafmt-cli_2.13:3.5.1 \
+  && coursier bootstrap org.scalameta:scalafmt-cli_2.13:3.7.16 \
     -r sonatype:snapshots --main org.scalafmt.cli.Cli \
     --standalone \
     -o scalafmt \

README.md

@@ -2,18 +2,19 @@
 
 This repo currently contains a single [pre-commit](https://pre-commit.com/) hook that internally runs several code formatters in parallel.
 
-- [Prettier](https://github.com/prettier/prettier) v2.8.8 for CSS, HTML, JS, JSX, Markdown, Sass, TypeScript, XML, YAML
-- [Black](https://github.com/psf/black) v22.3.0 for Python 3, v21.12b0 for Python 2
-- [autoflake](https://github.com/myint/autoflake) v1.4 for Python
-- [isort](https://github.com/PyCQA/isort) v5.10.1 for Python
-- [google-java-format](https://github.com/google/google-java-format) v1.15.0 for Java
-- [ktfmt](https://github.com/facebookincubator/ktfmt) v0.35 for Kotlin
-- [scalafmt](https://scalameta.org/scalafmt/) v3.5.1 for Scala
-- [shfmt](https://github.com/mvdan/sh) v3.4.3 for Shell
-- [xsltproc](http://www.xmlsoft.org/xslt/xsltproc.html) from libxslt v10135 for XML
-- [terraform fmt](https://github.com/hashicorp/terraform) v1.1.8 for Terraform
-- [ClangFormat](https://clang.llvm.org/docs/ClangFormat.html) v13.0.1 for Protobuf
-- [SVGO](https://github.com/svg/svgo) v2.8.0 for SVG
+- [Prettier](https://github.com/prettier/prettier) v3.1.0 for CSS, HTML, JS, JSX, Markdown, Sass, TypeScript, XML, YAML
+- [Ruff](https://docs.astral.sh/ruff/) v0.1.5 for Python 3
+- [Black](https://github.com/psf/black) v21.12b0 for Python 2
+- [autoflake](https://github.com/myint/autoflake) v1.7.8 for Python <!-- TODO: Upgrade to v2+, restrict to Python 2, and reenable Ruff rule F401 once our Python 3 repos that were converted from Python 2 no longer use type hint comments: https://github.com/PyCQA/autoflake/issues/222#issuecomment-1419089254 -->
+- [isort](https://github.com/PyCQA/isort) v5.12.0 for Python 2
+- [google-java-format](https://github.com/google/google-java-format) v1.18.1 for Java
+- [ktfmt](https://github.com/facebookincubator/ktfmt) v0.46 for Kotlin
+- [scalafmt](https://scalameta.org/scalafmt/) v3.7.16 for Scala
+- [shfmt](https://github.com/mvdan/sh) v3.7.0 for Shell
+- [xsltproc](http://www.xmlsoft.org/xslt/xsltproc.html) from libxslt v10138 for XML
+- [terraform fmt](https://github.com/hashicorp/terraform) v1.6.3 for Terraform
+- [ClangFormat](https://clang.llvm.org/docs/ClangFormat.html) v16.0.6 for Protobuf
+- [SVGO](https://github.com/svg/svgo) v3.0.3 for SVG
 - Custom regex transformations (basically [sed](https://en.wikipedia.org/wiki/Sed)), for example:
   - Trimming trailing whitespace and newlines
   - Removing unnecessary `coding` pragmas and `object` base classes in Python 3

entry.ts

@@ -3,9 +3,6 @@
 import { exec } from "child_process";
 import { readFile, writeFile } from "fs";
 
-/** Maximum characters per line in Python */
-const PYTHON_LINE_LENGTH = 100;
-
 /**
  * Path to an empty file that we can provide to linters/formatters as a config
  * file in order to force those tools' default behavior
@@ -16,11 +13,16 @@ const EMPTY_FILE = "/emptyfile";
 const PRETTIER_OPTIONS = [
   "--arrow-parens",
   "avoid",
+  // We don't enable or benefit from caching, but we must still specify a
+  // location or else Prettier will fail with the error `EPERM: operation not
+  // permitted, mkdir '/src/node_modules/.cache/prettier'`
+  "--cache-location",
+  "/tmp/prettier-cache",
   "--end-of-line",
   "auto",
   "--ignore-path",
   EMPTY_FILE,
-  "--loglevel",
+  "--log-level",
   "warn",
   "--no-config",
   "--no-editorconfig",
@@ -74,6 +76,7 @@ const enum HookName {
   Ktfmt = "ktfmt",
   PrettierJs = "Prettier (JS)",
   PrettierNonJs = "Prettier (non-JS)",
+  Ruff = "Ruff",
   Scalafmt = "scalafmt",
   Sed = "sed",
   Shfmt = "shfmt",
@@ -99,7 +102,7 @@ interface Hook {
    * linter crashes are surfaced to the user and for simplicity in the case of
    * the many linters that exit with nonzero iff there are violations.
    */
-  action: (sources: string[], args: Args) => Promise<unknown>;
+  action: (sources: string[], args: Args) => any;
   /** Source files to exclude */
   exclude?: RegExp;
   /** Source files to include */
@@ -144,18 +147,20 @@ const HOOKS: Record<HookName, LockableHook> = {
   }),
   [HookName.Black]: createLockableHook({
     action: async (sources, args) =>
+      args["python-version"]?.startsWith("2") &&
       run(
         // Black 21.x was the last major version with Python 2 support. It also
         // had a bug that requires pinning click==8.0.4. Both packages should
         // be removed once we drop Python 2 support.
         // https://github.com/psf/black/issues/2964
-        ...(args["python-version"]?.startsWith("2")
-          ? ["black21", "--fast", "--target-version", "py27"]
-          : ["black", "--target-version", "py310"]),
+        "black21",
+        "--fast",
+        "--target-version",
+        "py27",
         "--config",
         EMPTY_FILE,
         "--line-length",
-        `${PYTHON_LINE_LENGTH}`,
+        "100",
         "--quiet",
         ...sources,
       ),
@@ -183,7 +188,9 @@ const HOOKS: Record<HookName, LockableHook> = {
     // isort's automatic config file detection is broken
     // https://github.com/PyCQA/isort/issues/1907
     // https://github.com/samueljsb/qaz/pull/104
-    action: sources => run("isort", "--settings", "/.editorconfig", ...sources),
+    action: (sources, args) =>
+      args["python-version"]?.startsWith("2") &&
+      run("isort", "--settings", "/.editorconfig", ...sources),
     include: /\.py$/,
     runAfter: [HookName.Autoflake],
   }),
@@ -212,7 +219,14 @@ const HOOKS: Record<HookName, LockableHook> = {
     runAfter: [HookName.Sed],
   }),
   [HookName.PrettierJs]: createLockableHook({
-    action: sources => run("prettier", ...PRETTIER_OPTIONS, ...sources),
+    action: sources =>
+      run(
+        "prettier",
+        ...PRETTIER_OPTIONS,
+        "--trailing-comma",
+        "es5",
+        ...sources,
+      ),
     exclude: /\b(compressed|custom|min|minified|pack|prod|production)\b/,
     include: /\.jsx?$/,
     runAfter: [HookName.Sed],
@@ -222,13 +236,28 @@ const HOOKS: Record<HookName, LockableHook> = {
       run(
         "prettier",
         ...PRETTIER_OPTIONS,
-        "--trailing-comma",
-        "all",
+        "--plugin",
+        // https://github.com/prettier/prettier/issues/15141#issuecomment-1685112479
+        "/usr/local/lib/node_modules/@prettier/plugin-xml/src/plugin.js",
         ...sources,
       ),
     include: /\.(css|html?|markdown|md|scss|tsx?|xml|ya?ml)$/,
     runAfter: [HookName.Sed, HookName.Xsltproc],
   }),
+  [HookName.Ruff]: createLockableHook({
+    action: async (sources, args) => {
+      if (args["python-version"]?.startsWith("2")) {
+        return;
+      }
+      // Sometimes Ruff requires multiple passes, which is ok since it's fast
+      for (let i = 0; i < 2; ++i) {
+        await run("ruff", "check", "--config", "/ruff.toml", ...sources);
+        await run("ruff", "format", "--config", "/ruff.toml", ...sources);
+      }
+    },
+    include: /\.py$/,
+    runAfter: [HookName.Autoflake],
+  }),
   [HookName.Scalafmt]: createLockableHook({
     action: async (sources, args) =>
       run(
@@ -385,15 +414,25 @@ const GLOBAL_EXCLUDES = (() => {
 
 /** Prefixes a string to all nonempty lines of input */
 const prefixLines = (() => {
+  const LINES_TO_IGNORE = new RegExp(
+    [
+      // Empty lines
+      /^\s*$/,
+      // ktfmt spams this for every file that has no violations
+      /\bDone formatting .+\.kts?$/,
+      // Black 21.12b0 spams this when running on Python 2 source code
+      /\bDEPRECATION: Python 2 support\b/,
+    ]
+      .map(regex => regex.source)
+      .join("|"),
+  );
   const maxPrefixLength = Math.max(
     ...Object.keys(HOOKS).map(name => name.length),
   );
   return (prefix: string, lines: string) =>
     lines
       .split("\n")
-      .filter(line => line.trim().length)
-      // Black 21.12b0 spams this when running on Python 2 source code
-      .filter(line => !line.includes("DEPRECATION: Python 2 support"))
+      .filter(line => !LINES_TO_IGNORE.test(line))
       .map(line => `${prefix}:`.padEnd(maxPrefixLength + 2) + line)
       .join("\n");
 })();

ruff.toml

@@ -0,0 +1,39 @@
+cache-dir = "/tmp/.cache/ruff"
+fix-only = true
+line-length = 100
+target-version = "py37"
+
+[pydocstyle]
+convention = "pep257"
+
+[isort]
+combine-as-imports = true
+
+[lint]
+ignore = [
+  # We disable Ruff's `unused-import` for now in favor of autoflake <2 because
+  # the latter preserves imports that are unused in code but "used" in type
+  # hint comments. Ruff also seems to have an unfortunate bug: it can end up
+  # moving a `pylint: disable=unused-import` comment from one import to another
+  "F401",
+  # This rule inexplicably converts `elif a or isinstance(b, C) or isinstance
+  # (b, D)` to `elif isinstance(b, (C, D))`, buggily removing condition `a`
+  "PLR1701",
+]
+# https://docs.astral.sh/ruff/rules/
+select = [
+  "B",
+  "C4",
+  "D",
+  "E",
+  "F",
+  "I",
+  "ISC",
+  "PERF",
+  "PIE",
+  "PL",
+  "Q",
+  "RUF",
+  "SIM",
+  "UP",
+]