refactor: added some comments

Author: GeekaN2

src/index.ts

@@ -43,13 +43,19 @@ export default class Paragraph implements BlockTool {
    */
   private readonly element: HTMLDivElement;
 
+  /**
+   * CSS class names
+   */
   private readonly CSS: ParagraphToolCSS;
 
   /**
    * Placeholder for paragraph if it is first Block
    */
   private readonly placeholder: string;
 
+  /**
+   * Will save empty paragraphs if set to true
+   */
   private readonly preserveBlank: boolean;
 
   /**

src/types/index.ts

@@ -10,6 +10,9 @@ export interface ParagraphToolData extends BlockToolData {
   text?: string;
 }
 
+/**
+ * Public features for configuring the tool
+ */
 export interface ParagraphToolConfig extends ToolConfig {
   /**
    * Placeholder for the empty paragraph
@@ -22,6 +25,9 @@ export interface ParagraphToolConfig extends ToolConfig {
   preserveBlank?: boolean;
 }
 
+/**
+ * CSS class names for elements created by the plugin
+ */
 export interface ParagraphToolCSS {
   /**
    * Block CSS class name
@@ -34,10 +40,16 @@ export interface ParagraphToolCSS {
   wrapper: string;
 }
 
+/**
+ * Used by Editor paste handling API
+ */
 export interface PasteConfig {
   tags: string[];
 }
 
+/**
+ * Used by Editor API to display the module in the toolbox
+ */
 export interface Toolbox {
   icon: string;
   title: string;

vite.config.ts

@@ -19,7 +19,7 @@ export default defineConfig({
     build: {
         lib: {
             entry: path.resolve(__dirname, 'src', 'index.ts'),
-            name: 'paragraph',
+            name: 'Paragraph',
             formats: ['umd', 'es'],
             fileName: 'paragraph',
         },