Skip to content

Commit ba94268

Browse files
authored
Merge pull request #3337 from EanLombardo/build-setup-cleanup
contrib, chore: Improvements to setting up a build environment, mostly for vscode and windows.
2 parents 0644864 + d9dc749 commit ba94268

File tree

5 files changed

+15
-5
lines changed

5 files changed

+15
-5
lines changed

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
*.jsonc text eol=lf
77
*.lock text eol=lf
88
*.md text eol=lf
9+
*.mjs text eol=lf
910
*.ps1 text eol=lf
1011
*.py text eol=lf
1112
*.sh text eol=lf

.vscode/extensions.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
{
22
"recommendations": [
3-
"DavidAnson.vscode-markdownlint"
3+
"DavidAnson.vscode-markdownlint",
4+
"gamunu.vscode-yarn",
5+
"mrmlnc.vscode-scss",
6+
"Orta.vscode-jest",
7+
"svelte.svelte-vscode",
48
]
59
}

.vscode/settings.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
{
2-
"npm.packageManager": "yarn"
2+
"npm.packageManager": "yarn",
3+
"svelte.enable-ts-plugin" : true,
34
}

contributing/Building/Setting up build environment.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
# Setting up build environment
22

3-
This project uses Node 16.x, if you also use a different version, look at using `nvm` to manage your Node versions.
4-
If you are using `nvm`, you can install the 16.x version of Node with `nvm install 16; nvm use <full version number you installed such as 16.10.0>`.
3+
See [package.json](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/package.json) for which version of Node to use.
4+
5+
Consider using `nvm` which allows you to manage multiple versions of node.
6+
7+
For example, to install node 18.x:\
8+
`nvm install 18; nvm use <full version number you installed such as 18.2.0>`.
59

610
To setup the local environment after cloning the repository, run the following commands:
711

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"description": "Task management for the Obsidian knowledge base",
55
"main": "main.js",
66
"engines": {
7-
"node": "^16.10.0 || >=18.0.0"
7+
"node": ">=18.0.0"
88
},
99
"scripts": {
1010
"dev": "node esbuild.config.mjs",

0 commit comments

Comments
 (0)