Skip to content

Commit 00cf29b

Browse files
committed
Improve prettier fix markdownlint required workflow
1 parent fee78b9 commit 00cf29b

File tree

8 files changed

+25
-20
lines changed

8 files changed

+25
-20
lines changed

SECURITY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
Thanks for helping make GitHub safe for everyone.
2-
31
# Security
42

3+
Thanks for helping make GitHub safe for everyone.
4+
55
GitHub takes the security of our software products and services seriously, including all of the open source code repositories managed through our GitHub organizations, such as [GitHub](https://github.com/GitHub).
66

77
Even though [open source repositories are outside of the scope of our bug bounty program](https://bounty.github.com/index.html#scope) and therefore not eligible for bounty rewards, we will ensure that your finding gets passed along to the appropriate maintainers for remediation.

client/CLI-USAGE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ Set the output format for `list` commands. Accepts `text` (default) or `json`.
154154

155155
**Text Format** - Human-readable output:
156156

157-
```
157+
```text
158158
codeql_bqrs_decode (tools/codeql_bqrs_decode) : Decode BQRS result files to human-readable formats
159159
```
160160

@@ -348,7 +348,7 @@ node src/ql-mcp-client.js list tools
348348

349349
Output:
350350

351-
```
351+
```text
352352
codeql_bqrs_decode (tools/codeql_bqrs_decode) : Decode BQRS result files to human-readable formats
353353
codeql_bqrs_info (tools/codeql_bqrs_info) : Get metadata and information about BQRS result files
354354
...
@@ -451,7 +451,7 @@ The old CLI flags have been removed and new commands have been added:
451451
- New: `node src/ql-mcp-client.js` → shows help
452452
- To run integration tests: `node src/ql-mcp-client.js integration-tests`
453453

454-
### New Features:
454+
### New Features
455455

456456
- **`list` commands**: Discover MCP server primitives (auto-starts server if needed)
457457
- `list primitives` - List all primitives (prompts, resources, tools)
@@ -464,7 +464,7 @@ The old CLI flags have been removed and new commands have been added:
464464
- **`--format` option**: Control output format (text/json) for list commands
465465
- **Server auto-start**: List commands automatically start the server if not running
466466

467-
### Script Replacement:
467+
### Script Replacement
468468

469469
The new `server` commands replace the shell scripts:
470470

server/ql/csharp/tools/src/PrintCFG/PrintCFG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Print CFG for C#
1+
# Print CFG for `csharp` Source Files
22

33
Produces a representation of a file's Control Flow Graph (CFG) for specified source files.
44

server/src/prompts/document-codeql-query.prompt.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -85,12 +85,12 @@ Based on gathered context, create or update the documentation file.
8585

8686
The documentation file (`QueryFileBaseName.md`) should follow this standardized format with these sections:
8787

88-
**Section 1: Title and Description**
88+
### Section 1: Title and Description
8989

9090
- H1 heading with the query name from @name metadata
9191
- One paragraph description from @description, expanded if needed
9292

93-
**Section 2: Metadata Table**
93+
### Section 2: Metadata Table
9494

9595
A table with these rows:
9696

@@ -100,15 +100,15 @@ A table with these rows:
100100
- Precision: The @precision value
101101
- Tags: The @tags values
102102

103-
**Section 3: Overview**
103+
### Section 3: Overview
104104

105105
Concise explanation of what vulnerability/issue this query detects and why it matters. 2-4 sentences.
106106

107-
**Section 4: Recommendation**
107+
### Section 4: Recommendation
108108

109109
Brief guidance on how developers should fix issues flagged by this query. Include code patterns to use or avoid.
110110

111-
**Section 5: Example**
111+
### Section 5: Example
112112

113113
Two subsections:
114114

@@ -117,7 +117,7 @@ Two subsections:
117117

118118
Use the appropriate language identifier for the code blocks (e.g., `javascript`, `python`, `java`).
119119

120-
**Section 6: References**
120+
### Section 6: References
121121

122122
A list of links to:
123123

server/src/prompts/ql-lsp-iterative-development.prompt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ These "iterative" tools work entirely through file paths and numeric positions.
99
Every operation is expressible as a tool call with explicit `file_path`, `line`, and `character` parameters.
1010
Thus, this prompt can be used in any environment where the query files are on disk, and it does not require any special editor integration.
1111

12-
## Use This Prompt When...
12+
## Use This Prompt When
1313

1414
- Exploring unfamiliar CodeQL libraries to discover available classes and predicates
1515
- Incrementally building a query clause-by-clause with real-time feedback

server/src/prompts/ql-tdd-advanced.prompt.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,7 @@ Before writing any query logic:
191191
- Identify which nodes correspond to your test cases
192192

193193
4. **Generate CFG if analyzing control flow**:
194+
194195
```typescript
195196
codeql_query_run: {
196197
queryName: "PrintCFG",
@@ -245,6 +246,7 @@ Instead of writing the full query at once:
245246
```
246247

247248
3. **Use find_codeql_query_files** to track all related files:
249+
248250
```typescript
249251
find_codeql_query_files: {
250252
queryPath: '/path/to/Query.ql';
@@ -369,6 +371,7 @@ class ThrowingMethod extends Method {
369371
```
370372

371373
3. **Profile the query**:
374+
372375
```typescript
373376
profile_codeql_query: {
374377
query: "/path/to/Query.ql",
@@ -413,11 +416,13 @@ When your query produces correct results but differs from the `.expected` file:
413416

414417
1. **Review the `.actual` file** to verify results are correct
415418
2. **Accept the results** to update the expected baseline:
419+
416420
```typescript
417421
codeql_test_accept: {
418422
tests: ['/path/to/test/QueryTest'];
419423
}
420424
```
425+
421426
3. **Re-run tests** to confirm they now pass
422427

423428
**Warning**: Only accept results after careful review. Don't blindly accept to make tests pass.

server/src/prompts/tools-query-workflow.prompt.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ The PrintAST query outputs a hierarchical tree of AST nodes with labels.
6060

6161
**Example AST output structure:**
6262

63-
```
63+
```text
6464
TopLevelFunction
6565
├── FunctionDeclarationEntry
6666
├── Block
@@ -91,7 +91,7 @@ The PrintCFG query outputs control flow nodes and edges.
9191

9292
**Example CFG output structure:**
9393

94-
```
94+
```text
9595
nodes
9696
| node | semmle.label |
9797
| ... | entry: processData |
@@ -141,7 +141,7 @@ Use the gathered information to inform your query:
141141

142142
### Pattern 1: Finding All Function Calls
143143

144-
```
144+
```text
145145
1. Run PrintAST on your source file
146146
2. Look for FunctionCall, MethodAccess, or similar nodes
147147
3. Note the parent/child relationships
@@ -150,7 +150,7 @@ Use the gathered information to inform your query:
150150

151151
### Pattern 2: Tracing Data Through Functions
152152

153-
```
153+
```text
154154
1. Run CallGraphFrom on your entry point function
155155
2. Identify which functions are called
156156
3. Run CallGraphTo on sink functions
@@ -159,7 +159,7 @@ Use the gathered information to inform your query:
159159

160160
### Pattern 3: Understanding Loop Structures
161161

162-
```
162+
```text
163163
1. Run PrintAST to find loop constructs (ForStmt, WhileStmt, etc.)
164164
2. Run PrintCFG on the containing function
165165
3. Identify back edges that represent loop iteration

server/src/prompts/workshop-creation-workflow.prompt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Decompose the query into 4-8 incremental stages using these strategies:
9797

9898
Standard workshop directory layout:
9999

100-
```
100+
```text
101101
workshop-name/
102102
├── codeql-workspace.yml # CodeQL workspace configuration
103103
├── README.md # Workshop guide with instructions

0 commit comments

Comments
 (0)