@quick-game/cli
Version:
Command line interface for rapid qg development
370 lines • 17.3 kB
JavaScript
/*
* Copyright (C) 2011 Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
import * as Common from '../../core/common/common.js';
import * as Host from '../../core/host/host.js';
import * as i18n from '../../core/i18n/i18n.js';
import * as Platform from '../../core/platform/platform.js';
import * as SDK from '../../core/sdk/sdk.js';
import * as Bindings from '../../models/bindings/bindings.js';
import * as Persistence from '../../models/persistence/persistence.js';
import * as Workspace from '../../models/workspace/workspace.js';
import * as UI from '../../ui/legacy/legacy.js';
import * as Snippets from '../snippets/snippets.js';
import { NavigatorView } from './NavigatorView.js';
import sourcesNavigatorStyles from './sourcesNavigator.css.js';
const UIStrings = {
/**
*@description Text to explain the Workspace feature in the Sources panel. https://goo.gle/devtools-workspace
*/
explainWorkspace: 'Set up workspace to sync edits directly to the sources you develop',
/**
*@description Text to explain the Local Overrides feature. https://goo.gle/devtools-overrides
*/
explainLocalOverrides: 'Override network requests and web content locally to mock remote resources',
/**
*@description Text that is usually a hyperlink to more documentation
*/
learnMore: 'Learn more',
/**
*@description Tooltip text that appears when hovering over the largeicon clear button in the Sources Navigator of the Sources panel
*/
clearConfiguration: 'Clear configuration',
/**
*@description Text in Sources Navigator of the Sources panel
*/
selectFolderForOverrides: 'Select folder for overrides',
/**
*@description Text to explain the content scripts pane in the Sources panel
*/
explainContentScripts: 'View content scripts served by extensions',
/**
*@description Text to explain the Snippets feature in the Sources panel https://goo.gle/devtools-snippets
*/
explainSnippets: 'Save the JavaScript code you run often to run it again anytime',
/**
*@description Text in Sources Navigator of the Sources panel
*/
newSnippet: 'New snippet',
/**
*@description Title of an action in the sources tool to create snippet
*/
createNewSnippet: 'Create new snippet',
/**
*@description A context menu item in the Sources Navigator of the Sources panel
*/
run: 'Run',
/**
*@description A context menu item in the Navigator View of the Sources panel
*/
rename: 'Rename…',
/**
*@description Label for an item to remove something
*/
remove: 'Remove',
/**
*@description Text to save content as a specific file type
*/
saveAs: 'Save as...',
};
const str_ = i18n.i18n.registerUIStrings('panels/sources/SourcesNavigator.ts', UIStrings);
const i18nString = i18n.i18n.getLocalizedString.bind(undefined, str_);
let networkNavigatorViewInstance;
export class NetworkNavigatorView extends NavigatorView {
constructor() {
super(true);
SDK.TargetManager.TargetManager.instance().addEventListener(SDK.TargetManager.Events.InspectedURLChanged, this.inspectedURLChanged, this);
// Record the sources tool load time after the file navigator has loaded.
Host.userMetrics.panelLoaded('sources', 'DevTools.Launch.Sources');
SDK.TargetManager.TargetManager.instance().addScopeChangeListener(this.onScopeChange.bind(this));
}
wasShown() {
this.registerCSSFiles([sourcesNavigatorStyles]);
super.wasShown();
}
static instance(opts = { forceNew: null }) {
const { forceNew } = opts;
if (!networkNavigatorViewInstance || forceNew) {
networkNavigatorViewInstance = new NetworkNavigatorView();
}
return networkNavigatorViewInstance;
}
acceptProject(project) {
return project.type() === Workspace.Workspace.projectTypes.Network &&
SDK.TargetManager.TargetManager.instance().isInScope(Bindings.NetworkProject.NetworkProject.getTargetForProject(project));
}
onScopeChange() {
for (const project of Workspace.Workspace.WorkspaceImpl.instance().projects()) {
if (!this.acceptProject(project)) {
this.removeProject(project);
}
else {
this.tryAddProject(project);
}
}
}
inspectedURLChanged(event) {
const mainTarget = SDK.TargetManager.TargetManager.instance().scopeTarget();
if (event.data !== mainTarget) {
return;
}
const inspectedURL = mainTarget && mainTarget.inspectedURL();
if (!inspectedURL) {
return;
}
for (const uiSourceCode of this.workspace().uiSourceCodes()) {
if (this.acceptProject(uiSourceCode.project()) && uiSourceCode.url() === inspectedURL) {
this.revealUISourceCode(uiSourceCode, true);
}
}
}
uiSourceCodeAdded(uiSourceCode) {
const mainTarget = SDK.TargetManager.TargetManager.instance().scopeTarget();
const inspectedURL = mainTarget && mainTarget.inspectedURL();
if (!inspectedURL) {
return;
}
if (uiSourceCode.url() === inspectedURL) {
this.revealUISourceCode(uiSourceCode, true);
}
}
}
let filesNavigatorViewInstance;
export class FilesNavigatorView extends NavigatorView {
constructor() {
super();
const placeholder = new UI.EmptyWidget.EmptyWidget('');
this.setPlaceholder(placeholder);
placeholder.appendParagraph().appendChild(UI.Fragment.html `
<div>${i18nString(UIStrings.explainWorkspace)}</div><br />
${UI.XLink.XLink.create('https://goo.gle/devtools-workspace', i18nString(UIStrings.learnMore))}
`);
const toolbar = new UI.Toolbar.Toolbar('navigator-toolbar');
void toolbar.appendItemsAtLocation('files-navigator-toolbar').then(() => {
if (!toolbar.empty()) {
this.contentElement.insertBefore(toolbar.element, this.contentElement.firstChild);
}
});
}
static instance() {
if (!filesNavigatorViewInstance) {
filesNavigatorViewInstance = new FilesNavigatorView();
}
return filesNavigatorViewInstance;
}
sourceSelected(uiSourceCode, focusSource) {
Host.userMetrics.actionTaken(Host.UserMetrics.Action.FileSystemSourceSelected);
super.sourceSelected(uiSourceCode, focusSource);
}
acceptProject(project) {
return project.type() === Workspace.Workspace.projectTypes.FileSystem &&
Persistence.FileSystemWorkspaceBinding.FileSystemWorkspaceBinding.fileSystemType(project) !== 'overrides' &&
!Snippets.ScriptSnippetFileSystem.isSnippetsProject(project);
}
handleContextMenu(event) {
const contextMenu = new UI.ContextMenu.ContextMenu(event);
contextMenu.defaultSection().appendAction('sources.add-folder-to-workspace', undefined, true);
void contextMenu.show();
}
}
let overridesNavigatorViewInstance;
export class OverridesNavigatorView extends NavigatorView {
toolbar;
constructor() {
super();
const placeholder = new UI.EmptyWidget.EmptyWidget('');
this.setPlaceholder(placeholder);
placeholder.appendParagraph().appendChild(UI.Fragment.html `
<div>${i18nString(UIStrings.explainLocalOverrides)}</div><br />
${UI.XLink.XLink.create('https://goo.gle/devtools-overrides', i18nString(UIStrings.learnMore))}
`);
this.toolbar = new UI.Toolbar.Toolbar('navigator-toolbar');
this.contentElement.insertBefore(this.toolbar.element, this.contentElement.firstChild);
Persistence.NetworkPersistenceManager.NetworkPersistenceManager.instance().addEventListener(Persistence.NetworkPersistenceManager.Events.ProjectChanged, this.updateProjectAndUI, this);
this.workspace().addEventListener(Workspace.Workspace.Events.ProjectAdded, this.onProjectAddOrRemoved, this);
this.workspace().addEventListener(Workspace.Workspace.Events.ProjectRemoved, this.onProjectAddOrRemoved, this);
this.updateProjectAndUI();
}
static instance(opts = { forceNew: null }) {
const { forceNew } = opts;
if (!overridesNavigatorViewInstance || forceNew) {
overridesNavigatorViewInstance = new OverridesNavigatorView();
}
return overridesNavigatorViewInstance;
}
onProjectAddOrRemoved(event) {
const project = event.data;
if (project && project.type() === Workspace.Workspace.projectTypes.FileSystem &&
Persistence.FileSystemWorkspaceBinding.FileSystemWorkspaceBinding.fileSystemType(project) !== 'overrides') {
return;
}
this.updateUI();
}
updateProjectAndUI() {
this.reset();
const project = Persistence.NetworkPersistenceManager.NetworkPersistenceManager.instance().project();
if (project) {
this.tryAddProject(project);
}
this.updateUI();
}
updateUI() {
this.toolbar.removeToolbarItems();
const project = Persistence.NetworkPersistenceManager.NetworkPersistenceManager.instance().project();
if (project) {
const enableCheckbox = new UI.Toolbar.ToolbarSettingCheckbox(Common.Settings.Settings.instance().moduleSetting('persistenceNetworkOverridesEnabled'));
this.toolbar.appendToolbarItem(enableCheckbox);
this.toolbar.appendToolbarItem(new UI.Toolbar.ToolbarSeparator(true));
const clearButton = new UI.Toolbar.ToolbarButton(i18nString(UIStrings.clearConfiguration), 'clear');
clearButton.addEventListener(UI.Toolbar.ToolbarButton.Events.Click, () => {
Common.Settings.Settings.instance().moduleSetting('persistenceNetworkOverridesEnabled').set(false);
project.remove();
});
this.toolbar.appendToolbarItem(clearButton);
return;
}
const title = i18nString(UIStrings.selectFolderForOverrides);
const setupButton = new UI.Toolbar.ToolbarButton(title, 'plus', title);
setupButton.addEventListener(UI.Toolbar.ToolbarButton.Events.Click, _event => {
void this.setupNewWorkspace();
}, this);
this.toolbar.appendToolbarItem(setupButton);
}
async setupNewWorkspace() {
const fileSystem = await Persistence.IsolatedFileSystemManager.IsolatedFileSystemManager.instance().addFileSystem('overrides');
if (!fileSystem) {
return;
}
Common.Settings.Settings.instance().moduleSetting('persistenceNetworkOverridesEnabled').set(true);
}
sourceSelected(uiSourceCode, focusSource) {
Host.userMetrics.actionTaken(Host.UserMetrics.Action.OverridesSourceSelected);
super.sourceSelected(uiSourceCode, focusSource);
}
acceptProject(project) {
return project === Persistence.NetworkPersistenceManager.NetworkPersistenceManager.instance().project();
}
}
let contentScriptsNavigatorViewInstance;
export class ContentScriptsNavigatorView extends NavigatorView {
constructor() {
super();
const placeholder = new UI.EmptyWidget.EmptyWidget('');
this.setPlaceholder(placeholder);
placeholder.appendParagraph().appendChild(UI.Fragment.html `
<div>${i18nString(UIStrings.explainContentScripts)}</div><br />
${UI.XLink.XLink.create('https://developer.chrome.com/extensions/content_scripts', i18nString(UIStrings.learnMore))}
`);
}
static instance(opts = { forceNew: null }) {
const { forceNew } = opts;
if (!contentScriptsNavigatorViewInstance || forceNew) {
contentScriptsNavigatorViewInstance = new ContentScriptsNavigatorView();
}
return contentScriptsNavigatorViewInstance;
}
acceptProject(project) {
return project.type() === Workspace.Workspace.projectTypes.ContentScripts;
}
}
let snippetsNavigatorViewInstance;
export class SnippetsNavigatorView extends NavigatorView {
constructor() {
super();
const placeholder = new UI.EmptyWidget.EmptyWidget('');
this.setPlaceholder(placeholder);
placeholder.appendParagraph().appendChild(UI.Fragment.html `
<div>${i18nString(UIStrings.explainSnippets)}</div><br />
${UI.XLink.XLink.create('https://goo.gle/devtools-snippets', i18nString(UIStrings.learnMore))}
`);
const toolbar = new UI.Toolbar.Toolbar('navigator-toolbar');
const newButton = new UI.Toolbar.ToolbarButton(i18nString(UIStrings.newSnippet), 'plus', i18nString(UIStrings.newSnippet));
newButton.addEventListener(UI.Toolbar.ToolbarButton.Events.Click, _event => {
void this.create(Snippets.ScriptSnippetFileSystem.findSnippetsProject(), '');
});
toolbar.appendToolbarItem(newButton);
this.contentElement.insertBefore(toolbar.element, this.contentElement.firstChild);
}
static instance() {
if (!snippetsNavigatorViewInstance) {
snippetsNavigatorViewInstance = new SnippetsNavigatorView();
}
return snippetsNavigatorViewInstance;
}
acceptProject(project) {
return Snippets.ScriptSnippetFileSystem.isSnippetsProject(project);
}
handleContextMenu(event) {
const contextMenu = new UI.ContextMenu.ContextMenu(event);
contextMenu.headerSection().appendItem(i18nString(UIStrings.createNewSnippet), () => this.create(Snippets.ScriptSnippetFileSystem.findSnippetsProject(), ''));
void contextMenu.show();
}
handleFileContextMenu(event, node) {
const uiSourceCode = node.uiSourceCode();
const contextMenu = new UI.ContextMenu.ContextMenu(event);
contextMenu.headerSection().appendItem(i18nString(UIStrings.run), () => Snippets.ScriptSnippetFileSystem.evaluateScriptSnippet(uiSourceCode));
contextMenu.editSection().appendItem(i18nString(UIStrings.rename), () => this.rename(node, false));
contextMenu.editSection().appendItem(i18nString(UIStrings.remove), () => uiSourceCode.project().deleteFile(uiSourceCode));
contextMenu.saveSection().appendItem(i18nString(UIStrings.saveAs), this.handleSaveAs.bind(this, uiSourceCode));
void contextMenu.show();
}
async handleSaveAs(uiSourceCode) {
uiSourceCode.commitWorkingCopy();
const { content } = await uiSourceCode.requestContent();
void Workspace.FileManager.FileManager.instance().save(this.addJSExtension(uiSourceCode.url()), content || '', true);
Workspace.FileManager.FileManager.instance().close(uiSourceCode.url());
}
addJSExtension(url) {
return Common.ParsedURL.ParsedURL.concatenate(url, '.js');
}
}
let actionDelegateInstance;
export class ActionDelegate {
static instance(opts = { forceNew: null }) {
const { forceNew } = opts;
if (!actionDelegateInstance || forceNew) {
actionDelegateInstance = new ActionDelegate();
}
return actionDelegateInstance;
}
handleAction(context, actionId) {
switch (actionId) {
case 'sources.create-snippet':
void Snippets.ScriptSnippetFileSystem.findSnippetsProject()
.createFile(Platform.DevToolsPath.EmptyEncodedPathString, null, '')
.then(uiSourceCode => Common.Revealer.reveal(uiSourceCode));
return true;
case 'sources.add-folder-to-workspace':
void Persistence.IsolatedFileSystemManager.IsolatedFileSystemManager.instance().addFileSystem();
return true;
}
return false;
}
}
//# sourceMappingURL=SourcesNavigator.js.map