diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
new file mode 100644
index 00000000..df08deee
--- /dev/null
+++ b/.github/workflows/release.yml
@@ -0,0 +1,136 @@
+name: Publish
+
+on:
+ workflow_dispatch:
+ inputs:
+ releaseType:
+ description: "Release Type"
+ required: true
+ type: choice
+ default: "patch"
+ options:
+ - patch
+ - minor
+ - major
+ releaseChannel:
+ description: "Release Channel"
+ required: true
+ type: choice
+ default: stable
+ options:
+ - stable
+ - edge
+ publishMarketplace:
+ description: "Publish on Visual Studio Marketplace?"
+ required: true
+ type: choice
+ default: "no"
+ options:
+ - "yes"
+ - "no"
+ publishOpenVSX:
+ description: "Publish on Open VSX Registry?"
+ required: true
+ type: choice
+ default: "no"
+ options:
+ - "yes"
+ - "no"
+
+jobs:
+ release:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Clone Repository
+ uses: actions/checkout@v2
+ with:
+ fetch-depth: 0
+ - name: Setup Node version
+ uses: actions/setup-node@v1
+ with:
+ node-version: 16
+ - name: Install dependencies
+ run: npm install
+ - name: Build Package
+ run: npm run compile
+ - name: Run Tests
+ uses: GabrielBB/xvfb-action@v1
+ with:
+ run: npm test
+ options: "-screen 0 1600x1200x24"
+ - name: Create Changelog
+ run: |
+ git log $(git describe --tags --abbrev=0)..HEAD --oneline &> ${{ github.workspace }}-CHANGELOG.txt
+ cat ${{ github.workspace }}-CHANGELOG.txt
+ - name: Setup Git
+ run: |
+ git config --global user.name "Release Bot"
+ git config --global user.email "no-noreply@github.com"
+ - name: Get Current Version Number
+ run: |
+ CURRENT_VERSION=$(cat package.json | jq .version | cut -d'"' -f 2)
+ echo "CURRENT_VERSION=$CURRENT_VERSION" >> $GITHUB_ENV
+ - name: Compile New Version (Edge)
+ run: |
+ RELEASE_VERSION=$(npx semver $CURRENT_VERSION -i pre${{ github.event.inputs.releaseType }} --preid edge)
+ echo "RELEASE_VERSION=$RELEASE_VERSION" >> $GITHUB_ENV
+ echo "Bump to $RELEASE_VERSION"
+ if: ${{ github.event.inputs.releaseChannel == 'edge' && !contains(env.CURRENT_VERSION, 'edge') }}
+ - name: Compile New Version (Edge)
+ run: |
+ RELEASE_VERSION=$(npx semver $CURRENT_VERSION -i prerelease)
+ echo "RELEASE_VERSION=$RELEASE_VERSION" >> $GITHUB_ENV
+ echo "Bump to $RELEASE_VERSION"
+ if: ${{ github.event.inputs.releaseChannel == 'edge' && contains(env.CURRENT_VERSION, 'edge') }}
+ - name: Compile New Version (Stable)
+ run: |
+ RELEASE_VERSION=$(npx semver $CURRENT_VERSION -i github.event.inputs.releaseType)
+ echo "RELEASE_VERSION=$RELEASE_VERSION" >> $GITHUB_ENV
+ echo "Bump to $RELEASE_VERSION"
+ if: ${{ github.event.inputs.releaseChannel == 'stable' }}
+ - name: Version Package
+ run: |
+ git checkout .
+ npm version $RELEASE_VERSION
+ - name: Package Extension (Edge)
+ if: ${{ github.event.inputs.releaseChannel == 'edge' }}
+ run: |
+ node .github/scripts/updateEdgeVersion.js
+ npx vsce package --pre-release --no-git-tag-version --no-update-package-json -o "./live-server-$RELEASE_VERSION.vsix" ${{ github.event.inputs.additionalFlags }}
+ - name: Package Extension (Stable)
+ run: npx vsce package $RELEASE_VERSION --no-git-tag-version --no-update-package-json -o "./live-server-$RELEASE_VERSION.vsix" ${{ github.event.inputs.additionalFlags }}
+ if: ${{ github.event.inputs.releaseChannel == 'stable' }}
+ - name: Publish to Visual Studio Marketplace (Edge)
+ run: npx vsce publish --packagePath "./live-server-$RELEASE_VERSION.vsix" --pre-release --no-git-tag-version --no-update-package-json -p ${{ secrets.VSC_MKTP_PAT }} ${{ github.event.inputs.additionalFlags }}
+ if: ${{ github.event.inputs.publishMarketplace == 'yes' && github.event.inputs.releaseChannel == 'edge' }}
+ - name: Publish to Visual Studio Marketplace (Stable)
+ run: npx vsce publish --packagePath "./live-server-$RELEASE_VERSION.vsix" --no-git-tag-version --no-update-package-json -p ${{ secrets.VSC_MKTP_PAT }} ${{ github.event.inputs.additionalFlags }}
+ if: ${{ github.event.inputs.publishMarketplace == 'yes' && github.event.inputs.releaseChannel == 'stable' }}
+ - name: Publish to Open VSX Registry (Edge)
+ uses: HaaLeo/publish-vscode-extension@v1
+ if: ${{ github.event.inputs.publishOpenVSX == 'yes' && github.event.inputs.releaseChannel == 'edge' }}
+ with:
+ preRelease: true
+ pat: ${{ secrets.OPEN_VSX_TOKEN }}
+ extensionFile: ./live-server-${{ env.RELEASE_VERSION }}.vsix
+ - name: Publish to Open VSX Registry (Stable)
+ uses: HaaLeo/publish-vscode-extension@v1
+ if: ${{ github.event.inputs.publishOpenVSX == 'yes' && github.event.inputs.releaseChannel == 'stable' }}
+ with:
+ preRelease: false
+ pat: ${{ secrets.OPEN_VSX_TOKEN }}
+ extensionFile: ./live-server-${{ env.RELEASE_VERSION }}.vsix
+ - name: Push Tags
+ run: |
+ git log -1 --stat
+ git push origin master --tags
+ - run: |
+ export GIT_TAG=$(git describe --tags --abbrev=0)
+ echo "GIT_TAG=$GIT_TAG" >> $GITHUB_ENV
+ - name: GitHub Release
+ uses: ncipollo/release-action@v1
+ with:
+ artifacts: "./live-server-*"
+ bodyFile: ${{ github.workspace }}-CHANGELOG.txt
+ tag: ${{ env.GIT_TAG }}
+ prerelease: ${{ github.event.inputs.releaseChannel == 'edge' }}
\ No newline at end of file
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
new file mode 100644
index 00000000..caf2d633
--- /dev/null
+++ b/.github/workflows/test.yml
@@ -0,0 +1,36 @@
+name: CI
+
+on:
+ push:
+ branches:
+ - master
+ pull_request:
+
+jobs:
+ build:
+ strategy:
+ matrix:
+ os: [ubuntu-latest, macos-latest, windows-latest]
+ runs-on: ${{ matrix.os }}
+
+ steps:
+ - uses: actions/checkout@v2
+ - name: Use Node.js
+ uses: actions/setup-node@v1
+ with:
+ node-version: 16
+ - name: Install Dependencies
+ run: npm install
+ - name: Build
+ run: npm run compile
+ - name: Run Tests
+ uses: GabrielBB/xvfb-action@v1
+ if: matrix.os != 'ubuntu-latest'
+ with:
+ run: npm test
+ options: "-screen 0 1600x1200x24"
+ - name: Run Tests
+ uses: GabrielBB/xvfb-action@v1
+ if: matrix.os == 'ubuntu-latest'
+ with:
+ run: ./node_modules/.bin/run-s test:lint test:unit
diff --git a/.gitignore b/.gitignore
index 1ee34bde..59cdc10c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,4 +3,6 @@ node_modules
_site
Gemfile.lock
**/*.vsix
-.vscode-test
\ No newline at end of file
+.vscode-test
+.wdio-vscode-service
+*-CHANGELOG.txt
\ No newline at end of file
diff --git a/.travis.yml b/.travis.yml
deleted file mode 100644
index 6d2d1a20..00000000
--- a/.travis.yml
+++ /dev/null
@@ -1,47 +0,0 @@
-language: node_js
-node_js:
- - "10.14.2"
-
-cache:
- directories:
- - node_modules
- yarn: true
-
-os:
- - osx
- - linux
-
-addons:
- apt:
- packages:
- - libsecret-1-dev
-
-before_install:
- - rm -fr package-lock.json
- - if [ $TRAVIS_OS_NAME == "linux" ]; then
- export CXX="g++-4.9" CC="gcc-4.9" DISPLAY=:99.0;
- sh -e /etc/init.d/xvfb start;
- sleep 3;
- fi
-
-install:
- - npm i -g vsce
- - npm install
- - npm run vscode:prepublish
-
-script:
- - if [ $TRAVIS_OS_NAME == "linux" ]; then
- npm dedupe;
- fi
- - npm run lint
- - npm test --silent
- - vsce package -o LiveServer-$TRAVIS_TAG-$TRAVIS_OS_NAME.vsix
-
-deploy:
- provider: releases
- api_key: $github_token
- file: "*.vsix"
- file_glob: true
- skip_cleanup: true
- on:
- tags: true
diff --git a/.vscodeignore b/.vscodeignore
index 2a1e3b75..cfa5488d 100644
--- a/.vscodeignore
+++ b/.vscodeignore
@@ -1,5 +1,6 @@
.vscode/**
.vscode-test/**
+.wdio-vscode-service/**
out/test/**
test/**
src/**
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 8cbe77b4..0f518992 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,6 +1,10 @@
# Changelog
| Version | Date | Changelog |
|---|---|---|
+| 5.6.1 | 17.04.19 | Fixed `Extension host terminated unexpectedly` *[[#431](https://github.com/ritwickdey/vscode-live-server/issues/431)]*
+|5.6.0 | 17.04.19 | — ***[NEW]*** Intregation of `Browser Preview` with `Live Server` *[[#352](https://github.com/ritwickdey/vscode-live-server/pull/352) - Thanks to [Kenneth Auchenberg](https://github.com/auchenberg) ]* {
+ return Config.configuration.update(key, val, isGlobal);
+ }
+
public static get getHost(): string {
return Config.getSettings('host');
}
- public static get getLocalIp(): string {
- return Config.getSettings('useLocalIp');
+ public static get getLocalIp(): boolean {
+ return Config.getSettings('useLocalIp');
}
public static get getPort(): number {
return Config.getSettings('port');
}
+ public static setPort(port: number): Thenable {
+ return Config.setSettings('port', port);
+ }
+
public static get getRoot(): string {
return Config.getSettings('root');
}
@@ -109,11 +117,11 @@ export class Config {
return Config.getSettings('file');
}
- public static get getMutiRootWorkspaceName(): string {
+ public static get getMultiRootWorkspaceName(): string {
return Config.getSettings('multiRootWorkspaceName');
}
- public static setMutiRootWorkspaceName(val: string) {
+ public static setMultiRootWorkspaceName(val: string) {
return Config.configuration.update('multiRootWorkspaceName', val, false);
}
}
diff --git a/src/Helper.ts b/src/Helper.ts
index df57aa3a..24bdebcf 100644
--- a/src/Helper.ts
+++ b/src/Helper.ts
@@ -4,10 +4,17 @@ import * as fs from 'fs';
import * as path from 'path';
import { Config } from './Config';
-export const SUPPRORTED_EXT: string[] = [
+export const SUPPORTED_EXT: string[] = [
'.html', '.htm', '.svg'
];
+export const isRelativePath = (pathUrl: string) => {
+ if (pathUrl.startsWith('*')) return false;
+
+ return !path.isAbsolute(pathUrl);
+};
+
+
export class Helper {
@@ -23,7 +30,7 @@ export class Helper {
rootPath = testPath;
}
else {
- rootPath = workSpacePath;
+ rootPath = workSpacePath;
}
if (!rootPath.endsWith(path.sep))
@@ -58,7 +65,7 @@ export class Helper {
*/
public static IsSupportedFile(file: string): boolean {
let ext = path.extname(file) || (file.startsWith('.') ? file : `.${file}`);
- return SUPPRORTED_EXT.indexOf(ext.toLowerCase()) > -1;
+ return SUPPORTED_EXT.indexOf(ext.toLowerCase()) > -1;
}
@@ -80,8 +87,9 @@ export class Helper {
const ignoreFiles = [];
ignorePathGlob.forEach(ignoredPath => {
- if (!ignoredPath.startsWith('/') || !ignoredPath.startsWith('\\'))
- ignoreFiles.push(workspacePath + path.sep + ignoredPath);
+ if (isRelativePath(ignoredPath))
+ ignoreFiles.push(path.join(workspacePath, ignoredPath));
+ else ignoreFiles.push(ignoredPath);
});
const proxy = Helper.getProxySetup();
@@ -145,4 +153,4 @@ export class Helper {
return proxy;
}
-}
\ No newline at end of file
+}
diff --git a/src/LiveServerHelper.ts b/src/LiveServerHelper.ts
index 70722081..d1cae4eb 100644
--- a/src/LiveServerHelper.ts
+++ b/src/LiveServerHelper.ts
@@ -1,20 +1,18 @@
'use strict';
-import * as liveServer from 'live-server';
-import * as httpShutdown from 'http-shutdown';
export class LiveServerHelper {
static StartServer(params, callback) {
setTimeout(() => {
try {
- let ServerInstance = liveServer.start(params);
+ let ServerInstance = require('live-server').start(params);
setTimeout(() => {
if (!ServerInstance._connectionKey) {
return callback({});
}
- httpShutdown(ServerInstance);
+ require('http-shutdown')(ServerInstance);
return callback(ServerInstance);
}, 1000);
@@ -34,7 +32,7 @@ export class LiveServerHelper {
// callback(); /*only Working first time, Unknown Bug*/
});
LiveServerInstance.close();
- liveServer.shutdown();
+ require('live-server').shutdown();
setTimeout(() => { callback(); }, 1000);
}
}
\ No newline at end of file
diff --git a/src/StatusbarUi.ts b/src/StatusbarUi.ts
index 294684ac..f54a0775 100644
--- a/src/StatusbarUi.ts
+++ b/src/StatusbarUi.ts
@@ -18,10 +18,7 @@ export class StatusbarUi {
}
static Init() {
- StatusbarUi.Working('loading...');
- setTimeout(function () {
- StatusbarUi.Live();
- }, 1000);
+ StatusbarUi.Live();
}
static Working(workingMsg: string = 'Working on it...') {
diff --git a/src/announcement/index.ts b/src/announcement/index.ts
index 19af49d2..35fff8f0 100644
--- a/src/announcement/index.ts
+++ b/src/announcement/index.ts
@@ -1,27 +1,26 @@
import { Memento, extensions, window } from 'vscode';
-import * as opn from 'opn';
-const SETUP_STRING = 'liveServer.setup.version';
+export const SETUP_STRING = 'liveServer.setup.version';
export async function checkNewAnnouncement(memento: Memento) {
const packageJSON = extensions.getExtension('ritwickdey.LiveServer').packageJSON;
- const announment = packageJSON.announcement;
+ const announcement = packageJSON.announcement;
- if (!announment && Object.keys(announment).length === 0) return;
+ if (!announcement && Object.keys(announcement).length === 0) return;
const stateVersion = await memento.get(SETUP_STRING) || '0.0.0';
const installedVersion = packageJSON.version;
- if (stateVersion !== installedVersion && installedVersion === announment.onVersion) {
+ if (stateVersion !== installedVersion && installedVersion === announcement.onVersion) {
await memento.update(SETUP_STRING, installedVersion);
const showDetails = 'Show Details';
- const choice = await window.showInformationMessage(announment.message, showDetails);
+ const choice = await window.showInformationMessage(announcement.message, showDetails);
if (choice === showDetails) {
- const url = announment.url || 'https://github.com/ritwickdey/vscode-live-server';
- opn(url);
+ const url = announcement.url || 'https://github.com/ritwickdey/vscode-live-server';
+ require('opn')(url);
}
}
-}
\ No newline at end of file
+}
diff --git a/src/appModel.ts b/src/appModel.ts
index 6ec40755..65b7f868 100644
--- a/src/appModel.ts
+++ b/src/appModel.ts
@@ -1,24 +1,20 @@
'use strict';
-import { window, workspace, Event, EventEmitter } from 'vscode';
+import { commands, window, workspace, Event, EventEmitter } from 'vscode';
import { LiveServerHelper } from './LiveServerHelper';
import { StatusbarUi } from './StatusbarUi';
import { Config } from './Config';
-import { Helper, SUPPRORTED_EXT } from './Helper';
+import { Helper, SUPPORTED_EXT } from './Helper';
import { workspaceResolver, setOrChangeWorkspace } from './workspaceResolver';
import { IAppModel, GoLiveEvent, GoOfflineEvent } from './IAppModel';
import { LiveShareHelper } from './LiveShareHelper';
-import * as opn from 'opn';
-import * as ips from 'ips';
-
export class AppModel implements IAppModel {
private IsServerRunning: boolean;
- private IsStaging: boolean;
+ private isServerBusy: boolean;
private LiveServerInstance;
- private localIps: any;
private previousWorkspacePath: string;
private readonly goLiveEvent = new EventEmitter();
@@ -35,16 +31,12 @@ export class AppModel implements IAppModel {
}
constructor() {
- const _ips = ips();
- this.localIps = _ips.local ? _ips.local : Config.getHost;
this.IsServerRunning = false;
this.runningPort = null;
this.liveShareHelper = new LiveShareHelper(this);
- this.haveAnySupportedFile().then(() => {
- StatusbarUi.Init();
- });
+ StatusbarUi.Init();
}
public async Golive(pathUri?: string) {
@@ -74,16 +66,20 @@ export class AppModel implements IAppModel {
);
}
if (pathInfos.isNotOkay) {
- this.showPopUpMsg('Invaild Path in liveServer.settings.root settings. live Server will serve from workspace root', true);
+ this.showPopUpMsg('Invalid Path in liveServer.settings.root settings. live Server will serve from workspace root', true);
}
- if (this.IsStaging) return;
+ if (this.isServerBusy) return;
let params = Helper.generateParams(pathInfos.rootPath, workspacePath, () => {
this.tagMissedCallback();
});
- LiveServerHelper.StartServer(params, (serverInstance) => {
+ this.isServerBusy = true;
+ StatusbarUi.Working('Starting...');
+
+ LiveServerHelper.StartServer(params, async (serverInstance) => {
+ this.isServerBusy = false;
if (serverInstance && serverInstance.address) {
this.LiveServerInstance = serverInstance;
this.runningPort = serverInstance.address().port;
@@ -100,44 +96,44 @@ export class AppModel implements IAppModel {
}
}
else {
- if (!serverInstance.errorMsg)
- this.showPopUpMsg(`Error on port ${Config.getPort}. Please try to change the port through settings or report on GitHub.`, true);
- else
- this.showPopUpMsg(`Something is went wrong! Please check into Developer Console or report on GitHub.`, true);
+ if (!serverInstance.errorMsg) {
+ await Config.setPort(Config.getPort + 1); // + 1 will be fine
+ this.showPopUpMsg(`The default port : ${Config.getPort - 1} is currently taken, changing port to : ${Config.getPort}.`);
+ this.Golive(pathUri);
+ } else {
+ this.showPopUpMsg(`Something went wrong! Please check into Developer Console or report on GitHub.`, true);
+ }
this.IsServerRunning = true; // to revert status - cheat :p
this.ToggleStatusBar(); // reverted
}
});
- this.IsStaging = true;
- StatusbarUi.Working('Starting...');
}
public GoOffline() {
- if (this.IsStaging) return;
+ if (this.isServerBusy) return;
if (!this.IsServerRunning) {
this.showPopUpMsg(`Server is not already running`);
return;
}
this.goOfflineEvent.fire({ runningPort: this.runningPort });
+ this.isServerBusy = true;
+ StatusbarUi.Working('Disposing...');
LiveServerHelper.StopServer(this.LiveServerInstance, () => {
this.showPopUpMsg('Server is now offline.');
+ this.isServerBusy = false;
this.ToggleStatusBar();
this.LiveServerInstance = null;
this.runningPort = null;
this.previousWorkspacePath = null;
});
- this.IsStaging = true;
-
- StatusbarUi.Working('Disposing...');
-
}
changeWorkspaceRoot() {
setOrChangeWorkspace()
- .then(workspceName => {
- if (workspceName === undefined) return;
- window.showInformationMessage(`Success! '${workspceName}' workspace is now root of Live Server`);
+ .then(workspaceName => {
+ if (workspaceName === undefined) return;
+ window.showInformationMessage(`Success! '${workspaceName}' workspace is now root of Live Server`);
// If server is running, Turn off the server.
if (this.IsServerRunning)
this.GoOffline();
@@ -151,7 +147,7 @@ export class AppModel implements IAppModel {
this.previousWorkspacePath &&
this.previousWorkspacePath !== workspacePath
) {
- this.showPopUpMsg(`Server is already running from diffrent workspace.`, true);
+ this.showPopUpMsg(`Server is already running from different workspace.`, true);
return false;
}
else this.previousWorkspacePath = workspacePath;
@@ -159,7 +155,7 @@ export class AppModel implements IAppModel {
}
private tagMissedCallback() {
- this.showPopUpMsg('Live Reload is not possible without body or head tag.', null, true);
+ this.showPopUpMsg('Live Reload is not possible without a head or body tag.', null, true);
}
private showPopUpMsg(msg: string, isErrorMsg: boolean = false, isWarning: boolean = false) {
@@ -169,8 +165,8 @@ export class AppModel implements IAppModel {
else if (isWarning && !Config.getDonotVerifyTags) {
const donotShowMsg = 'I understand, Don\'t show again';
window.showWarningMessage(msg, donotShowMsg)
- .then(choise => {
- if (choise && choise === donotShowMsg) {
+ .then(choice => {
+ if (choice && choice === donotShowMsg) {
Config.setDonotVerifyTags(true, true);
}
});
@@ -189,7 +185,6 @@ export class AppModel implements IAppModel {
}
private ToggleStatusBar() {
- this.IsStaging = false;
if (!this.IsServerRunning) {
StatusbarUi.Offline(this.runningPort || Config.getPort);
}
@@ -202,7 +197,7 @@ export class AppModel implements IAppModel {
private haveAnySupportedFile() {
return new Promise(resolve => {
- const globFormat = `**/*[${SUPPRORTED_EXT.join(' | ')}]`;
+ const globFormat = `**/*[${SUPPORTED_EXT.join(' | ')}]`;
workspace.findFiles(globFormat, '**/node_modules/**', 1)
.then(async (files) => {
if (files && files.length) return resolve();
@@ -211,7 +206,7 @@ export class AppModel implements IAppModel {
}
private openBrowser(port: number, path: string) {
- const host = Config.getLocalIp ? this.localIps : Config.getHost;
+ const host = (Config.getLocalIp ? require('ips')().local : Config.getHost) || '127.0.0.1';
const protocol = Config.getHttps.enable ? 'https' : 'http';
let params: string[] = [];
@@ -219,6 +214,7 @@ export class AppModel implements IAppModel {
if (path.startsWith('\\') || path.startsWith('/')) {
path = path.substring(1, path.length);
}
+
path = path.replace(/\\/gi, '/');
if (advanceCustomBrowserCmd) {
@@ -278,17 +274,17 @@ export class AppModel implements IAppModel {
}
try {
- opn(`${protocol}://${host}:${port}/${path}`, { app: params || [''] });
+ require('opn')(`${protocol}://${host}:${port}/${path}`, { app: params || [''] });
} catch (error) {
- this.showPopUpMsg(`Server is started at ${this.runningPort} but failed to open browser. Try to change the CustomBrowser settings.`, true);
+ this.showPopUpMsg(`Server is started at ${host}:${this.runningPort} but failed to open browser. Try to change the CustomBrowser settings.`, true);
console.log('\n\nError Log to open Browser : ', error);
console.log('\n\n');
}
}
public dispose() {
+ this.GoOffline();
StatusbarUi.dispose();
+ this.liveShareHelper.dispose();
}
}
-
-
diff --git a/src/extension.ts b/src/extension.ts
index 4ab6a106..85b22662 100644
--- a/src/extension.ts
+++ b/src/extension.ts
@@ -2,17 +2,21 @@
import { ExtensionContext, workspace, commands, window } from 'vscode';
import { AppModel } from './appModel';
-import { checkNewAnnouncement } from './announcement';
+import { checkNewAnnouncement, SETUP_STRING } from './announcement';
export function activate(context: ExtensionContext) {
- const appModel = new AppModel();
+ const appModel = new AppModel();
+
+ Promise.resolve().then(() => {
+ context.globalState.setKeysForSync([SETUP_STRING]);
+ checkNewAnnouncement(context.globalState);
+ });
+
- checkNewAnnouncement(context.globalState);
context.subscriptions.push(commands
- .registerCommand('extension.liveServer.goOnline', (fileUri) => {
- workspace.saveAll().then(() => {
- appModel.Golive(fileUri ? fileUri.fsPath : null);
- });
+ .registerCommand('extension.liveServer.goOnline', async (fileUri) => {
+ await workspace.saveAll();
+ appModel.Golive(fileUri ? fileUri.fsPath : null);
})
);
@@ -28,15 +32,6 @@ export function activate(context: ExtensionContext) {
})
);
- // context.subscriptions.push(window
- // .onDidChangeActiveTextEditor(() => {
- // if (window.activeTextEditor === undefined) return;
- // if (workspace.rootPath === undefined && Helper.IsSupportedFile(window.activeTextEditor.document.fileName)) {
- // StatusbarUi.Init();
- // }
- // })
- // );
-
context.subscriptions.push(appModel);
}
diff --git a/src/workspaceResolver.ts b/src/workspaceResolver.ts
index c1b1bbbf..b3c7115e 100644
--- a/src/workspaceResolver.ts
+++ b/src/workspaceResolver.ts
@@ -10,7 +10,7 @@ export function setOrChangeWorkspace() {
ignoreFocusOut: true
}).then(workspaceName => {
if (workspaceName) {
- return Config.setMutiRootWorkspaceName(workspaceName).then(() => workspaceName);
+ return Config.setMultiRootWorkspaceName(workspaceName).then(() => workspaceName);
}
});
}
@@ -30,20 +30,20 @@ export function workspaceResolver(fileUri?: string) {
if (fileUri) {
const selectedWorkspace = workspaceFolders.find(ws => fileUri.startsWith(ws.uri.fsPath));
if (selectedWorkspace) {
- return Config.setMutiRootWorkspaceName(selectedWorkspace.name)
+ return Config.setMultiRootWorkspaceName(selectedWorkspace.name)
.then(() => resolve(selectedWorkspace.uri.fsPath));
}
}
// If workspace already set by User
- if (Config.getMutiRootWorkspaceName) {
+ if (Config.getMultiRootWorkspaceName) {
// A small test that the WorkspaceName (set by user) is valid
- const targetWorkspace = workspaceFolders.find(e => e.name === Config.getMutiRootWorkspaceName);
+ const targetWorkspace = workspaceFolders.find(e => e.name === Config.getMultiRootWorkspaceName);
if (targetWorkspace)
return resolve(targetWorkspace.uri.fsPath);
// reset whatever user is set.
- Config.setMutiRootWorkspaceName(null);
+ Config.setMultiRootWorkspaceName(null);
}
// Show a quick picker
diff --git a/test/e2e/example.e2e.ts b/test/e2e/example.e2e.ts
new file mode 100644
index 00000000..64ba8908
--- /dev/null
+++ b/test/e2e/example.e2e.ts
@@ -0,0 +1,57 @@
+import { remote } from 'webdriverio';
+
+describe('VSCode Live Server Extension', () => {
+ let port: number;
+ let browser: WebdriverIO.Browser;
+
+ before('start browser', async () => {
+ browser = await remote({
+ capabilities: { browserName: 'chrome' }
+ });
+ const workbench = await driver.getWorkbench();
+
+ /**
+ * wait until all notifications are removed because sometimes
+ * VSCode supresses notifications if others pop up
+ */
+ await workbench.elem.waitUntil(async () => {
+ const notifications = await workbench.getNotifications();
+ for (const n of notifications) {
+ await n.dismiss();
+ }
+ return (await workbench.getNotifications()).length === 0;
+ });
+ });
+
+ it('should click on Go Live', async () => {
+ const workbench = await driver.getWorkbench();
+ await workbench.elem.$('div[id="ritwickdey.LiveServer"]').click();
+
+ await workbench.elem.waitUntil(async () => {
+ const notifications = await workbench.getNotifications();
+ for (const notification of notifications) {
+ const message = await notification.getMessage();
+ if (message.startsWith('Server is Started')) {
+ port = parseInt(message.split(' : ')[1], 10);
+ return true;
+ }
+ }
+ return false;
+ }, { timeout: 10000 });
+ });
+
+ it('should be able to open started server', async () => {
+ await browser.url(`http://localhost:${port}`);
+ await expect(browser).toHaveTitle('listing directory /');
+ });
+
+ it('should show content of root directory and serve files', async () => {
+ await browser.$('span=README.md').click();
+ expect(await browser.getPageSource()).toContain('# Live Server');
+ });
+
+ after('shutdown browser', () => {
+ return browser.deleteSession();
+ });
+});
+
diff --git a/test/index.ts b/test/index.ts
deleted file mode 100644
index 1e9a8a5c..00000000
--- a/test/index.ts
+++ /dev/null
@@ -1,22 +0,0 @@
-//
-// PLEASE DO NOT MODIFY / DELETE UNLESS YOU KNOW WHAT YOU ARE DOING
-//
-// This file is providing the test runner to use when running extension tests.
-// By default the test runner in use is Mocha based.
-//
-// You can provide your own test runner if you want to override it by exporting
-// a function run(testRoot: string, clb: (error:Error) => void) that the extension
-// host can call to run the tests. The test runner is expected to use console.log
-// to report the results back to the caller. When the tests are finished, return
-// a possible error to the callback or null if none.
-
-let testRunner = require('vscode/lib/testrunner');
-
-// You can directly control Mocha options by uncommenting the following lines
-// See https://github.com/mochajs/mocha/wiki/Using-mocha-programmatically#set-options for more info
-testRunner.configure({
- ui: 'tdd', // the TDD UI is being used in extension.test.ts (suite, test, etc.)
- useColors: true // colored output from test results
-});
-
-module.exports = testRunner;
diff --git a/test/runTest.ts b/test/runTest.ts
new file mode 100644
index 00000000..743e24df
--- /dev/null
+++ b/test/runTest.ts
@@ -0,0 +1,24 @@
+/* tslint-disable */
+import * as path from 'path';
+
+import { runTests } from '@vscode/test-electron';
+
+async function main() {
+ try {
+ // The folder containing the Extension Manifest package.json
+ // Passed to `--extensionDevelopmentPath`
+ const extensionDevelopmentPath = path.resolve(__dirname, '../../');
+
+ // The path to the extension test script
+ // Passed to --extensionTestsPath
+ const extensionTestsPath = path.resolve(__dirname, './suite/index');
+
+ // Download VS Code, unzip it and run the integration test
+ await runTests({ extensionDevelopmentPath, extensionTestsPath });
+ } catch (err) {
+ console.error('Failed to run tests');
+ process.exit(1);
+ }
+}
+
+main();
diff --git a/test/extension.test.ts b/test/suite/extension.test.ts
similarity index 96%
rename from test/extension.test.ts
rename to test/suite/extension.test.ts
index 445f888e..80dee16d 100644
--- a/test/extension.test.ts
+++ b/test/suite/extension.test.ts
@@ -9,7 +9,7 @@ import * as assert from 'assert';
// You can import and use all API from the 'vscode' module
// as well as import your extension to test it
import * as vscode from 'vscode';
-import * as myExtension from '../src/extension';
+import * as myExtension from '../../src/extension';
// Defines a Mocha test suite to group tests of similar kind together
suite('Extension Tests', () => {
diff --git a/test/helper.test.ts b/test/suite/helper.test.ts
similarity index 98%
rename from test/helper.test.ts
rename to test/suite/helper.test.ts
index f4a3488e..d49bd0bf 100644
--- a/test/helper.test.ts
+++ b/test/suite/helper.test.ts
@@ -1,7 +1,7 @@
import * as assert from 'assert';
import * as vscode from 'vscode';
-import { Helper } from '../src/Helper';
+import { Helper } from '../../src/Helper';
suite('Helper Tests', () => {
diff --git a/test/suite/index.ts b/test/suite/index.ts
new file mode 100644
index 00000000..db53422f
--- /dev/null
+++ b/test/suite/index.ts
@@ -0,0 +1,38 @@
+import * as path from 'path';
+import Mocha from 'mocha';
+import glob from 'glob';
+
+export function run(): Promise {
+ // Create the mocha test
+ const mocha = new Mocha({
+ ui: 'tdd',
+ color: true
+ });
+
+ const testsRoot = path.resolve(__dirname, '..');
+
+ return new Promise((c, e) => {
+ glob('**/**.test.js', { cwd: testsRoot }, (err, files) => {
+ if (err) {
+ return e(err);
+ }
+
+ // Add files to the test suite
+ files.forEach((f) => mocha.addFile(path.resolve(testsRoot, f)));
+
+ try {
+ // Run the mocha test
+ mocha.run((failures) => {
+ if (failures > 0) {
+ e(new Error(`${failures} tests failed.`));
+ } else {
+ c();
+ }
+ });
+ } catch (err) {
+ console.error(err);
+ e(err);
+ }
+ });
+ });
+}
diff --git a/test/wdio.conf.ts b/test/wdio.conf.ts
new file mode 100644
index 00000000..2a08f80f
--- /dev/null
+++ b/test/wdio.conf.ts
@@ -0,0 +1,315 @@
+import * as path from 'path';
+import type { Options } from '@wdio/types';
+import type { VSCodeCapabilities, VSCodeOptions } from 'wdio-vscode-service/dist/types';
+
+export const config: Options.Testrunner = {
+ //
+ // ====================
+ // Runner Configuration
+ // ====================
+ //
+ //
+ // =====================
+ // ts-node Configurations
+ // =====================
+ //
+ // You can write tests using TypeScript to get autocompletion and type safety.
+ // You will need typescript and ts-node installed as devDependencies.
+ // WebdriverIO will automatically detect if these dependencies are installed
+ // and will compile your config and tests for you.
+ // If you need to configure how ts-node runs please use the
+ // environment variables for ts-node or use wdio config's autoCompileOpts section.
+ //
+ autoCompileOpts: {
+ autoCompile: true,
+ // see https://github.com/TypeStrong/ts-node#cli-and-programmatic-options
+ // for all available options
+ tsNodeOpts: {
+ transpileOnly: true,
+ project: path.join(__dirname, '..', '/tsconfig.json')
+ }
+ // tsconfig-paths is only used if "tsConfigPathsOpts" are provided, if you
+ // do please make sure "tsconfig-paths" is installed as dependency
+ // tsConfigPathsOpts: {
+ // baseUrl: './'
+ // }
+ },
+ //
+ // ==================
+ // Specify Test Files
+ // ==================
+ // Define which test specs should run. The pattern is relative to the directory
+ // from which `wdio` was called.
+ //
+ // The specs are defined as an array of spec files (optionally using wildcards
+ // that will be expanded). The test for each spec file will be run in a separate
+ // worker process. In order to have a group of spec files run in the same worker
+ // process simply enclose them in an array within the specs array.
+ //
+ // If you are calling `wdio` from an NPM script (see https://docs.npmjs.com/cli/run-script),
+ // then the current working directory is where your `package.json` resides, so `wdio`
+ // will be called from there.
+ //
+ specs: [
+ path.join(__dirname, '/e2e/**/*.e2e.ts')
+ ],
+ // Patterns to exclude.
+ exclude: [
+ // 'path/to/excluded/files'
+ ],
+ //
+ // ============
+ // Capabilities
+ // ============
+ // Define your capabilities here. WebdriverIO can run multiple capabilities at the same
+ // time. Depending on the number of capabilities, WebdriverIO launches several test
+ // sessions. Within your capabilities you can overwrite the spec and exclude options in
+ // order to group specific specs to a specific capability.
+ //
+ // First, you can define how many instances should be started at the same time. Let's
+ // say you have 3 different capabilities (Chrome, Firefox, and Safari) and you have
+ // set maxInstances to 1; wdio will spawn 3 processes. Therefore, if you have 10 spec
+ // files and you set maxInstances to 10, all spec files will get tested at the same time
+ // and 30 processes will get spawned. The property handles how many capabilities
+ // from the same test should run tests.
+ //
+ maxInstances: 10,
+ //
+ // If you have trouble getting all important capabilities together, check out the
+ // Sauce Labs platform configurator - a great tool to configure your capabilities:
+ // https://saucelabs.com/platform/platform-configurator
+ //
+ capabilities: [{
+ browserName: 'vscode',
+ 'wdio:vscodeOptions': {
+ extensionPath: path.join(__dirname, '..'),
+ workspacePath: path.join(__dirname, '..'),
+ userSettings: {
+ 'liveServer.settings.NoBrowser': true
+ }
+ } as Partial
+ } as VSCodeCapabilities],
+ //
+ // ===================
+ // Test Configurations
+ // ===================
+ // Define all options that are relevant for the WebdriverIO instance here
+ //
+ // Level of logging verbosity: trace | debug | info | warn | error | silent
+ logLevel: 'info',
+ //
+ // Set specific log levels per logger
+ // loggers:
+ // - webdriver, webdriverio
+ // - @wdio/browserstack-service, @wdio/devtools-service, @wdio/sauce-service
+ // - @wdio/mocha-framework, @wdio/jasmine-framework
+ // - @wdio/local-runner
+ // - @wdio/sumologic-reporter
+ // - @wdio/cli, @wdio/config, @wdio/utils
+ // Level of logging verbosity: trace | debug | info | warn | error | silent
+ // logLevels: {
+ // webdriver: 'info',
+ // '@wdio/appium-service': 'info'
+ // },
+ //
+ // If you only want to run your tests until a specific amount of tests have failed use
+ // bail (default is 0 - don't bail, run all tests).
+ bail: 0,
+ //
+ // Set a base URL in order to shorten url command calls. If your `url` parameter starts
+ // with `/`, the base url gets prepended, not including the path portion of your baseUrl.
+ // If your `url` parameter starts without a scheme or `/` (like `some/path`), the base url
+ // gets prepended directly.
+ baseUrl: 'http://localhost',
+ //
+ // Default timeout for all waitFor* commands.
+ waitforTimeout: 10000,
+ //
+ // Default timeout in milliseconds for request
+ // if browser driver or grid doesn't send response
+ connectionRetryTimeout: 120000,
+ //
+ // Default request retries count
+ connectionRetryCount: 3,
+ //
+ // Test runner services
+ // Services take over a specific job you don't want to take care of. They enhance
+ // your test setup with almost no effort. Unlike plugins, they don't add new
+ // commands. Instead, they hook themselves up into the test process.
+ services: ['vscode'],
+
+ // Framework you want to run your specs with.
+ // The following are supported: Mocha, Jasmine, and Cucumber
+ // see also: https://webdriver.io/docs/frameworks
+ //
+ // Make sure you have the wdio adapter package for the specific framework installed
+ // before running any tests.
+ framework: 'mocha',
+ //
+ // The number of times to retry the entire specfile when it fails as a whole
+ // specFileRetries: 1,
+ //
+ // Delay in seconds between the spec file retry attempts
+ // specFileRetriesDelay: 0,
+ //
+ // Whether or not retried specfiles should be retried immediately or deferred to the end of the queue
+ // specFileRetriesDeferred: false,
+ //
+ // Test reporter for stdout.
+ // The only one supported by default is 'dot'
+ // see also: https://webdriver.io/docs/dot-reporter
+ reporters: ['spec'],
+ //
+ // Options to be passed to Mocha.
+ // See the full list at http://mochajs.org/
+ mochaOpts: {
+ ui: 'bdd',
+ timeout: 60000,
+ bail: true
+ },
+ //
+ // =====
+ // Hooks
+ // =====
+ // WebdriverIO provides several hooks you can use to interfere with the test process in order to enhance
+ // it and to build services around it. You can either apply a single function or an array of
+ // methods to it. If one of them returns with a promise, WebdriverIO will wait until that promise got
+ // resolved to continue.
+ /**
+ * Gets executed once before all workers get launched.
+ * @param {Object} config wdio configuration object
+ * @param {Array.} capabilities list of capabilities details
+ */
+ // onPrepare: function (config, capabilities) {
+ // },
+ /**
+ * Gets executed before a worker process is spawned and can be used to initialise specific service
+ * for that worker as well as modify runtime environments in an async fashion.
+ * @param {String} cid capability id (e.g 0-0)
+ * @param {[type]} caps object containing capabilities for session that will be spawn in the worker
+ * @param {[type]} specs specs to be run in the worker process
+ * @param {[type]} args object that will be merged with the main configuration once worker is initialized
+ * @param {[type]} execArgv list of string arguments passed to the worker process
+ */
+ // onWorkerStart: function (cid, caps, specs, args, execArgv) {
+ // },
+ /**
+ * Gets executed just after a worker process has exited.
+ * @param {String} cid capability id (e.g 0-0)
+ * @param {Number} exitCode 0 - success, 1 - fail
+ * @param {[type]} specs specs to be run in the worker process
+ * @param {Number} retries number of retries used
+ */
+ // onWorkerEnd: function (cid, exitCode, specs, retries) {
+ // },
+ /**
+ * Gets executed just before initialising the webdriver session and test framework. It allows you
+ * to manipulate configurations depending on the capability or spec.
+ * @param {Object} config wdio configuration object
+ * @param {Array.} capabilities list of capabilities details
+ * @param {Array.} specs List of spec file paths that are to be run
+ * @param {String} cid worker id (e.g. 0-0)
+ */
+ // beforeSession: function (config, capabilities, specs, cid) {
+ // },
+ /**
+ * Gets executed before test execution begins. At this point you can access to all global
+ * variables like `browser`. It is the perfect place to define custom commands.
+ * @param {Array.} capabilities list of capabilities details
+ * @param {Array.} specs List of spec file paths that are to be run
+ * @param {Object} browser instance of created browser/device session
+ */
+ // before: function (capabilities, specs) {
+ // },
+ /**
+ * Runs before a WebdriverIO command gets executed.
+ * @param {String} commandName hook command name
+ * @param {Array} args arguments that command would receive
+ */
+ // beforeCommand: function (commandName, args) {
+ // },
+ /**
+ * Hook that gets executed before the suite starts
+ * @param {Object} suite suite details
+ */
+ // beforeSuite: function (suite) {
+ // },
+ /**
+ * Function to be executed before a test (in Mocha/Jasmine) starts.
+ */
+ // beforeTest: function (test, context) {
+ // },
+ /**
+ * Hook that gets executed _before_ a hook within the suite starts (e.g. runs before calling
+ * beforeEach in Mocha)
+ */
+ // beforeHook: function (test, context) {
+ // },
+ /**
+ * Hook that gets executed _after_ a hook within the suite starts (e.g. runs after calling
+ * afterEach in Mocha)
+ */
+ // afterHook: function (test, context, { error, result, duration, passed, retries }) {
+ // },
+ /**
+ * Function to be executed after a test (in Mocha/Jasmine only)
+ * @param {Object} test test object
+ * @param {Object} context scope object the test was executed with
+ * @param {Error} result.error error object in case the test fails, otherwise `undefined`
+ * @param {Any} result.result return object of test function
+ * @param {Number} result.duration duration of test
+ * @param {Boolean} result.passed true if test has passed, otherwise false
+ * @param {Object} result.retries informations to spec related retries, e.g. `{ attempts: 0, limit: 0 }`
+ */
+ // afterTest: function(test, context, { error, result, duration, passed, retries }) {
+ // },
+ /**
+ * Hook that gets executed after the suite has ended
+ * @param {Object} suite suite details
+ */
+ // afterSuite: function (suite) {
+ // },
+ /**
+ * Runs after a WebdriverIO command gets executed
+ * @param {String} commandName hook command name
+ * @param {Array} args arguments that command would receive
+ * @param {Number} result 0 - command success, 1 - command error
+ * @param {Object} error error object if any
+ */
+ // afterCommand: function (commandName, args, result, error) {
+ // },
+ /**
+ * Gets executed after all tests are done. You still have access to all global variables from
+ * the test.
+ * @param {Number} result 0 - test pass, 1 - test fail
+ * @param {Array.} capabilities list of capabilities details
+ * @param {Array.} specs List of spec file paths that ran
+ */
+ // after: function (result, capabilities, specs) {
+ // },
+ /**
+ * Gets executed right after terminating the webdriver session.
+ * @param {Object} config wdio configuration object
+ * @param {Array.} capabilities list of capabilities details
+ * @param {Array.} specs List of spec file paths that ran
+ */
+ // afterSession: function (config, capabilities, specs) {
+ // },
+ /**
+ * Gets executed after all workers got shut down and the process is about to exit. An error
+ * thrown in the onComplete hook will result in the test run failing.
+ * @param {Object} exitCode 0 - success, 1 - fail
+ * @param {Object} config wdio configuration object
+ * @param {Array.} capabilities list of capabilities details
+ * @param {} results object containing test results
+ */
+ // onComplete: function(exitCode, config, capabilities, results) {
+ // },
+ /**
+ * Gets executed when a refresh happens.
+ * @param {String} oldSessionId session ID of the old session
+ * @param {String} newSessionId session ID of the new session
+ */
+ // onReload: function(oldSessionId, newSessionId) {
+ // }
+};
diff --git a/tsconfig.json b/tsconfig.json
index 158b59f6..4b277dea 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -2,12 +2,22 @@
"compilerOptions": {
"module": "commonjs",
"target": "es6",
+ "skipLibCheck": true,
"outDir": "out",
"lib": [
- "es6"
+ "es6",
+ "DOM"
],
"sourceMap": true,
- "rootDir": "."
+ "esModuleInterop": true,
+ "rootDir": ".",
+ "types": [
+ "node",
+ "webdriverio/async",
+ "@wdio/mocha-framework",
+ "expect-webdriverio",
+ "wdio-vscode-service"
+ ]
},
"exclude": [
"node_modules",