Skip to content

Commit 69f29d3

Browse files
update vscode task that build project
1 parent 3596cee commit 69f29d3

File tree

4 files changed

+41
-24
lines changed

4 files changed

+41
-24
lines changed

.vscode/settings.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"python.pythonPath": "venv/bin/python3",
2+
"python.defaultInterpreterPath": ".venv/bin/python3",
33
"python.testing.pytestEnabled": true,
44
"python.testing.autoTestDiscoverOnSaveEnabled": true
55
}

.vscode/tasks.json

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,45 @@
44
"version": "2.0.0",
55
"tasks": [
66
{
7-
"label": "Setup step 1: python venv",
7+
"label": "Step 1: Install poetry",
88
"type": "shell",
9-
"command": "python3 -m venv ./venv",
10-
"windows": {
11-
"command": "python venv"
12-
},
13-
"group": "Setup",
9+
"command": "python3 -m pip install poetry",
10+
"group": "build",
1411
"presentation": {
1512
"reveal": "always",
1613
"panel": "new"
14+
},
15+
"runOptions": {
16+
"runOn": "folderOpen"
1717
}
1818
},
1919
{
20-
"label": "Setup step 2: python requirements",
20+
"label": "Step 2: Configure poetry",
2121
"type": "shell",
22-
"command": "pip3 install -r requirements.txt",
23-
"windows": {
24-
"command": "python requirements"
22+
"command": "poetry config virtualenvs.in-project true --local",
23+
"group": "build",
24+
"presentation": {
25+
"reveal": "always",
26+
"panel": "new"
27+
},
28+
"runOptions": {
29+
"runOn": "folderOpen"
2530
},
26-
"group": "Setup",
31+
"dependsOn": ["Step 1: Install poetry"]
32+
},
33+
{
34+
"label": "Step 3: Install deps",
35+
"type": "shell",
36+
"command": "poetry install",
37+
"group": "build",
2738
"presentation": {
2839
"reveal": "always",
2940
"panel": "new"
30-
}
31-
}
41+
},
42+
"runOptions": {
43+
"runOn": "folderOpen"
44+
},
45+
"dependsOn": ["Step 1: Install poetry", "Step 2: Configure poetry"]
46+
},
3247
]
3348
}

docs/developing/index.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
## Get Docker
44

5-
Development requires Docker desktop available for windows + and mac or Docker CE available for Linux. Visit (Docker)[https://www.docker.com/get-started]
5+
Development requires Docker desktop available for windows + and mac or Docker CE available for Linux. Visit [Docker](https://www.docker.com/get-started)
66
for download instructions
77

88
## Setup VS Code IDE
99

10-
VS Code provides a free IDE experience that is effective for daily development with SC4S. Visit (Microsoft)[https://code.visualstudio.com/docs/introvideos/basics]
10+
VS Code provides a free IDE experience that is effective for daily development with SC4S. Visit [Microsoft](https://code.visualstudio.com/docs/introvideos/basics)
1111
to download and install for your platform (windows/mac/linux)
1212

1313
## Fork and Clone the github repository
1414

15-
Visit our repository at (Github)[https://github.com/splunk/splunk-connect-for-syslog] and "fork" our repository. This will allow you to make changes and submit pull requests.
15+
Visit our repository at [Github](https://github.com/splunk/splunk-connect-for-syslog) and "fork" our repository. This will allow you to make changes and submit pull requests.
1616

1717
![How to Fork](gh_fork.png)
1818

@@ -24,16 +24,18 @@ Click the clone icon and select the location
2424

2525
The following steps are required _only_ on the first time run.
2626

27-
* Install VS Code Extensions S
27+
* Install VS Code Extensions:
2828
* Python
2929
* Test Explorer
3030
* "Python Test Explorer"
31-
* From the terminal menu select "Run Task"
32-
* Select "Setup step 1: python venv" then "go without scanning output"
33-
* From the terminal menu select "Run Task"
34-
* Select "Setup step 2: python requirements" then "go without scanning output"
3531

36-
![VS Code setup](vsc_run.png)
32+
* Run command to setup the project:
33+
* From the terminal menu select "Run Task" (Ctrl + Shift + B)
34+
* Select "Step 1: Install poetry"
35+
* From the terminal menu select "Run Task" (Ctrl + Shift + B)
36+
* Select "Step 2: Configure poetry"
37+
* From the terminal menu select "Run Task" (Ctrl + Shift + B)
38+
* Select "Step 3: Install deps"
3739

3840
## Click the test lab icon
3941

poetry.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)