Support disabling lint rules by name with a --disable/-d option

Signed-off-by: Juan Cruz Viotti <jv@jviotti.com>

Author: jviotti

DEPENDENCIES

@@ -1,5 +1,5 @@
 vendorpull https://github.com/sourcemeta/vendorpull dea311b5bfb53b6926a4140267959ae334d3ecf4
-core https://github.com/sourcemeta/core 64063dc926a074dd9b7add8478d891dd39a8fc9f
+core https://github.com/sourcemeta/core 639d617d927709d8a58a7c88fa2aaeee5ded0f7f
 hydra https://github.com/sourcemeta/hydra a67b879df800e834ed8a2d056f98398f7211d870
 jsonbinpack https://github.com/sourcemeta/jsonbinpack c7bb7f4d903c3b6925b62ce2bb5b8d360e01ce84
 blaze https://github.com/sourcemeta/blaze a453075f2013ea8fc27d0dded1da6521dbc8474e

docs/lint.markdown

@@ -4,7 +4,7 @@ Linting
 ```sh
 jsonschema lint [schemas-or-directories...]
   [--fix/-f] [--json/-j] [--verbose/-v] [--extension/-e <extension>]
-  [--ignore/-i <schemas-or-directories>]
+  [--ignore/-i <schemas-or-directories>] [--disable/-d <rule-name>]
 ```
 
 JSON Schema is a surprisingly expressive schema language. Like with traditional
@@ -61,6 +61,13 @@ result in the JSON Schema CLI *automatically* fixing the warning for you.
 ```sh
 jsonschema lint path/to/my/schema_1.json path/to/my/schema_2.json
 ```
+
+### Lint while disabling certain rules
+
+```sh
+jsonschema lint path/to/my/schema.json --disable enum_with_type --disable const_with_type
+```
+
 ### Lint with JSON output
 
 ```sh

src/command_lint.cc

@@ -11,6 +11,21 @@
 #include "command.h"
 #include "utils.h"
 
+template <typename Options, typename Iterator>
+static auto disable_lint_rules(sourcemeta::core::SchemaTransformer &bundle,
+                               const Options &options, Iterator first,
+                               Iterator last) -> void {
+  for (auto iterator = first; iterator != last; ++iterator) {
+    if (bundle.remove(*iterator)) {
+      sourcemeta::jsonschema::cli::log_verbose(options)
+          << "Disabling rule: " << *iterator << "\n";
+    } else {
+      sourcemeta::jsonschema::cli::log_verbose(options)
+          << "warning: Cannot disable unknown rule: " << *iterator << "\n";
+    }
+  }
+}
+
 auto sourcemeta::jsonschema::cli::lint(
     const std::span<const std::string> &arguments) -> int {
   const auto options{parse_options(arguments, {"f", "fix", "json", "j"})};
@@ -28,6 +43,16 @@ auto sourcemeta::jsonschema::cli::lint(
   sourcemeta::core::add(bundle,
                         sourcemeta::core::AlterSchemaCategory::SyntaxSugar);
 
+  if (options.contains("disable")) {
+    disable_lint_rules(bundle, options, options.at("disable").cbegin(),
+                       options.at("disable").cend());
+  }
+
+  if (options.contains("d")) {
+    disable_lint_rules(bundle, options, options.at("d").cbegin(),
+                       options.at("d").cend());
+  }
+
   bool result{true};
   auto errors_array = sourcemeta::core::JSON::make_array();
 

src/main.cc

@@ -53,6 +53,7 @@ Global Options:
 
    lint [schemas-or-directories...] [--fix/-f] [--json/-j]
         [--extension/-e <extension>] [--ignore/-i <schemas-or-directories>]
+        [--disable/-d <rule-name>]
 
        Lint the input schemas and potentially fix the reported issues.
        The --fix/-f option is not supported when passing YAML schemas.

test/CMakeLists.txt

@@ -179,6 +179,10 @@ add_jsonschema_test_unix(lint/fail_lint_json)
 add_jsonschema_test_unix(lint/pass_lint_json)
 add_jsonschema_test_unix(lint/pass_lint_fix_json)
 add_jsonschema_test_unix(lint/fail_bigint)
+add_jsonschema_test_unix(lint/fail_lint_disable_one)
+add_jsonschema_test_unix(lint/fail_lint_disable_one_verbose)
+add_jsonschema_test_unix(lint/fail_lint_disable_unknown_verbose)
+add_jsonschema_test_unix(lint/fail_lint_disable_many)
 
 # Encode
 add_jsonschema_test_unix(encode/pass_schema_less)

test/lint/fail_lint_disable_many.sh

@@ -0,0 +1,28 @@
+#!/bin/sh
+
+set -o errexit
+set -o nounset
+
+TMP="$(mktemp -d)"
+clean() { rm -rf "$TMP"; }
+trap clean EXIT
+
+cat << 'EOF' > "$TMP/schema.json"
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "string",
+  "contentMediaType": "application/json",
+  "enum": [ "foo" ]
+}
+EOF
+
+"$1" lint "$TMP/schema.json" --disable enum_to_const -d enum_with_type >"$TMP/stderr.txt" 2>&1 && CODE="$?" || CODE="$?"
+test "$CODE" = "1" || exit 1
+
+cat << EOF > "$TMP/expected.txt"
+$(realpath "$TMP")/schema.json:
+  The \`contentMediaType\` keyword is meaningless without the presence of the \`contentEncoding\` keyword (content_media_type_without_encoding)
+    at schema location ""
+EOF
+
+diff "$TMP/stderr.txt" "$TMP/expected.txt"

test/lint/fail_lint_disable_one.sh

@@ -0,0 +1,31 @@
+#!/bin/sh
+
+set -o errexit
+set -o nounset
+
+TMP="$(mktemp -d)"
+clean() { rm -rf "$TMP"; }
+trap clean EXIT
+
+cat << 'EOF' > "$TMP/schema.json"
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "string",
+  "contentMediaType": "application/json",
+  "enum": [ "foo" ]
+}
+EOF
+
+"$1" lint "$TMP/schema.json" --disable enum_to_const >"$TMP/stderr.txt" 2>&1 && CODE="$?" || CODE="$?"
+test "$CODE" = "1" || exit 1
+
+cat << EOF > "$TMP/expected.txt"
+$(realpath "$TMP")/schema.json:
+  The \`contentMediaType\` keyword is meaningless without the presence of the \`contentEncoding\` keyword (content_media_type_without_encoding)
+    at schema location ""
+$(realpath "$TMP")/schema.json:
+  Setting \`type\` alongside \`enum\` is considered an anti-pattern, as the enumeration choices already imply their respective types (enum_with_type)
+    at schema location ""
+EOF
+
+diff "$TMP/stderr.txt" "$TMP/expected.txt"

test/lint/fail_lint_disable_one_verbose.sh

@@ -0,0 +1,33 @@
+#!/bin/sh
+
+set -o errexit
+set -o nounset
+
+TMP="$(mktemp -d)"
+clean() { rm -rf "$TMP"; }
+trap clean EXIT
+
+cat << 'EOF' > "$TMP/schema.json"
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "string",
+  "contentMediaType": "application/json",
+  "enum": [ "foo" ]
+}
+EOF
+
+"$1" lint "$TMP/schema.json" --verbose --disable enum_to_const >"$TMP/stderr.txt" 2>&1 && CODE="$?" || CODE="$?"
+test "$CODE" = "1" || exit 1
+
+cat << EOF > "$TMP/expected.txt"
+Disabling rule: enum_to_const
+Linting: $(realpath "$TMP")/schema.json
+$(realpath "$TMP")/schema.json:
+  The \`contentMediaType\` keyword is meaningless without the presence of the \`contentEncoding\` keyword (content_media_type_without_encoding)
+    at schema location ""
+$(realpath "$TMP")/schema.json:
+  Setting \`type\` alongside \`enum\` is considered an anti-pattern, as the enumeration choices already imply their respective types (enum_with_type)
+    at schema location ""
+EOF
+
+diff "$TMP/stderr.txt" "$TMP/expected.txt"

test/lint/fail_lint_disable_unknown_verbose.sh

@@ -0,0 +1,36 @@
+#!/bin/sh
+
+set -o errexit
+set -o nounset
+
+TMP="$(mktemp -d)"
+clean() { rm -rf "$TMP"; }
+trap clean EXIT
+
+cat << 'EOF' > "$TMP/schema.json"
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "string",
+  "contentMediaType": "application/json",
+  "enum": [ "foo" ]
+}
+EOF
+
+"$1" lint "$TMP/schema.json" --verbose --disable foo_bar >"$TMP/stderr.txt" 2>&1 && CODE="$?" || CODE="$?"
+test "$CODE" = "1" || exit 1
+
+cat << EOF > "$TMP/expected.txt"
+warning: Cannot disable unknown rule: foo_bar
+Linting: $(realpath "$TMP")/schema.json
+$(realpath "$TMP")/schema.json:
+  The \`contentMediaType\` keyword is meaningless without the presence of the \`contentEncoding\` keyword (content_media_type_without_encoding)
+    at schema location ""
+$(realpath "$TMP")/schema.json:
+  An \`enum\` of a single value can be expressed as \`const\` (enum_to_const)
+    at schema location ""
+$(realpath "$TMP")/schema.json:
+  Setting \`type\` alongside \`enum\` is considered an anti-pattern, as the enumeration choices already imply their respective types (enum_with_type)
+    at schema location ""
+EOF
+
+diff "$TMP/stderr.txt" "$TMP/expected.txt"