Skip to content

Commit 81a390b

Browse files
committed
docs: add TypeScript instructions for VSCode extension development
1 parent f2eb1e7 commit 81a390b

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
applyTo: '**/*.ts'
3+
---
4+
5+
You are building a VSCode Extension that integrates with CodeQL to scan code for vulnerabilities.
6+
The extension provides functionality to scan code for vulnerabilities using CodeQL.
7+
8+
Always use the logging functionality provided by the extension's `logger` module for consistent logging across the extension.
9+
Always log actions that modify the state of the extension, such as configuration changes, CLI path updates, or user interactions.
10+
11+
## Testing
12+
13+
Always write unit tests for new features or bug fixes using the testing framework already set up in the project.
14+
Tests should be placed in the `tests` directory and follow the naming convention of the files they are testing.
15+
16+
## Documentation
17+
18+
Always add or update functions or inline comments to ensure the code is well-documented.
19+
20+
## Changelog
21+
22+
Update the `CHANGELOG.md` file with a new entry for this unknown version, following the existing format.
23+
24+
- Add a new entry for this version with the date and a brief description of changes
25+
- Ensure the changelog entry is formatted correctly with markdown syntax

0 commit comments

Comments
 (0)