From bf56683752c1bad78de3dbf9605ace9c901eb7cc Mon Sep 17 00:00:00 2001 From: Pine Wu Date: Wed, 12 Dec 2018 15:51:03 -0800 Subject: [PATCH] Update all references to hellocode --- .base-sample/README.md | 2 +- .base-sample/package.json | 10 +++++----- .base-sample/src/extension.ts | 6 +++--- .github/SAMPLE_GUIDELINE.md | 4 ++-- README.md | 4 ++-- .../.vscode/launch.json | 0 .../README.md | 4 ++-- .../extension.js | 4 ++-- .../package.json | 11 ++++++----- {hellocode-sample => helloworld-sample}/.gitignore | 0 .../.vscode/launch.json | 0 .../.vscode/tasks.json | 0 {hellocode-sample => helloworld-sample}/README.md | 2 +- {hellocode-sample => helloworld-sample}/demo.gif | Bin .../package-lock.json | 2 +- .../package.json | 12 ++++++------ .../src/extension.ts | 6 +++--- .../tsconfig.json | 0 18 files changed, 34 insertions(+), 33 deletions(-) rename {hellocode-minimal-sample => helloworld-minimal-sample}/.vscode/launch.json (100%) rename {hellocode-minimal-sample => helloworld-minimal-sample}/README.md (86%) rename {hellocode-minimal-sample => helloworld-minimal-sample}/extension.js (86%) rename {hellocode-minimal-sample => helloworld-minimal-sample}/package.json (59%) rename {hellocode-sample => helloworld-sample}/.gitignore (100%) rename {hellocode-sample => helloworld-sample}/.vscode/launch.json (100%) rename {hellocode-sample => helloworld-sample}/.vscode/tasks.json (100%) rename {hellocode-sample => helloworld-sample}/README.md (97%) rename {hellocode-sample => helloworld-sample}/demo.gif (100%) rename {hellocode-sample => helloworld-sample}/package-lock.json (99%) rename {hellocode-sample => helloworld-sample}/package.json (77%) rename {hellocode-sample => helloworld-sample}/src/extension.ts (87%) rename {hellocode-sample => helloworld-sample}/tsconfig.json (100%) diff --git a/.base-sample/README.md b/.base-sample/README.md index 9a586159..8cb17018 100644 --- a/.base-sample/README.md +++ b/.base-sample/README.md @@ -1,5 +1,5 @@ # Base Sample -This sample is similar to the [hellocode-sample](https://github.com/Microsoft/vscode-extension-samples/tree/ext-docs/hellocode-sample), but it follows the [Sample Guideline](https://github.com/Microsoft/vscode-extension-samples/blob/ext-docs/.github/SAMPLE_GUIDELINE.md). +This sample is similar to the [helloworld-sample](../helloworld-sample), but it follows the [Sample Guideline](https://github.com/Microsoft/vscode-extension-samples/blob/ext-docs/.github/SAMPLE_GUIDELINE.md). You can easily write a new sample following the guideline by `cp -r .base-sample my-sample`. \ No newline at end of file diff --git a/.base-sample/package.json b/.base-sample/package.json index c8f290cd..59759aaf 100644 --- a/.base-sample/package.json +++ b/.base-sample/package.json @@ -5,19 +5,19 @@ "version": "0.0.1", "publisher": "vscode-samples", "engines": { - "vscode": "^1.28.0" + "vscode": "^1.25.0" }, "categories": [ "Other" ], "activationEvents": [ - "onCommand:extension.sayHello" + "onCommand:extension.helloWorld" ], - "main": "./out/extension", + "main": "./out/extension.js", "contributes": { "commands": [ { - "command": "extension.sayHello", + "command": "extension.helloWorld", "title": "Hello World" } ] @@ -26,7 +26,7 @@ "vscode:prepublish": "npm run compile", "compile": "tsc -p ./", "watch": "tsc -watch -p ./", - "postinstall": "node ./node_modules/vscode/bin/install", + "postinstall": "node ./node_modules/vscode/bin/install" }, "devDependencies": { "@types/node": "^8.10.25", diff --git a/.base-sample/src/extension.ts b/.base-sample/src/extension.ts index e85adbb2..4b9d9fa2 100644 --- a/.base-sample/src/extension.ts +++ b/.base-sample/src/extension.ts @@ -7,12 +7,12 @@ import * as vscode from 'vscode'; export function activate(context: vscode.ExtensionContext) { // Use the console to output diagnostic information (console.log) and errors (console.error) // This line of code will only be executed once when your extension is activated - console.log('Congratulations, your extension "hellocode-sample" is now active!'); + console.log('Congratulations, your extension "helloworld-sample" is now active!'); // The command has been defined in the package.json file - // Now provide the implementation of the command with registerCommand + // Now provide the implementation of the command with registerCommand // The commandId parameter must match the command field in package.json - let disposable = vscode.commands.registerCommand('extension.sayHello', () => { + let disposable = vscode.commands.registerCommand('extension.helloWorld', () => { // The code you place here will be executed every time your command is executed // Display a message box to the user diff --git a/.github/SAMPLE_GUIDELINE.md b/.github/SAMPLE_GUIDELINE.md index 96d4a8f7..08e867dd 100644 --- a/.github/SAMPLE_GUIDELINE.md +++ b/.github/SAMPLE_GUIDELINE.md @@ -30,8 +30,8 @@ The quickest way is to start your project by copying [.base-sample](https://gith Only deviate from the standard setting if your sample needs to. -- 5.1: Include a `tslint.json` following https://github.com/Microsoft/vscode-extension-samples/blob/ext-docs/hellocode-sample/tslint.json. -- 5.2: Include a `tsconfig.json` following https://github.com/Microsoft/vscode-extension-samples/blob/ext-docs/hellocode-sample/tsconfig.json. +- 5.1: Include a `tslint.json` following https://github.com/Microsoft/vscode-extension-samples/blob/ext-docs/helloworld-sample/tslint.json. +- 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. ## 6: Tests diff --git a/README.md b/README.md index 81c0a575..89efb85b 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,8 @@ You can expect from each sample: ## Getting Started -- [Hello Code Sample](hellocode-sample): The Hello World sample for VS Code. -- [Hello Code Minimal Sample](hellocode-minimal-sample): A minimal version of Hello Code Sample that doesn't use TypeScript. +- [Hello World Sample](helloworld-sample): The Hello World sample for VS Code. +- [Hello World Minimal Sample](helloworld-minimal-sample): A minimal version of Hello World Sample that doesn't use TypeScript. ## Samples diff --git a/hellocode-minimal-sample/.vscode/launch.json b/helloworld-minimal-sample/.vscode/launch.json similarity index 100% rename from hellocode-minimal-sample/.vscode/launch.json rename to helloworld-minimal-sample/.vscode/launch.json diff --git a/hellocode-minimal-sample/README.md b/helloworld-minimal-sample/README.md similarity index 86% rename from hellocode-minimal-sample/README.md rename to helloworld-minimal-sample/README.md index ba342223..336783ec 100644 --- a/hellocode-minimal-sample/README.md +++ b/helloworld-minimal-sample/README.md @@ -1,6 +1,6 @@ -# Hello Code Minimal Sample +# Hello World Minimal Sample -This is a minimal version of the [Hello Code Sample](../hellocode-sample). +This is a minimal version of the [Hello World Sample](../helloworld-sample). It does not use TypeScript and only includes the `vscode` devDependency needed for extension development. diff --git a/hellocode-minimal-sample/extension.js b/helloworld-minimal-sample/extension.js similarity index 86% rename from hellocode-minimal-sample/extension.js rename to helloworld-minimal-sample/extension.js index b012f14a..63fb6368 100644 --- a/hellocode-minimal-sample/extension.js +++ b/helloworld-minimal-sample/extension.js @@ -11,12 +11,12 @@ const vscode = require('vscode'); function activate(context) { // Use the console to output diagnostic information (console.log) and errors (console.error) // This line of code will only be executed once when your extension is activated - console.log('Congratulations, your extension "hellocode-minimal-sample" is now active!'); + console.log('Congratulations, your extension "helloworld-minimal-sample" is now active!'); // The command has been defined in the package.json file // Now provide the implementation of the command with registerCommand // The commandId parameter must match the command field in package.json - let disposable = vscode.commands.registerCommand('extension.sayHello', () => { + let disposable = vscode.commands.registerCommand('extension.helloWorld', () => { // The code you place here will be executed every time your command is executed // Display a message box to the user diff --git a/hellocode-minimal-sample/package.json b/helloworld-minimal-sample/package.json similarity index 59% rename from hellocode-minimal-sample/package.json rename to helloworld-minimal-sample/package.json index 63892c34..f56818f3 100644 --- a/hellocode-minimal-sample/package.json +++ b/helloworld-minimal-sample/package.json @@ -1,19 +1,20 @@ { - "name": "hellocode-minimal-sample", + "name": "helloworld-minimal-sample", "description": "Minimal HelloWorld example for VS Code", "version": "0.0.1", "publisher": "vscode-samples", + "repository": "https://github.com/Microsoft/vscode-extension-samples/helloworld-minimal-sample", "engines": { - "vscode": "^1.28.0" + "vscode": "^1.25.0" }, "activationEvents": [ - "onCommand:extension.sayHello" + "onCommand:extension.helloWorld" ], "main": "./extension.js", "contributes": { "commands": [ { - "command": "extension.sayHello", + "command": "extension.helloWorld", "title": "Hello World" } ] @@ -22,6 +23,6 @@ "postinstall": "node ./node_modules/vscode/bin/install" }, "devDependencies": { - "vscode": "^1.1.17" + "vscode": "^1.1.22" } } diff --git a/hellocode-sample/.gitignore b/helloworld-sample/.gitignore similarity index 100% rename from hellocode-sample/.gitignore rename to helloworld-sample/.gitignore diff --git a/hellocode-sample/.vscode/launch.json b/helloworld-sample/.vscode/launch.json similarity index 100% rename from hellocode-sample/.vscode/launch.json rename to helloworld-sample/.vscode/launch.json diff --git a/hellocode-sample/.vscode/tasks.json b/helloworld-sample/.vscode/tasks.json similarity index 100% rename from hellocode-sample/.vscode/tasks.json rename to helloworld-sample/.vscode/tasks.json diff --git a/hellocode-sample/README.md b/helloworld-sample/README.md similarity index 97% rename from hellocode-sample/README.md rename to helloworld-sample/README.md index cd8f2a8d..96403c70 100644 --- a/hellocode-sample/README.md +++ b/helloworld-sample/README.md @@ -1,4 +1,4 @@ -# Hello Code Sample +# Hello World Sample This is a Hello World example that shows you how to use VS Code API. diff --git a/hellocode-sample/demo.gif b/helloworld-sample/demo.gif similarity index 100% rename from hellocode-sample/demo.gif rename to helloworld-sample/demo.gif diff --git a/hellocode-sample/package-lock.json b/helloworld-sample/package-lock.json similarity index 99% rename from hellocode-sample/package-lock.json rename to helloworld-sample/package-lock.json index b74ecab3..07ea977d 100644 --- a/hellocode-sample/package-lock.json +++ b/helloworld-sample/package-lock.json @@ -1,5 +1,5 @@ { - "name": "hellocode-sample", + "name": "helloworld-sample", "version": "0.0.1", "lockfileVersion": 1, "requires": true, diff --git a/hellocode-sample/package.json b/helloworld-sample/package.json similarity index 77% rename from hellocode-sample/package.json rename to helloworld-sample/package.json index 32b4a6fd..364ea329 100644 --- a/hellocode-sample/package.json +++ b/helloworld-sample/package.json @@ -1,10 +1,10 @@ { - "name": "hellocode-sample", - "displayName": "hellocode-sample", + "name": "helloworld-sample", + "displayName": "helloworld-sample", "description": "HelloWorld example for VS Code", "version": "0.0.1", "publisher": "vscode-samples", - "repository": "https://github.com/Microsoft/vscode-extension-samples/hellocode-sample", + "repository": "https://github.com/Microsoft/vscode-extension-samples/helloworld-sample", "engines": { "vscode": "^1.25.0" }, @@ -12,14 +12,14 @@ "Other" ], "activationEvents": [ - "onCommand:extension.helloCode" + "onCommand:extension.helloWorld" ], "main": "./out/extension.js", "contributes": { "commands": [ { - "command": "extension.helloCode", - "title": "Hello Code" + "command": "extension.helloWorld", + "title": "Hello World" } ] }, diff --git a/hellocode-sample/src/extension.ts b/helloworld-sample/src/extension.ts similarity index 87% rename from hellocode-sample/src/extension.ts rename to helloworld-sample/src/extension.ts index cf304261..4b9d9fa2 100644 --- a/hellocode-sample/src/extension.ts +++ b/helloworld-sample/src/extension.ts @@ -7,16 +7,16 @@ import * as vscode from 'vscode'; export function activate(context: vscode.ExtensionContext) { // Use the console to output diagnostic information (console.log) and errors (console.error) // This line of code will only be executed once when your extension is activated - console.log('Congratulations, your extension "hellocode-sample" is now active!'); + console.log('Congratulations, your extension "helloworld-sample" is now active!'); // The command has been defined in the package.json file // Now provide the implementation of the command with registerCommand // The commandId parameter must match the command field in package.json - let disposable = vscode.commands.registerCommand('extension.helloCode', () => { + let disposable = vscode.commands.registerCommand('extension.helloWorld', () => { // The code you place here will be executed every time your command is executed // Display a message box to the user - vscode.window.showInformationMessage('Hello Code!'); + vscode.window.showInformationMessage('Hello World!'); }); context.subscriptions.push(disposable); diff --git a/hellocode-sample/tsconfig.json b/helloworld-sample/tsconfig.json similarity index 100% rename from hellocode-sample/tsconfig.json rename to helloworld-sample/tsconfig.json