mirror of
https://github.com/google/blockly.git
synced 2026-01-07 17:10:11 +01:00
ce22f42868
* chore(deps): Add pretter-plugin-organize-imports * chore: Remove insignificant blank lines in import sections Since prettier-plugin-organize-imports sorts imports within sections separated by blank lines, but preserves the section divisions, remove any blank lines that are not dividing imports into meaningful sections. Do not remove blank lines separating side-effect-only imports from main imports. * chore: Remove unneded eslint-disable directives * chore: Organise imports
127 lines
3.3 KiB
TypeScript
127 lines
3.3 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2018 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* Base class for comment events.
|
|
*
|
|
* @class
|
|
*/
|
|
// Former goog.module ID: Blockly.Events.CommentBase
|
|
|
|
import type {WorkspaceComment} from '../comments/workspace_comment.js';
|
|
import * as comments from '../serialization/workspace_comments.js';
|
|
import type {Workspace} from '../workspace.js';
|
|
import {
|
|
Abstract as AbstractEvent,
|
|
AbstractEventJson,
|
|
} from './events_abstract.js';
|
|
import type {CommentCreate} from './events_comment_create.js';
|
|
import type {CommentDelete} from './events_comment_delete.js';
|
|
import * as eventUtils from './utils.js';
|
|
|
|
/**
|
|
* Abstract class for a comment event.
|
|
*/
|
|
export class CommentBase extends AbstractEvent {
|
|
override isBlank = true;
|
|
|
|
/** The ID of the comment that this event references. */
|
|
commentId?: string;
|
|
|
|
/**
|
|
* @param opt_comment The comment this event corresponds to. Undefined for a
|
|
* blank event.
|
|
*/
|
|
constructor(opt_comment?: WorkspaceComment) {
|
|
super();
|
|
/** Whether or not an event is blank. */
|
|
this.isBlank = !opt_comment;
|
|
|
|
if (!opt_comment) return;
|
|
|
|
this.commentId = opt_comment.id;
|
|
this.workspaceId = opt_comment.workspace.id;
|
|
this.group = eventUtils.getGroup();
|
|
this.recordUndo = eventUtils.getRecordUndo();
|
|
}
|
|
|
|
/**
|
|
* Encode the event as JSON.
|
|
*
|
|
* @returns JSON representation.
|
|
*/
|
|
override toJson(): CommentBaseJson {
|
|
const json = super.toJson() as CommentBaseJson;
|
|
if (!this.commentId) {
|
|
throw new Error(
|
|
'The comment ID is undefined. Either pass a comment to ' +
|
|
'the constructor, or call fromJson',
|
|
);
|
|
}
|
|
json['commentId'] = this.commentId;
|
|
return json;
|
|
}
|
|
|
|
/**
|
|
* Deserializes the JSON event.
|
|
*
|
|
* @param event The event to append new properties to. Should be a subclass
|
|
* of CommentBase, but we can't specify that due to the fact that
|
|
* parameters to static methods in subclasses must be supertypes of
|
|
* parameters to static methods in superclasses.
|
|
* @internal
|
|
*/
|
|
static fromJson(
|
|
json: CommentBaseJson,
|
|
workspace: Workspace,
|
|
event?: any,
|
|
): CommentBase {
|
|
const newEvent = super.fromJson(
|
|
json,
|
|
workspace,
|
|
event ?? new CommentBase(),
|
|
) as CommentBase;
|
|
newEvent.commentId = json['commentId'];
|
|
return newEvent;
|
|
}
|
|
|
|
/**
|
|
* Helper function for Comment[Create|Delete]
|
|
*
|
|
* @param event The event to run.
|
|
* @param create if True then Create, if False then Delete
|
|
*/
|
|
static CommentCreateDeleteHelper(
|
|
event: CommentCreate | CommentDelete,
|
|
create: boolean,
|
|
) {
|
|
const workspace = event.getEventWorkspace_();
|
|
if (create) {
|
|
if (!event.json) {
|
|
throw new Error('Encountered a comment event without proper json');
|
|
}
|
|
comments.append(event.json, workspace);
|
|
} else {
|
|
if (!event.commentId) {
|
|
throw new Error(
|
|
'The comment ID is undefined. Either pass a comment to ' +
|
|
'the constructor, or call fromJson',
|
|
);
|
|
}
|
|
const comment = workspace.getCommentById(event.commentId);
|
|
if (comment) {
|
|
comment.dispose();
|
|
} else {
|
|
console.warn("Can't delete non-existent comment: " + event.commentId);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
export interface CommentBaseJson extends AbstractEventJson {
|
|
commentId: string;
|
|
}
|