-
Notifications
You must be signed in to change notification settings - Fork 4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
dclint disable rule-name doesn't appear to be disabling rule-name #69
Comments
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 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 |
@zavoloklom Thank you for pointing that out. As I review the documentation, I do see that it mentions that the I affirmatively use delimiters for all of my YAML because, if for no other reason, so that yamllint doesn't produce a finding: https://yamllint.readthedocs.io/en/stable/rules.html#module-yamllint.rules.document_start I went to the YAML spec to see what it said: https://yaml.org/spec/1.2.2/#22-structures
(Today I Learned that So, to your question, I would be inclined to not include the document start notation ( I think that my interpretation is fairly pedantic and for most, a distinction without a difference. Personally -- and this is just a thought -- I would appreciate it if the document start and blank lines were ignored at the top of a file. If blank lines were not ignored, the following wouldn't be correct: ---
# dclint disable [...]
services:
[...] This may be confusing to some (including me). All of that said, it if your project and I respect your decisions about what to change or not change -- it's not my place to make any demands of you or your time. I want to reiterate, however, that you're doing an amazing job and I appreciate your time, your work, and your decision to contribute the fruits of your labor to the rest of the world. |
…ocess the first non-empty line ref: #69
…ocess the first non-empty line ref: #69
…ocess the first non-empty line ref: #69
…ocess the first non-empty line ref: #69
@wesley-dean-flexion Thank you for sharing your detailed feedback and insights - it’s incredibly valuable to me. I appreciate the time and effort you’ve taken to explore the nuances of YAML and share your perspective. I’ve addressed this issue in version 2.2.1 of the project. I hope this resolves any confusion and improves the user experience. Once again, thank you for your comments and support. It’s feedback like yours that helps refine and improve the tool for everyone. If you notice anything else or have further suggestions, don’t hesitate to reach out! |
🎉 This issue has been resolved in version 2.2.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Version
2.1.0
YAML file where the error occurs
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)
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.
The text was updated successfully, but these errors were encountered: