Skip to content

Commit fa86c92

Browse files
xech3rmanj
andauthored
feat: prefer .vscode folder over app.code-workspace file (#251)
* feat: prefer .vscode folder over code-worspace file - users are no longer required to manually open the workspace file - vscode title bar now displays project name instead of "app" * docs: remove mentions of old workspace file * docs(react): remove platform-specific wording Co-authored-by: Eric Morton <[email protected]> Co-authored-by: Herman Jensen <[email protected]>
1 parent 8950179 commit fa86c92

File tree

7 files changed

+21
-23
lines changed

7 files changed

+21
-23
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,3 @@ nodejs/generators/app/templates/reports
6363

6464
# Visual Studio 2015/2017/2022 cache/options directory
6565
.vs/
66-
.vscode

docusaurus/react/getting-started/installation.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,19 @@ sidebar_position: 1
1313

1414
## Create App
1515

16+
Run these commands in your terminal.
17+
1618
```bash
1719
npx degit intility/templates/react my-app
1820
cd my-app
1921

2022
npm install
2123
```
2224

23-
Run it in your terminal, and then open the Visual Studio Code Workspace with the following command.
25+
Open the project folder in Visual Studio Code with the following command.
2426

2527
```bash
26-
code app.code-workspace
28+
code .
2729
```
2830

2931
You can now start coding by running the start script.

docusaurus/react/getting-started/project-overview.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ Depending on which template you chose,
77
your project structure will look more or less like the following:
88

99
```
10+
├── .vscode
11+
│ ├── extensions.json
12+
│ └── settings.json
1013
├── chart
1114
│ ├── templates
1215
│ │ ├── _helpers.tpl
@@ -50,7 +53,6 @@ your project structure will look more or less like the following:
5053
├── Dockerfile
5154
├── Dockerfile.CI
5255
├── README.md
53-
├── app.code-workspace
5456
├── index.html
5557
├── package.json
5658
├── tsconfig.json

react/.gitignore

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ dist-ssr
1515
*.local
1616

1717
# Editor directories and files
18-
.vscode/*
19-
!.vscode/extensions.json
2018
.idea
2119
.DS_Store
2220
*.suo

react/.vscode/extensions.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"recommendations": [
3+
"swellaby.node-pack",
4+
"esbenp.prettier-vscode",
5+
"intility.vscode-backstage",
6+
"redhat.vscode-yaml"
7+
]
8+
}

react/app.code-workspace renamed to react/.vscode/settings.json

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
11
{
2-
"folders": [
3-
{
4-
"path": "."
5-
}
6-
],
7-
"settings": {
82
"files.eol": "\n",
93
"files.associations": {
104
"*.js": "javascript",
@@ -35,13 +29,4 @@
3529
"editor.defaultFormatter": "dbaeumer.vscode-eslint"
3630
},
3731
"typescript.tsdk": "node_modules/typescript/lib"
38-
},
39-
"extensions": {
40-
"recommendations": [
41-
"swellaby.node-pack",
42-
"esbenp.prettier-vscode",
43-
"intility.vscode-backstage",
44-
"redhat.vscode-yaml"
45-
]
46-
}
47-
}
32+
}

react/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ React
4444

4545
## Getting Started
4646

47+
### First-time setup
48+
4749
<!--
4850
Provide step by step instructions that will allow a new contributor to get a copy of the project up and running on their local machine.
4951
Installation of common development tools such as `git`, `docker` and IDEs can be covered here, but is not necessary.
@@ -52,6 +54,8 @@ The granularity and extent of these instructions will depend on the size and typ
5254
but may extend to things such as platform specific steps, etc.
5355
-->
5456

57+
Clone the repository, then install dependencies with `npm install`
58+
5559
### Running the project
5660

5761
<!-- Provide examples of how to run the project locally here, if applicable. -->
@@ -68,7 +72,7 @@ Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
6872
The page will reload if you make edits.<br />
6973
You will also see any lint errors in the console.
7074

71-
## `npm test`
75+
### `npm test`
7276

7377
Launches the test runner in the interactive watch mode.
7478

0 commit comments

Comments
 (0)