Custom DevSkim rules (on yaml files) not showing in VSCode custom tab
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 1k
- Forks
- 131
- Avg merge
- 1m
- Merged PRs (30d)
- 1
Description
Describe the bug
I don't manage to get DevSkim custom rules to show up in the Problems Tab in VSCode. I wrote a json file containing:
To Reproduce
[{
"id": "TestRule",
"name": "Basic Test Rule",
"description": "A simple test rule.",
"applies_to": ["yaml"],
"tags": ["test"],
"patterns": [{
"pattern": "redirects",
"type": "regex",
"message": "Detected redirects."
}]
}]
When I run:
devskim analyze -I "C:\pathToTestFolder" -r "C:\pathToCustomDevSkimRules"
The output shows a match on my custom rule. However when I simply open the yaml file in VSCode nothing is shown in the Problems tab.
I also added this:
"MS-CST-E.vscode-devskim.rules.customRulesPaths": [
"C:\\pathToCustomDevSkimRules"
],
"MS-CST-E.vscode-devskim.logging.level": "debug",
Inside C:\Users\username\AppData\Roaming\VSCodium\User\settings.json. Other DevSkim rules do show up in the Problems tab.
Expected behavior
My custom rules to show up in the Problems tab in VSCode.
Versions(please complete the following information):
- OS: Windows 11
- Devskim Version: devskim 1.0.44+10b85ce690
Other
I saw https://github.com/microsoft/DevSkim/issues/300 and my file extensions are actually yaml.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the reported behavior with the custom rules path and YAML file: compare the CLI result with the VSCode Problems tab, using the issue's debug logging setting. The fix is complete when a matching custom rule appears in the Problems tab for the YAML file, while built-in rules continue to work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, vscode
- Domain
- devtools, security
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100