dclint disable rule-name doesn't appear to be disabling rule-name

[wesley-dean-flexion]

Version

2.1.0

YAML file where the error occurs

---
# dclint disable require-project-name-field
# name: "does_not_matter_commented_out"

Command used to run

dclint ./docker-compose.yml

Optional configuration (if different from the default)

n/a

Additional context

node: 20.18.1

Current behavior (console output)

# dclint --debug ./docker-compose.yml
[DEBUG] [CLI] Debug mode is ON
[DEBUG] [CLI] Arguments: {
  _: [],
  debug: true,
  recursive: false,
  r: false,
  fix: false,
  'fix-dry-run': false,
  fixDryRun: false,
  formatter: 'stylish',
  f: 'stylish',
  quiet: false,
  q: false,
  color: true,
  exclude: [],
  e: [],
  'max-warnings': -1,
  maxWarnings: -1,
  '$0': 'dclint',
  files: [ './docker-compose.yml' ]
}
[DEBUG] [CONFIG] Configuration file not found. Using default
[DEBUG] [CLI] Final config: { rules: {}, quiet: false, debug: true, exclude: [] }
[DEBUG] [UTIL] Looking for compose files in ./docker-compose.yml
[DEBUG] [UTIL] Paths to exclude: node_modules,.git,.idea,.tsimp
[DEBUG] [UTIL] Found compose files in ./docker-compose.yml: ./docker-compose.yml
[DEBUG] [LINTER] Compose files for linting: ./docker-compose.yml
[DEBUG] [LINTER] Linting file: ./docker-compose.yml
[DEBUG] [LINTER] Linting result: [{"filePath":"./docker-compose.yml","messages":[{"rule":"require-project-name-field","type":"warning","category":"best-practice","severity":"minor","message":"The \"name\" field should be present.","line":1,"column":1,"meta":{"description":"Ensure that the \"name\" field is present in the Docker Compose file.","url":"https://github.com/zavoloklom/docker-compose-linter/blob/main/docs/rules/require-project-name-field-rule.md"},"fixable":false}],"errorCount":0,"warningCount":1,"fixableErrorCount":0,"fixableWarningCount":0}]
[DEBUG] [UTIL] Using built-in formatter: stylish

/path/to/docker-compose.yml
   1:1     warning  The "name" field should be present.  require-project-name-field

✖ 1 problems (0 errors, 1 warnings)

Expected behavior

(i.e., no output because no errors or warnings were found)

Praise

I stumbled upon dclint and I was immediately impressed by the frequency of updates, the list of PRs being clean the inclusion of linters in .github/workflows, the quality of the documentation, the use of common patterns to enable/disable rules, produce output, and so on. This looks like a model project and I don't know how I haven't seen it before.

I've contributed a few things to https://github.com/oxsecurity/megalinter and my first thought was to investigate including it in the list of linters MegaLinter supports. See oxsecurity/megalinter#4381

This isn't related to the bug report -- I just wanted to express my appreciation.

Thank you for all of your efforts and hard work.

[zavoloklom]

@wesley-dean-flexion Hi!

First of all, thank you so much for the feedback, I really appreciate it and it means a lot.

Regarding the bug:

The dclint disable instruction only works on the first line, so it should look like this:

# dclint disable require-project-name-field
---
# name: "does_not_matter_commented_out"

I personally rarely use delimiters, so I’d be glad to hear your advice — should I configure the search to ignore --- and treat the comment after it as the first line, or is the way I described above also convenient?