Upgrading haml_lint improved passing whitespaces from HAML to RuboCop
which triggered a couple of offenses.

Let's disable the rule for now, upgrade, and fix them later.

Upgrading haml_lint improved passing whitespaces from HAML to RuboCop
which triggered a couple of offenses.

Let's disable the rule for now, upgrade, and fix them later.

Enforce `safe_format` for externalized strings with interpolations and
`.html_safe`.

  # bad
  _('string %{open}foo%{close}').html_safe % { open: '<b>'.html_safe, close: '</b>'.html_safe }
  format(_('string %{open}foo%{close}').html_safe, open: '<b>'.html_safe, close: '</b>'.html_safe)

  # good
  safe_format(_('string %{open}foo%{close}'), tag_pair(tag.b, :open, :close)
  # also good no `html_safe`
  format(_('string %{var} number'), var: var)

This update fixes a confusing error in
https://gitlab.com/gitlab-org/gitlab/-/jobs/5708107258 when
`--parallel` is used (https://github.com/sds/haml-lint/pull/413).

- move the check to the left a bit and allow developer
  to detect the issue quicker before danger.

- prefer data-driven approaches instead
  https://gitlab.com/groups/gitlab-org/-/epics/7374

Add files to RuboCop TODOs.

Done via:

1. Enable cop rule in haml-lint.yml
2. bundle exec haml-lint --parallel > todos
3. rg -r "    - '\$1.rb'" -o "^([^:]+)" todos | sort | uniq \
     >> .rubocop_todo/gitlab/feature_available_usage.yml
4. bundle exec rake rubocop:todo:generate[Gitlab/FeatureAvailableUsage]

Changelog: other

Changelog: other

This new rule will move us toward using helper methods instead, which is beneficial because:

1. The docs URL could change and then we have a broken link
2. The URL is not specific to the deployment where the message shows up
3. Helper methods are easier to grep for / change in the case of a large refactor

Closes https://gitlab.com/gitlab-org/gitlab/-/issues/378201

Changelog: other

Now picks up on .to_json calls and can autocorrect them to
Gitlab::Json calls, which are preferred.

Changelog: other

Changelog: other

Changelog: other

Changelog: other

Changelog: other

This simplifies the setup:
* Removes custom `require` in rake task
* Removes `require`s and `production?` guard in linter
* Adds `require` to .haml-lint.yml as suggested in HAML linter docs

Signed-off-by: Takuya Noguchi <takninnovationresearch@gmail.com>

Signed-off-by: Rémy Coutable <remy@rymai.me>

Signed-off-by: Takuya Noguchi <takninnovationresearch@gmail.com>

Signed-off-by: Takuya Noguchi <takninnovationresearch@gmail.com>

Signed-off-by: Takuya Noguchi <takninnovationresearch@gmail.com>

Signed-off-by: Takuya Noguchi <takninnovationresearch@gmail.com>

Signed-off-by: Takuya Noguchi <takninnovationresearch@gmail.com>

Signed-off-by: Takuya Noguchi <takninnovationresearch@gmail.com>

Signed-off-by: Takuya Noguchi <takninnovationresearch@gmail.com>

Signed-off-by: Takuya Noguchi <takninnovationresearch@gmail.com>

Signed-off-by: Takuya Noguchi <takninnovationresearch@gmail.com>

Signed-off-by: Takuya Noguchi <takninnovationresearch@gmail.com>

Signed-off-by: Takuya Noguchi <takninnovationresearch@gmail.com>

This new cop will ensure consistency in usage of the
`#feature_available?` method.

Signed-off-by: Rémy Coutable <remy@rymai.me>

Ensure using `User#can_read_all_resources?` or
`User#can_admin_all_resources?` instead of `User#admin?`

Add a pipeline job to test UI links to docs,
as links break when docs move, especially anchors
when headings change.

Contributes to https://gitlab.com/gitlab-org/gitlab/-/issues/208354

We want to validate if there are any broken links and dead anchors to
documentation pages.

Extra:
* Extract anchor generation logic into Gitlab::Utils::Markdown module

- make use of new cops and gitlab-styles updates

Also ensures we check Syntax with RuboCop, which is different.

Files in lib will be eager loaded and hence will require haml_lint to be
loaded. Since this is only a development dependency, we can't assume
this gem will be available in production, so it should never be loaded
in production.