Discourage use of editor/IDE specific code comments

Problem

GitLab contributors (team members, and wider community) use a variety set of editors and IDEs. Most editors can be configured by using code comments, for example # vim: , # language=YAML or # noinspection. Those directives can clutter the code and make it less readable.

Proposed solution

Discourage the use of editor/IDE specific code comments by using/create a 👮 rule to flag them.

List of directive to flag

  • # vim:
  • # language=X
  • # noinspection
  • ...

As an alternative, non-inline configuration can be used instead. E.g. a file configuration .projections.json.example.

Refs

Edited by 🤖 GitLab Bot 🤖