gitlab-org--gitlab-foss/.haml-lint.yml

inherits_from:
  - .haml-lint_todo.yml
# Whether to ignore frontmatter at the beginning of HAML documents for
# frameworks such as Jekyll/Middleman
skip_frontmatter: false
exclude:
  - 'vendor/**/*'
  - 'spec/**/*'
  - 'ee/spec/**/*'
require:
  - './haml_lint/linter/documentation_links.rb'
  - './haml_lint/linter/inline_javascript.rb'
  - './haml_lint/linter/no_plain_nodes.rb'

linters:
  AltText:
    enabled: true

  ClassAttributeWithStaticValue:
    enabled: true

  ClassesBeforeIds:
    enabled: false

  ConsecutiveComments:
    enabled: false

  ConsecutiveSilentScripts:
    enabled: false
    max_consecutive: 2

  DocumentationLinks:
    enabled: true
    include:
      - 'app/views/**/*.haml'
      - 'ee/app/views/**/*.haml'

  EmptyObjectReference:
    enabled: true

  EmptyScript:
    enabled: true

  FinalNewline:
    enabled: true
    present: true

  HtmlAttributes:
    enabled: true

  IdNames:
    enabled: false

  ImplicitDiv:
    enabled: true

  InlineJavaScript:
    enabled: true

  InlineStyles:
    enabled: false

  InstanceVariables:
    enabled: false

  LeadingCommentSpace:
    enabled: false

  LineLength:
    enabled: false
    max: 80

  MultilinePipe:
    enabled: true

  MultilineScript:
    enabled: true

  ObjectReferenceAttributes:
    enabled: true

  RepeatedId:
    enabled: false

  RuboCop:
    enabled: true
    ignored_cops:
      # These cops are incredibly noisy when it comes to HAML templates, so we
      # ignore them.
      - Layout/BlockAlignment
      - Layout/EndAlignment
      - Layout/LineLength
      - Lint/Void
      - Naming/FileName
      - Style/AlignParameters
      - Style/BlockNesting
      - Style/ElseAlignment
      - Style/FileName
      - Style/FinalNewline
      - Style/FrozenStringLiteralComment
      - Style/IfUnlessModifier
      - Style/IndentationWidth
      - Style/Next
      - Style/SoleNestedConditional
      - Style/TrailingWhitespace
      - Style/WhileUntilModifier
      - Cop/StaticTranslationDefinition

      # These cops should eventually get enabled
      - Cop/LineBreakAfterGuardClauses
      - Cop/ProjectPathHelper
      - Gitlab/FeatureAvailableUsage
      - GitlabSecurity/PublicSend
      - Layout/EmptyLineAfterGuardClause
      - Layout/LeadingCommentSpace
      - Layout/SpaceAroundOperators
      - Layout/SpaceBeforeComma
      - Layout/SpaceBeforeFirstArg
      - Layout/SpaceInsideHashLiteralBraces
      - Layout/SpaceInsideStringInterpolation
      - Layout/TrailingEmptyLines
      - Lint/LiteralInInterpolation
      - Lint/ParenthesesAsGroupedExpression
      - Lint/SafeNavigationConsistency
      - Metrics/BlockNesting
      - Naming/VariableName
      - Performance/RedundantMatch
      - Performance/StringReplacement
      - Rails/LinkToBlank
      - Rails/RequestReferer
      - Style/ColonMethodCall
      - Style/ConditionalAssignment
      - Style/FormatString
      - Style/HashSyntax
      - Style/IfInsideElse
      - Style/IdenticalConditionalBranches
      - Style/NegatedIf
      - Style/NestedTernaryOperator
      - Style/RedundantInterpolation
      - Style/SelfAssignment
      - Style/StringConcatenation
      - Style/TernaryParentheses
      - Style/TrailingCommaInHashLiteral
      - Style/UnlessElse
      - Style/UnneededCondition
      - Style/WordArray
      - Style/ZeroLengthPredicate

      # WIP See https://gitlab.com/gitlab-org/gitlab/-/issues/207950
      - Cop/UserAdmin

  RubyComments:
    enabled: true

  SpaceBeforeScript:
    enabled: true

  SpaceInsideHashAttributes:
    enabled: true
    style: space

  Syntax:
    enabled: true

  Indentation:
    enabled: true
    character: space  # or tab

  TagName:
    enabled: true

  TrailingWhitespace:
    enabled: true

  UnnecessaryInterpolation:
    enabled: true

  UnnecessaryStringOutput:
    enabled: true

  ViewLength:
    enabled: false
Add HamlLint::Linter::NoPlainNodes linter Add a simple haml_lint linter to report all plain nodes. "Plain nodes" in HAML are scritpless plaintext leaf nodes. Add haml-lint_todo to onboard new haml linters. Excludes existing NoPlainNodes lints. 2019-04-23 15:04:11 -04:00			`inherits_from:`
			`- .haml-lint_todo.yml`
Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00			`# Whether to ignore frontmatter at the beginning of HAML documents for`
			`# frameworks such as Jekyll/Middleman`
			`skip_frontmatter: false`
			`exclude:`
			`- 'vendor/*/'`
Improve .haml-lint.yml, simplify the haml_lint task and remove CHANGELOG entry Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-13 12:56:00 -04:00			`- 'spec/*/'`
Add latest changes from gitlab-org/gitlab@master 2021-11-01 05:13:14 -04:00			`- 'ee/spec/*/'`
Add HamlLint::Linter::NoPlainNodes linter Add a simple haml_lint linter to report all plain nodes. "Plain nodes" in HAML are scritpless plaintext leaf nodes. Add haml-lint_todo to onboard new haml linters. Excludes existing NoPlainNodes lints. 2019-04-23 15:04:11 -04:00			`require:`
Add latest changes from gitlab-org/gitlab@master 2020-07-15 14:09:09 -04:00			`- './haml_lint/linter/documentation_links.rb'`
Add latest changes from gitlab-org/gitlab@master 2022-05-06 02:07:56 -04:00			`- './haml_lint/linter/inline_javascript.rb'`
			`- './haml_lint/linter/no_plain_nodes.rb'`
Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00
			`linters:`
			`AltText:`
HAMLLint: Enable `AltText` rule 2016-12-22 04:30:00 -05:00			`enabled: true`
Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00
			`ClassAttributeWithStaticValue:`
HAMLLint: Enable `ClassAttributeWithStaticValue` rule 2016-12-22 05:57:04 -05:00			`enabled: true`
Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00
			`ClassesBeforeIds:`
			`enabled: false`

			`ConsecutiveComments:`
			`enabled: false`

			`ConsecutiveSilentScripts:`
			`enabled: false`
			`max_consecutive: 2`

Add latest changes from gitlab-org/gitlab@master 2020-07-15 14:09:09 -04:00			`DocumentationLinks:`
Add latest changes from gitlab-org/gitlab@master 2020-07-17 02:09:11 -04:00			`enabled: true`
Add latest changes from gitlab-org/gitlab@master 2020-07-15 14:09:09 -04:00			`include:`
			`- 'app/views/*/.haml'`
			`- 'ee/app/views/*/.haml'`

Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00			`EmptyObjectReference:`
			`enabled: true`

			`EmptyScript:`
			`enabled: true`

			`FinalNewline:`
HAMLLint: Enable `FinalNewline` rule 2016-12-22 06:43:11 -05:00			`enabled: true`
Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00			`present: true`

			`HtmlAttributes:`
HAMLLint: Enable `HtmlAttributes` rule 2016-12-22 07:21:27 -05:00			`enabled: true`
Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00
Upgrade haml_lint Gem to 0.26.0 2017-08-07 05:08:15 -04:00			`IdNames:`
			`enabled: false`

Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00			`ImplicitDiv:`
HAMLLint: Enable `ImplicitDiv` rule 2016-12-23 04:32:07 -05:00			`enabled: true`
Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00
Add custom linter for inline JavaScript to haml_lint (!9742) 2017-03-06 14:46:52 -05:00			`InlineJavaScript:`
			`enabled: true`

Upgrade haml_lint Gem to 0.26.0 2017-08-07 05:08:15 -04:00			`InlineStyles:`
			`enabled: false`

			`InstanceVariables:`
			`enabled: false`

Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00			`LeadingCommentSpace:`
			`enabled: false`

			`LineLength:`
			`enabled: false`
			`max: 80`

			`MultilinePipe:`
HAMLLint: Enable `MultilinePipe` rule 2017-01-16 10:07:03 -05:00			`enabled: true`
Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00
			`MultilineScript:`
			`enabled: true`

			`ObjectReferenceAttributes:`
			`enabled: true`

Upgrade haml_lint Gem to 0.26.0 2017-08-07 05:08:15 -04:00			`RepeatedId:`
			`enabled: false`

Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00			`RuboCop:`
Reject ruby interpolation in externalized strings When using ruby interpolation in externalized strings, they can't be detected. Which means they will never be presented to be translated. To mix variables into translations we need to use `sprintf` instead. Instead of: _("Hello #{subject}") Use: _("Hello %{subject}) % { subject: 'world' } 2018-08-16 08:15:54 -04:00			`enabled: true`
Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00			`ignored_cops:`
Add latest changes from gitlab-org/gitlab@master 2022-06-14 08:08:53 -04:00			`# These cops are incredibly noisy when it comes to HAML templates, so we`
			`# ignore them.`
Reject ruby interpolation in externalized strings When using ruby interpolation in externalized strings, they can't be detected. Which means they will never be presented to be translated. To mix variables into translations we need to use `sprintf` instead. Instead of: _("Hello #{subject}") Use: _("Hello %{subject}) % { subject: 'world' } 2018-08-16 08:15:54 -04:00			`- Layout/BlockAlignment`
			`- Layout/EndAlignment`
Add latest changes from gitlab-org/gitlab@master 2020-05-28 17:08:22 -04:00			`- Layout/LineLength`
Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00			`- Lint/Void`
Reject ruby interpolation in externalized strings When using ruby interpolation in externalized strings, they can't be detected. Which means they will never be presented to be translated. To mix variables into translations we need to use `sprintf` instead. Instead of: _("Hello #{subject}") Use: _("Hello %{subject}) % { subject: 'world' } 2018-08-16 08:15:54 -04:00			`- Naming/FileName`
Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00			`- Style/AlignParameters`
			`- Style/BlockNesting`
			`- Style/ElseAlignment`
			`- Style/FileName`
			`- Style/FinalNewline`
			`- Style/FrozenStringLiteralComment`
			`- Style/IfUnlessModifier`
			`- Style/IndentationWidth`
			`- Style/Next`
Add latest changes from gitlab-org/gitlab@master 2022-10-12 08:09:35 -04:00			`- Style/SoleNestedConditional`
Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00			`- Style/TrailingWhitespace`
			`- Style/WhileUntilModifier`
Add latest changes from gitlab-org/gitlab@master 2022-06-14 08:08:53 -04:00			`- Cop/StaticTranslationDefinition`
Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00
Reject ruby interpolation in externalized strings When using ruby interpolation in externalized strings, they can't be detected. Which means they will never be presented to be translated. To mix variables into translations we need to use `sprintf` instead. Instead of: _("Hello #{subject}") Use: _("Hello %{subject}) % { subject: 'world' } 2018-08-16 08:15:54 -04:00			`# These cops should eventually get enabled`
Add more HAML lint rules 2019-05-03 18:21:48 -04:00			`- Cop/LineBreakAfterGuardClauses`
Reject ruby interpolation in externalized strings When using ruby interpolation in externalized strings, they can't be detected. Which means they will never be presented to be translated. To mix variables into translations we need to use `sprintf` instead. Instead of: _("Hello #{subject}") Use: _("Hello %{subject}) % { subject: 'world' } 2018-08-16 08:15:54 -04:00			`- Cop/ProjectPathHelper`
Add latest changes from gitlab-org/gitlab@master 2021-03-29 14:09:37 -04:00			`- Gitlab/FeatureAvailableUsage`
Reject ruby interpolation in externalized strings When using ruby interpolation in externalized strings, they can't be detected. Which means they will never be presented to be translated. To mix variables into translations we need to use `sprintf` instead. Instead of: _("Hello #{subject}") Use: _("Hello %{subject}) % { subject: 'world' } 2018-08-16 08:15:54 -04:00			`- GitlabSecurity/PublicSend`
Add exceptions to HAML lint 2019-05-03 18:11:26 -04:00			`- Layout/EmptyLineAfterGuardClause`
Reject ruby interpolation in externalized strings When using ruby interpolation in externalized strings, they can't be detected. Which means they will never be presented to be translated. To mix variables into translations we need to use `sprintf` instead. Instead of: _("Hello #{subject}") Use: _("Hello %{subject}) % { subject: 'world' } 2018-08-16 08:15:54 -04:00			`- Layout/LeadingCommentSpace`
			`- Layout/SpaceAroundOperators`
			`- Layout/SpaceBeforeComma`
			`- Layout/SpaceBeforeFirstArg`
			`- Layout/SpaceInsideHashLiteralBraces`
			`- Layout/SpaceInsideStringInterpolation`
Add latest changes from gitlab-org/gitlab@master 2020-05-28 17:08:22 -04:00			`- Layout/TrailingEmptyLines`
Reject ruby interpolation in externalized strings When using ruby interpolation in externalized strings, they can't be detected. Which means they will never be presented to be translated. To mix variables into translations we need to use `sprintf` instead. Instead of: _("Hello #{subject}") Use: _("Hello %{subject}) % { subject: 'world' } 2018-08-16 08:15:54 -04:00			`- Lint/LiteralInInterpolation`
			`- Lint/ParenthesesAsGroupedExpression`
Add more HAML lint rules 2019-05-03 18:21:48 -04:00			`- Lint/SafeNavigationConsistency`
Reject ruby interpolation in externalized strings When using ruby interpolation in externalized strings, they can't be detected. Which means they will never be presented to be translated. To mix variables into translations we need to use `sprintf` instead. Instead of: _("Hello #{subject}") Use: _("Hello %{subject}) % { subject: 'world' } 2018-08-16 08:15:54 -04:00			`- Metrics/BlockNesting`
			`- Naming/VariableName`
			`- Performance/RedundantMatch`
			`- Performance/StringReplacement`
Add exceptions to HAML lint 2019-05-03 18:11:26 -04:00			`- Rails/LinkToBlank`
Reject ruby interpolation in externalized strings When using ruby interpolation in externalized strings, they can't be detected. Which means they will never be presented to be translated. To mix variables into translations we need to use `sprintf` instead. Instead of: _("Hello #{subject}") Use: _("Hello %{subject}) % { subject: 'world' } 2018-08-16 08:15:54 -04:00			`- Rails/RequestReferer`
			`- Style/ColonMethodCall`
			`- Style/ConditionalAssignment`
Add latest changes from gitlab-org/gitlab@master 2022-08-10 11:11:53 -04:00			`- Style/FormatString`
Reject ruby interpolation in externalized strings When using ruby interpolation in externalized strings, they can't be detected. Which means they will never be presented to be translated. To mix variables into translations we need to use `sprintf` instead. Instead of: _("Hello #{subject}") Use: _("Hello %{subject}) % { subject: 'world' } 2018-08-16 08:15:54 -04:00			`- Style/HashSyntax`
Add latest changes from gitlab-org/gitlab@master 2022-08-10 11:11:53 -04:00			`- Style/IfInsideElse`
Reject ruby interpolation in externalized strings When using ruby interpolation in externalized strings, they can't be detected. Which means they will never be presented to be translated. To mix variables into translations we need to use `sprintf` instead. Instead of: _("Hello #{subject}") Use: _("Hello %{subject}) % { subject: 'world' } 2018-08-16 08:15:54 -04:00			`- Style/IdenticalConditionalBranches`
			`- Style/NegatedIf`
			`- Style/NestedTernaryOperator`
Add latest changes from gitlab-org/gitlab@master 2022-08-10 11:11:53 -04:00			`- Style/RedundantInterpolation`
Reject ruby interpolation in externalized strings When using ruby interpolation in externalized strings, they can't be detected. Which means they will never be presented to be translated. To mix variables into translations we need to use `sprintf` instead. Instead of: _("Hello #{subject}") Use: _("Hello %{subject}) % { subject: 'world' } 2018-08-16 08:15:54 -04:00			`- Style/SelfAssignment`
Add latest changes from gitlab-org/gitlab@master 2022-08-10 08:12:15 -04:00			`- Style/StringConcatenation`
Reject ruby interpolation in externalized strings When using ruby interpolation in externalized strings, they can't be detected. Which means they will never be presented to be translated. To mix variables into translations we need to use `sprintf` instead. Instead of: _("Hello #{subject}") Use: _("Hello %{subject}) % { subject: 'world' } 2018-08-16 08:15:54 -04:00			`- Style/TernaryParentheses`
			`- Style/TrailingCommaInHashLiteral`
			`- Style/UnlessElse`
Add exceptions to HAML lint 2019-05-03 18:11:26 -04:00			`- Style/UnneededCondition`
Reject ruby interpolation in externalized strings When using ruby interpolation in externalized strings, they can't be detected. Which means they will never be presented to be translated. To mix variables into translations we need to use `sprintf` instead. Instead of: _("Hello #{subject}") Use: _("Hello %{subject}) % { subject: 'world' } 2018-08-16 08:15:54 -04:00			`- Style/WordArray`
			`- Style/ZeroLengthPredicate`

Add latest changes from gitlab-org/gitlab@master 2021-03-17 17:11:29 -04:00			`# WIP See https://gitlab.com/gitlab-org/gitlab/-/issues/207950`
			`- Cop/UserAdmin`

Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00			`RubyComments:`
HAMLLint: Enable `RubyComments` rule 2017-01-16 09:56:26 -05:00			`enabled: true`
Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00
			`SpaceBeforeScript:`
HAMLLint: Enable `SpaceBeforeScript` rule 2016-12-23 05:26:15 -05:00			`enabled: true`
Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00
			`SpaceInsideHashAttributes:`
HAMLLint: Enable `SpaceInsideHashAttributes` rule 2016-12-26 05:27:58 -05:00			`enabled: true`
Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00			`style: space`

Ensure haml-lint checks Syntax Also ensures we check Syntax with RuboCop, which is different. 2019-07-18 11:26:32 -04:00			`Syntax:`
			`enabled: true`

Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00			`Indentation:`
			`enabled: true`
#60818 Correct linting for project root *.yml files 2019-05-20 09:50:32 -04:00			`character: space # or tab`
Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00
			`TagName:`
			`enabled: true`

			`TrailingWhitespace:`
HAMLLint: Enable `TrailingWhitespace` rule 2016-12-23 06:48:23 -05:00			`enabled: true`
Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00
			`UnnecessaryInterpolation:`
HAMLLint: Enable `UnnecessaryInterpolation` rule 2017-01-13 11:05:51 -05:00			`enabled: true`
Add .haml-lint.yml Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-09-12 13:23:06 -04:00
			`UnnecessaryStringOutput:`
HAMLLint: Enable `UnnecessaryStringOutput` rule 2017-01-15 11:18:52 -05:00			`enabled: true`
Upgrade haml_lint Gem to 0.26.0 2017-08-07 05:08:15 -04:00
			`ViewLength:`
			`enabled: false`