Perfect the codebase for wamr-ide (#1817)

Fix errors and warnings reported by eslint
Add CONTRIBUTING document for vscode-extension
This commit is contained in:
Wang Ning
2022-12-27 15:04:36 +08:00
committed by GitHub
parent 676c3c7b04
commit 679a8ab3cb
14 changed files with 316 additions and 299 deletions

View File

@ -15,35 +15,37 @@ import {
import { getUri } from '../utilities/getUri';
export class NewProjectPanel {
static USER_SET_WORKSPACE: string;
public static userSetWorkSpace: string;
public static currentPanel: NewProjectPanel | undefined;
private readonly _panel: vscode.WebviewPanel;
private _disposables: vscode.Disposable[] = [];
private readonly viewPanel: vscode.WebviewPanel;
private disposableArr: vscode.Disposable[] = [];
static readonly EXCUTION_SUCCESS: number = 0;
static readonly DIR_EXSITED_ERR: number = -1;
static readonly USER_INTPUT_ERR: number = -2;
static readonly DIR_PATH_INVALID_ERR: number = -3;
private static readonly executionSuccess = 0;
private static readonly dirExistedError = -1;
private static readonly userInputError = -2;
private static readonly dirPathInvalidError = -3;
constructor(extensionUri: vscode.Uri, panel: vscode.WebviewPanel) {
this._panel = panel;
this._panel.webview.html = this._getHtmlForWebview(
this._panel.webview,
this.viewPanel = panel;
this.viewPanel.webview.html = this.getHtmlForWebview(
this.viewPanel.webview,
extensionUri,
'resource/webview/page/newProject.html'
);
this._setWebviewMessageListener(this._panel.webview, extensionUri);
this._panel.onDidDispose(this.dispose, null, this._disposables);
this._setWebviewMessageListener(this.viewPanel.webview, extensionUri);
this.viewPanel.onDidDispose(this.dispose, null, this.disposableArr);
}
public static render(context: vscode.ExtensionContext) {
NewProjectPanel.USER_SET_WORKSPACE = vscode.workspace
public static render(context: vscode.ExtensionContext): void {
NewProjectPanel.userSetWorkSpace = vscode.workspace
.getConfiguration()
.get('WAMR-IDE.configWorkspace') as string;
/* check if current panel is initialized */
if (NewProjectPanel.currentPanel) {
NewProjectPanel.currentPanel._panel.reveal(vscode.ViewColumn.One);
NewProjectPanel.currentPanel.viewPanel.reveal(
vscode.ViewColumn.One
);
} else {
const panel = vscode.window.createWebviewPanel(
'newProject',
@ -62,25 +64,25 @@ export class NewProjectPanel {
}
}
private _creatNewProject(
private createNewProject(
projName: string,
template: string,
extensionUri: vscode.Uri
): number {
if (projName === '' || template === '') {
return NewProjectPanel.USER_INTPUT_ERR;
return NewProjectPanel.userInputError;
}
if (!checkFolderName(projName)) {
return NewProjectPanel.DIR_PATH_INVALID_ERR;
return NewProjectPanel.dirPathInvalidError;
}
let ROOT_PATH = path.join(NewProjectPanel.USER_SET_WORKSPACE, projName);
let EXT_PATH = extensionUri.fsPath;
const ROOT_PATH = path.join(NewProjectPanel.userSetWorkSpace, projName);
const EXT_PATH = extensionUri.fsPath;
if (fs.existsSync(ROOT_PATH)) {
if (fs.lstatSync(ROOT_PATH).isDirectory()) {
return NewProjectPanel.DIR_EXSITED_ERR;
return NewProjectPanel.dirExistedError;
}
}
@ -98,14 +100,14 @@ export class NewProjectPanel {
path.join(ROOT_PATH, '.wamr/project.cmake')
);
return NewProjectPanel.EXCUTION_SUCCESS;
return NewProjectPanel.executionSuccess;
}
public _getHtmlForWebview(
public getHtmlForWebview(
webview: vscode.Webview,
extensionUri: vscode.Uri,
templatePath: string
) {
): string {
const toolkitUri = getUri(webview, extensionUri, [
'node_modules',
'@vscode',
@ -146,14 +148,14 @@ export class NewProjectPanel {
message => {
switch (message.command) {
case 'create_new_project':
let createNewProjectStatus = this._creatNewProject(
const createNewProjectStatus = this.createNewProject(
message.projectName,
message.template,
extensionUri
);
if (
createNewProjectStatus ===
NewProjectPanel.EXCUTION_SUCCESS
NewProjectPanel.executionSuccess
) {
webview.postMessage({
command: 'proj_creation_finish',
@ -161,17 +163,17 @@ export class NewProjectPanel {
});
} else if (
createNewProjectStatus ===
NewProjectPanel.DIR_EXSITED_ERR
NewProjectPanel.dirExistedError
) {
vscode.window.showErrorMessage(
'Project : ' +
message.projectName +
' exsits in your current root path, please change project name or root path!'
' exists in your current root path, please change project name or root path!'
);
return;
} else if (
createNewProjectStatus ===
NewProjectPanel.USER_INTPUT_ERR
NewProjectPanel.userInputError
) {
vscode.window.showErrorMessage(
'Please fill chart before your submit!'
@ -179,7 +181,7 @@ export class NewProjectPanel {
return;
} else if (
createNewProjectStatus ===
NewProjectPanel.DIR_PATH_INVALID_ERR
NewProjectPanel.dirPathInvalidError
) {
if (os.platform() === 'win32') {
vscode.window.showErrorMessage(
@ -203,19 +205,18 @@ export class NewProjectPanel {
message.projectName +
' will be opened!'
);
let isWorkspaceEmpty: boolean;
let projPath = path.join(
NewProjectPanel.USER_SET_WORKSPACE,
const projPath = path.join(
NewProjectPanel.userSetWorkSpace,
message.projectName
);
let uri = vscode.Uri.file(projPath);
const uri = vscode.Uri.file(projPath);
/**
* check if the vscode workspace folder is empty,
* if yes, open new window, else open in current window
*/
isWorkspaceEmpty = !vscode.workspace
const isWorkspaceEmpty = !vscode.workspace
.workspaceFolders?.[0]
? true
: false;
@ -233,7 +234,7 @@ export class NewProjectPanel {
);
case 'close_webview':
this._panel.dispose();
this.viewPanel.dispose();
return;
default:
@ -241,16 +242,16 @@ export class NewProjectPanel {
}
},
undefined,
this._disposables
this.disposableArr
);
}
private dispose() {
NewProjectPanel.currentPanel = undefined;
this._panel.dispose();
this.viewPanel.dispose();
while (this._disposables.length) {
const disposable = this._disposables.pop();
while (this.disposableArr.length) {
const disposable = this.disposableArr.pop();
if (disposable) {
disposable.dispose();
}

View File

@ -11,19 +11,19 @@ import { getUri } from '../utilities/getUri';
export class TargetConfigPanel {
public static currentPanel: TargetConfigPanel | undefined;
private readonly _panel: vscode.WebviewPanel;
private readonly viewPanel: vscode.WebviewPanel;
private _disposables: vscode.Disposable[] = [];
public static BUILD_ARGS = {
output_file_name: 'main.wasm',
init_memory_size: '131072',
max_memory_size: '131072',
stack_size: '4096',
exported_symbols: 'main',
public static buildArgs = {
outputFileName: 'main.wasm',
initMemorySize: '131072',
maxMemorySize: '131072',
stackSize: '4096',
exportedSymbols: 'main',
};
static readonly USER_INTPUT_ERR: number = -2;
static readonly EXCUTION_SUCCESS: number = 0;
private static readonly userInputError: number = -2;
private static readonly executionSuccess: number = 0;
/**
*
@ -31,24 +31,26 @@ export class TargetConfigPanel {
* @param panelName
*/
constructor(panel: vscode.WebviewPanel, extensionUri: vscode.Uri) {
this._panel = panel;
this._panel.webview.html = this._getHtmlForWebview(
this._panel.webview,
this.viewPanel = panel;
this.viewPanel.webview.html = this._getHtmlForWebview(
this.viewPanel.webview,
extensionUri,
'resource/webview/page/configBuildTarget.html'
);
this._panel.onDidDispose(this.dispose, null, this._disposables);
this._setWebviewMessageListener(this._panel.webview);
this.viewPanel.onDidDispose(this.dispose, null, this._disposables);
this._setWebviewMessageListener(this.viewPanel.webview);
}
/**
*
* @param context
*/
public static render(context: vscode.ExtensionContext) {
public static render(context: vscode.ExtensionContext): void {
/* check if current panel is initialized */
if (TargetConfigPanel.currentPanel) {
TargetConfigPanel.currentPanel._panel.reveal(vscode.ViewColumn.One);
TargetConfigPanel.currentPanel.viewPanel.reveal(
vscode.ViewColumn.One
);
} else {
const panel = vscode.window.createWebviewPanel(
'targetConfig',
@ -67,59 +69,56 @@ export class TargetConfigPanel {
}
}
private _configBuildArgs(
private configBuildArgs(
outputFileName: string,
initmemSize: string,
maxmemSize: string,
initMemSize: string,
maxMemSize: string,
stackSize: string,
exportedSymbols: string
): number {
if (
outputFileName === '' ||
initmemSize === '' ||
maxmemSize === '' ||
initMemSize === '' ||
maxMemSize === '' ||
stackSize === '' ||
exportedSymbols === ''
) {
return TargetConfigPanel.USER_INTPUT_ERR;
return TargetConfigPanel.userInputError;
}
let _configStr: string;
let includePathArr = new Array();
let excludeFileArr = new Array();
let configJson: any;
let includePathArr = [];
let excludeFileArr = [];
let _configObj = {
output_file_name: outputFileName,
init_memory_size: initmemSize,
max_memory_size: maxmemSize,
stack_size: stackSize,
exported_symbols: exportedSymbols,
const configObj = {
outputFileName: outputFileName,
initMemorySize: initMemSize,
maxMemorySize: maxMemSize,
stackSize: stackSize,
exportedSymbols: exportedSymbols,
};
const configStr = readFromConfigFile();
TargetConfigPanel.BUILD_ARGS = _configObj;
TargetConfigPanel.buildArgs = configObj;
_configStr = readFromConfigFile();
if (_configStr !== '' && _configStr !== undefined) {
configJson = JSON.parse(_configStr);
if (configStr !== '' && configStr !== undefined) {
const configJson = JSON.parse(configStr);
includePathArr =
configJson['include_paths'] === undefined
configJson['includePaths'] === undefined
? []
: configJson['include_paths'];
: configJson['includePaths'];
excludeFileArr =
configJson['exclude_files'] === undefined
configJson['excludeFiles'] === undefined
? []
: configJson['exclude_files'];
: configJson['excludeFiles'];
}
writeIntoConfigFile(
includePathArr,
excludeFileArr,
TargetConfigPanel.BUILD_ARGS
TargetConfigPanel.buildArgs
);
return TargetConfigPanel.EXCUTION_SUCCESS;
return TargetConfigPanel.executionSuccess;
}
private _getHtmlForWebview(
@ -158,23 +157,23 @@ export class TargetConfigPanel {
.replace(/(\${styleUri})/, styleUri.toString())
.replace(
/(\${output_file_val})/,
TargetConfigPanel.BUILD_ARGS.output_file_name
TargetConfigPanel.buildArgs.outputFileName
)
.replace(
/(\${initial_mem_size_val})/,
TargetConfigPanel.BUILD_ARGS.init_memory_size
TargetConfigPanel.buildArgs.initMemorySize
)
.replace(
/(\${max_mem_size_val})/,
TargetConfigPanel.BUILD_ARGS.max_memory_size
TargetConfigPanel.buildArgs.maxMemorySize
)
.replace(
/(\${stack_size_val})/,
TargetConfigPanel.BUILD_ARGS.stack_size
TargetConfigPanel.buildArgs.stackSize
)
.replace(
/(\${exported_symbols_val})/,
TargetConfigPanel.BUILD_ARGS.exported_symbols
TargetConfigPanel.buildArgs.exportedSymbols
);
return html;
@ -187,8 +186,8 @@ export class TargetConfigPanel {
case 'config_build_target':
if (
message.outputFileName === '' ||
message.initmemSize === '' ||
message.maxmemSize === '' ||
message.initMemSize === '' ||
message.maxMemSize === '' ||
message.stackSize === '' ||
message.exportedSymbols === ''
) {
@ -197,13 +196,13 @@ export class TargetConfigPanel {
);
return;
} else if (
this._configBuildArgs(
this.configBuildArgs(
message.outputFileName,
message.initmemSize,
message.maxmemSize,
message.initMemSize,
message.maxMemSize,
message.stackSize,
message.exportedSymbols
) === TargetConfigPanel.EXCUTION_SUCCESS
) === TargetConfigPanel.executionSuccess
) {
vscode.window
.showInformationMessage(
@ -211,7 +210,7 @@ export class TargetConfigPanel {
'OK'
)
.then(() => {
this._panel.dispose();
this.viewPanel.dispose();
return;
});
}
@ -227,7 +226,7 @@ export class TargetConfigPanel {
private dispose() {
TargetConfigPanel.currentPanel = undefined;
this._panel.dispose();
this.viewPanel.dispose();
while (this._disposables.length) {
const disposable = this._disposables.pop();