chore: replace prettier with biome (#4765)

Author: ssbarnea

.pre-commit-config.yaml

@@ -61,36 +61,13 @@ repos:
       - id: renovate-config-validator
         alias: renovate
         args: [--strict]
-  - repo: https://github.com/rbubley/mirrors-prettier
-    # keep it before yamllint
-    rev: v3.6.2
+  - repo: https://github.com/biomejs/pre-commit
+    rev: "v2.2.3"
     hooks:
-      - id: prettier
-        # Temporary excludes so we can gradually normalize the formatting
-        exclude: >
-          (?x)^(
-            .*\.md$|
-            examples/other/some.j2.yaml|
-            examples/playbooks/collections/.*|
-            examples/playbooks/example.yml|
-            examples/playbooks/invalid-transform.yml|
-            examples/playbooks/multiline-brackets.*|
-            examples/playbooks/templates/not-valid.yaml|
-            examples/playbooks/vars/empty.transformed.yml|
-            examples/playbooks/vars/empty.yml|
-            examples/playbooks/with-skip-tag-id.yml|
-            examples/playbooks/with-umlaut-.*|
-            examples/yamllint/.*|
-            src/ansiblelint/schemas/(molecule|tasks|playbook|rulebook|pattern).json|
-            test/fixtures/formatting-before/.*|
-            test/schemas/(negative_test|test)/.*\.md|
-            test/schemas/data/.*|
-            src/ansiblelint/schemas/ansible-navigator-config.json
-          )$
-        always_run: true
-        additional_dependencies:
-          - prettier@3.2.4
-          - prettier-plugin-sort-json@3.1.0
+      - id: biome-check
+        name: biome
+        alias: biome
+        args: [--unsafe]
   - repo: https://github.com/streetsidesoftware/cspell-cli
     rev: v9.2.0
     hooks:
@@ -177,11 +154,6 @@ repos:
       - id: toml-sort-fix
         alias: toml
 
-  - repo: https://github.com/tox-dev/tox-ini-fmt
-    rev: 1.6.0
-    hooks:
-      - id: tox-ini-fmt
-
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.12.11
     hooks:

.sonarlint/connectedMode.json

@@ -1,4 +1,4 @@
 {
-  "sonarCloudOrganization": "ansible",
-  "projectKey": "ansible_ansible-lint"
+  "projectKey": "ansible_ansible-lint",
+  "sonarCloudOrganization": "ansible"
 }

.vscode/extensions.json

@@ -1,8 +1,9 @@
 {
   "recommendations": [
+    "biomejs.biome",
     "Tyriar.sort-lines",
     "charliermarsh.ruff",
-    "esbenp.prettier-vscode",
+    "github.vscode-github-actions",
     "hbenl.vscode-test-explorer",
     "ms-python.mypy-type-checker",
     "ms-python.pylint",
@@ -17,5 +18,8 @@
     "timonwong.shellcheck",
     "znck.grammarly"
   ],
-  "unwantedRecommendations": ["tamasfe.even-better-toml"]
+  "unwantedRecommendations": [
+    "esbenp.prettier-vscode",
+    "tamasfe.even-better-toml"
+  ]
 }

.vscode/settings.json

@@ -1,6 +1,9 @@
 {
+  "[json]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
   "[markdown]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
+    "editor.defaultFormatter": "biomejs.biome"
   },
   "[python]": {
     "editor.codeActionsOnSave": {
@@ -13,14 +16,20 @@
   "[toml]": {
     "editor.defaultFormatter": "tombi-toml.tombi"
   },
+  "editor.codeActionsOnSave": {
+    "source.action.useSortedKeys.biome": "explicit",
+    "source.fixAll.biome": "always",
+    "source.organizeImports.biome": "explicit"
+  },
+  "editor.defaultFormatter": "biomejs.biome",
   "editor.formatOnSave": true,
   "evenBetterToml.formatter.alignComments": false,
   "evenBetterToml.formatter.arrayTrailingComma": true,
   "files.exclude": {
-    "*.egg-info": true,
+    "__pycache__": true,
     ".pytest_cache": true,
     ".tox": true,
-    "__pycache__": true,
+    "*.egg-info": true,
     "build": true
   },
   "git.ignoreLimitWarning": true,

biome.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "https://biomejs.dev/schemas/latest/schema.json",
+  "assist": {
+    "actions": {
+      "source": {
+        "useSortedKeys": "on"
+      }
+    }
+  },
+  "files": {
+    "includes": [
+      "**",
+      "!src/ansiblelint/schemas",
+      "!docs/_static/theme_overrides.css",
+      "!test/schemas/negative_test",
+      "!examples/**/pattern.json"
+    ]
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space"
+  },
+  "json": {
+    "formatter": {
+      "enabled": true,
+      "indentStyle": "space"
+    }
+  },
+  "vcs": {
+    "clientKind": "git",
+    "enabled": true,
+    "useIgnoreFile": true
+  }
+}

test/schemas/.mocharc.json

@@ -1,11 +1,11 @@
 {
   "colors": true,
   "extensions": ["ts"],
-  "require": "ts-node/register",
   "node-option": [
     "experimental-specifier-resolution=node",
     "loader=ts-node/esm"
   ],
+  "require": "ts-node/register",
   "slow": "500",
   "spec": "src/**/*.spec.ts"
 }

test/schemas/package.json

@@ -6,11 +6,6 @@
     "ts-node": "^10.9.2",
     "vscode-json-languageservice": "^5.6.1"
   },
-  "scripts": {
-    "compile": "tsc",
-    "deps": "npx --yes npm-check-updates -u && npm install --ignore-scripts",
-    "test": "python3 src/rebuild.py && mocha"
-  },
   "devDependencies": {
     "@types/chai": "^5.2.2",
     "@types/js-yaml": "^4.0.9",
@@ -25,5 +20,10 @@
   "directories": {
     "test": "./src"
   },
+  "scripts": {
+    "compile": "tsc",
+    "deps": "npx --yes npm-check-updates -u && npm install --ignore-scripts",
+    "test": "python3 src/rebuild.py && mocha"
+  },
   "type": "module"
 }

test/schemas/src/schema.spec.ts

@@ -1,12 +1,14 @@
-import * as path from "path";
-import fs from "fs";
-import { minimatch } from "minimatch";
-import yaml from "js-yaml";
+import { spawnSync } from "node:child_process";
+import fs from "node:fs";
+import * as path from "node:path";
+import Ajv2020 from "ajv/dist/2020";
+import draft7MetaSchema from "ajv/dist/refs/json-schema-draft-07.json" with {
+  type: "json",
+};
 import { assert } from "chai";
+import yaml from "js-yaml";
+import { minimatch } from "minimatch";
 import stringify from "safe-stable-stringify";
-import { spawnSync } from "child_process";
-import Ajv2020 from "ajv/dist/2020";
-import draft7MetaSchema from "ajv/dist/refs/json-schema-draft-07.json" with { type: "json" };
 
 function ansiRegex({ onlyFirst = false } = {}) {
   const pattern = [
@@ -20,17 +22,17 @@ function ansiRegex({ onlyFirst = false } = {}) {
 function stripAnsi(data: string) {
   if (typeof data !== "string") {
     throw new TypeError(
-      `Expected a \`string\`, got \`${typeof data}\ = ${data}`,
+      `Expected a \`string\`, got \`${typeof data} = ${data}`,
     );
   }
   return data.replace(ansiRegex(), "");
 }
 
 const ajv = new Ajv2020({
-  strictTypes: false,
-  strict: false,
-  inlineRefs: true, // https://github.com/ajv-validator/ajv/issues/1581#issuecomment-832211568
   allErrors: true, // https://github.com/ajv-validator/ajv/issues/1581#issuecomment-832211568
+  inlineRefs: true, // https://github.com/ajv-validator/ajv/issues/1581#issuecomment-832211568
+  strict: false,
+  strictTypes: false,
 });
 ajv.addMetaSchema(draft7MetaSchema);
 
@@ -44,7 +46,7 @@ const schema_files = fs
   .filter((el) => path.extname(el) === ".json");
 console.log(`Schemas: ${schema_files}`);
 
-describe("schemas under f/", function () {
+describe("schemas under f/", () => {
   schema_files.forEach((schema_file) => {
     if (
       schema_file.startsWith("_") ||
@@ -56,20 +58,21 @@ describe("schemas under f/", function () {
     ajv.addSchema(schema_json);
     const validator = ajv.compile(schema_json);
     if (
-      schema_json["examples"] == undefined &&
-      schema_json["x-ansible-lint"] == undefined
+      schema_json.examples === undefined &&
+      schema_json["x-ansible-lint"] === undefined
     ) {
       console.error(
         `Schema file ${schema_file} is missing an 'examples' or 'x-ansible-lint' key that we need for documenting file matching patterns.`,
       );
-      return process.exit(1);
+      process.exit(1);
+      return;
     }
-    describe(schema_file, function () {
+    describe(schema_file, () => {
       const file_path_key =
-        schema_json["x-ansible-lint"] || schema_json["examples"];
+        schema_json["x-ansible-lint"] || schema_json.examples;
       getTestFiles(file_path_key).forEach(
         ({ file: test_file, expect_fail }) => {
-          it(`linting ${test_file} using ${schema_file}`, function () {
+          it(`linting ${test_file} using ${schema_file}`, () => {
             var errors_md = "";
             const result = validator(
               yaml.load(fs.readFileSync(test_file, "utf8")),
@@ -86,9 +89,9 @@ describe("schemas under f/", function () {
             // and breaks usage from inside virtualenvs.
             const proc = spawnSync(
               `${process.env.VIRTUAL_ENV}/bin/check-jsonschema -v -o json --schemafile f/${schema_file} ${test_file}`,
-              { shell: true, encoding: "utf-8", stdio: "pipe" },
+              { encoding: "utf-8", shell: true, stdio: "pipe" },
             );
-            if (proc.status != 0) {
+            if (proc.status !== 0) {
               // real errors are sent to stderr due to https://github.com/python-jsonschema/check-jsonschema/issues/88
               errors_md += "# check-jsonschema\n\nstdout:\n\n```json\n";
               errors_md += stripAnsi(proc.output[1] || "");
@@ -106,8 +109,8 @@ describe("schemas under f/", function () {
               fs.writeFileSync(md_filename, errors_md);
             } else {
               // if no error occurs, we should ensure there is no md file present
-              fs.unlink(md_filename, function (err) {
-                if (err && err.code != "ENOENT") {
+              fs.unlink(md_filename, (err) => {
+                if (err && err.code !== "ENOENT") {
                   console.error(`Failed to remove ${md_filename}.`);
                 }
               });
@@ -123,17 +126,18 @@ describe("schemas under f/", function () {
       // All /$defs/ that have examples property are assumed to be
       // subschemas, "tasks" being the primary such case, which is also used
       // for validating separated files.
-      for (var definition in schema_json["$defs"]) {
-        if (schema_json["$defs"][definition].examples) {
-          const subschema_uri = `${schema_json["$id"]}#/$defs/${definition}`;
+      for (var definition in schema_json.$defs) {
+        if (schema_json.$defs[definition].examples) {
+          const subschema_uri = `${schema_json.$id}#/$defs/${definition}`;
           const subschema_validator = ajv.getSchema(subschema_uri);
           if (!subschema_validator) {
             console.error(`Failed to load subschema ${subschema_uri}`);
-            return process.exit(1);
+            process.exit(1);
+            return;
           }
-          getTestFiles(schema_json["$defs"][definition].examples).forEach(
+          getTestFiles(schema_json.$defs[definition].examples).forEach(
             ({ file: test_file, expect_fail }) => {
-              it(`linting ${test_file} using ${subschema_uri}`, function () {
+              it(`linting ${test_file} using ${subschema_uri}`, () => {
                 const result = subschema_validator(
                   yaml.load(fs.readFileSync(test_file, "utf8")),
                 );
@@ -157,25 +161,23 @@ function getTestFiles(
 ): { file: string; expect_fail: boolean }[] {
   const files = Array.from(
     new Set(
-      globs
-        .map((glob: any) => minimatch.match(test_files, path.join("**", glob)))
-        .flat(),
+      globs.flatMap((glob: any) =>
+        minimatch.match(test_files, path.join("**", glob)),
+      ),
     ),
   );
   const negative_files = Array.from(
     new Set(
-      globs
-        .map((glob: any) =>
-          minimatch.match(negative_test_files, path.join("**", glob)),
-        )
-        .flat(),
+      globs.flatMap((glob: any) =>
+        minimatch.match(negative_test_files, path.join("**", glob)),
+      ),
     ),
   );
 
   // All fails ending with fail, like `foo.fail.yml` are expected to fail validation
-  let result = files.map((f) => ({ file: f, expect_fail: false }));
+  let result = files.map((f) => ({ expect_fail: false, file: f }));
   result = result.concat(
-    negative_files.map((f) => ({ file: f, expect_fail: true })),
+    negative_files.map((f) => ({ expect_fail: true, file: f })),
   );
   return result;
 }