bingyi/vscode-extension-samples
1
0
Fork 0
mirror of https://github.com/microsoft/vscode-extension-samples.git synced 2026-04-27 16:55:44 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #607 from KamasamaK/update-sample-guideline

Browse Source 
Update Sample Guideline
This commit is contained in:
Matt Bierner
2022-04-13 14:32:08 -08:00
committed by GitHub
parent 73f881e6ac d965d320db
commit 2f3e6535f6
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
.github/SAMPLE_GUIDELINE.md vendored
View File

@ -1,7 +1,7 @@
# Sample Guideline
Each sample should have the following components and structure, so that users could have a smooth experience when playing with different samples.
The quickest way is to start your project by copying [.base-sample](https://github.com/Microsoft/vscode-extension-samples/tree/main/.base-sample).
The quickest way is to start your project by copying [.base-sample](https://github.com/microsoft/vscode-extension-samples/tree/main/.base-sample).
## 1: Sample Listing
@ -18,21 +18,21 @@ The quickest way is to start your project by copying [.base-sample](https://gith
## 3: .vscode
- 3.1: launch.json: use 0.2.0 version.
- 3.2: settings.json: use `"editor.insertSpaces": false`. This ensure when user opens the subfolder, tab indentation is enforced.
- 3.1: `launch.json`: use 0.2.0 version.
- 3.2: `settings.json`: use `"editor.insertSpaces": false`. This ensures when user opens the subfolder, tab indentation is enforced.
## 4: Dependencies
- 4.1: Use `npm`'s `package-lock.json` instead of `yarn.lock`.
- 4.2: `devDependencies` should include `@types/node`, `vscode`, `typescript` and `eslint`.
- 4.2: `devDependencies` should include `@types/node`, `@types/vscode`, `@typescript-eslint/eslint-plugin`, `@typescript-eslint/parser`, `eslint`, and `typescript`.
## 5: Formatter and Linter
Only deviate from the standard setting if your sample needs to.
- 5.1: Include a `.eslintrc.js` following https://github.com/Microsoft/vscode-extension-samples/blob/ext-docs/helloworld-sample/eslintrc.js.
- 5.2: Include a `tsconfig.json` following https://github.com/Microsoft/vscode-extension-samples/blob/ext-docs/helloworld-sample/tsconfig.json.
- 5.3: Your source code should be formatted either using [tsfmt](https://github.com/vvakame/typescript-formatter) or the editor's TS formatter and contain no TSLint/TS errors.
- 5.1: Include a `.eslintrc.js` following <https://github.com/microsoft/vscode-extension-samples/blob/main/helloworld-sample/.eslintrc.js>.
- 5.2: Include a `tsconfig.json` following <https://github.com/microsoft/vscode-extension-samples/blob/main/helloworld-sample/tsconfig.json>.
- 5.3: Your source code should be formatted either using [tsfmt](https://github.com/vvakame/typescript-formatter) or the editor's TS formatter and contain no ESLint/TS errors.
## 6: Tests