Skip to content

Commit fa8ad79

Browse files
committed
Fix markdown in testing.md
1 parent 404ad65 commit fa8ad79

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

docs/testing.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Any test data you're using (sample projects, config files, etc.) must go in a `t
1818
## Running the tests
1919

2020
Pre-requisites:
21+
2122
1. Run `npm run build`.
2223
2. You will need to have `npm run watch` running in the background.
2324

@@ -51,6 +52,7 @@ You will need to run tests using a task from inside of VS Code, under the "Run a
5152
* View Tests: run the _Launch Unit Tests_ task
5253
* VSCode integration tests: run the _Launch Unit Tests - No Workspace_ and _Launch Unit Tests - Minimal Workspace_ tasks
5354

55+
<!-- markdownlint-disable-next-line MD024 -->
5456
#### CLI integration tests
5557

5658
The CLI integration tests require the CodeQL standard libraries in order to run so you will need to clone a local copy of the `github/codeql` repository.
@@ -63,6 +65,7 @@ The CLI integration tests require the CodeQL standard libraries in order to run
6365

6466
## Running a single test
6567

68+
<!-- markdownlint-disable-next-line MD024 -->
6669
### 1. From the terminal
6770

6871
The easiest way to run a single test is to change the `it` of the test to `it.only` and then run the test command with some additional options
@@ -78,6 +81,7 @@ You can also use the `--testNamePattern` option to run a specific test within a
7881
npm run test:cli-integration -- --runTestsByPath test/vscode-tests/cli-integration/run-queries.test.ts --testNamePattern "should create a QueryEvaluationInfo"
7982
```
8083

84+
<!-- markdownlint-disable-next-line MD024 -->
8185
### 2. From VSCode
8286

8387
Alternatively, you can run a single test inside VSCode. To do so, install the [Jest Runner](https://marketplace.visualstudio.com/items?itemName=firsttris.vscode-jest-runner) extension. Then,
@@ -94,7 +98,9 @@ Multi-Repo Variant Analyses (MRVA) rely on the GitHub API. In order to make deve
9498
### Using a pre-recorded test scenario
9599

96100
To run a mock MRVA scenario, follow these steps:
101+
97102
1. Enable the mock GitHub API server by adding the following in your VS Code user settings (which can be found by running the `Preferences: Open User Settings (JSON)` VS Code command):
103+
98104
```json
99105
"codeQL.mockGitHubApiServer": {
100106
"enabled": true
@@ -108,9 +114,11 @@ To run a mock MRVA scenario, follow these steps:
108114
If you want to replay the same scenario you should unload and reload it so requests are replayed from the start.
109115

110116
### Recording a new test scenario
117+
111118
To record a new mock MRVA scenario, follow these steps:
112119

113120
1. Enable the mock GitHub API server by adding the following in your VS Code user settings (which can be found by running the `Preferences: Open User Settings (JSON)` VS Code command):
121+
114122
```json
115123
"codeQL.mockGitHubApiServer": {
116124
"enabled": true

0 commit comments

Comments
 (0)