From d965d320db14ff777e08b40422e6ddc515a529eb Mon Sep 17 00:00:00 2001 From: KamasamaK Date: Sun, 10 Apr 2022 04:38:19 -0400 Subject: [PATCH] Update Sample Guideline --- .github/SAMPLE_GUIDELINE.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/SAMPLE_GUIDELINE.md b/.github/SAMPLE_GUIDELINE.md index 80a4f3db..a4fd1674 100644 --- a/.github/SAMPLE_GUIDELINE.md +++ b/.github/SAMPLE_GUIDELINE.md @@ -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 . +- 5.2: Include a `tsconfig.json` following . +- 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