Issue extending web-recommended and configuring http-compressions

[molant]

Original report by @jgarber623:

This configuration works, but doesn't include any rule customization:

{
  "extends": [
    "web-recommended"
  ],
  "formatters": [
    "codeframe"
  ],
  "ignoredUrls": [
    {
      "domain": ".*\\.googleapis\\.com/.*",
      "rules": ["*"]
    }
  ]
}

This configuration does not work:

{
  "extends": [
    "web-recommended"
  ],
  "formatters": [
    "codeframe"
  ],
  "rules": {
    "http-compression": ["warning", {
      "html": {
        "brotli": false
      }
    }]
  },
  "ignoredUrls": [
    {
      "domain": ".*\\.googleapis\\.com/.*",
      "rules": ["*"]
    }
  ]
}

The error message shown is "Invalid rule configuration in .sonarwhalrc: http-compression."

My goal is to silence errors/warnings about using Brotli and Zopfli compression.

[molant]

The following works:

{
  "extends": [
    "web-recommended"
  ],
  "formatters": [
    "codeframe"
  ],
  "rules": {
    "http-compression": "off"
  },
  "ignoredUrls": [
    {
      "domain": ".*\\.googleapis\\.com/.*",
      "rules": ["*"]
    }
  ]
}

so it looks like a problem when merging the rule configurations options with the extends part.

[molant]

I've created #907 to fix this issue. If you don't want to wait until things are merged and published on npm you can change html with target in your configuration and it should work.

[alrra]

@jgarber623 We published a new version of the http-compression rule. So, the easiest way to get it is to just run npm i @sonarwhal/configuration-web-recommended.

Thanks again for taking the time to let us know!

[jgarber623]

Thanks, @molant and @alrra! Those updates did the trick.

For future travelers, my updated config works great and now looks like:

{
  "extends": [
    "web-recommended"
  ],
  "formatters": [
    "codeframe"
  ],
  "rules": {
    "http-compression": ["warning", {
      "html": {
        "brotli": false,
        "zopfli": false
      },
      "resource": {
        "brotli": false,
        "zopfli": false
      }
    }]
  },
  "ignoredUrls": [
    {
      "domain": ".*\\.googleapis\\.com/.*",
      "rules": ["*"]
    }
  ]
}