fix : address feedback from PR review

Author: idebenone

eslint.config.mjs

@@ -2,58 +2,45 @@ import Codex from "eslint-config-codex";
 import { plugin as TsPlugin, parser as TsParser } from 'typescript-eslint';
 
 export default [
-    ...Codex,
-    {
-        files: ['src/**/*.ts'],
-        languageOptions: {
-            parser: TsParser,
-            parserOptions: {
-                project: './tsconfig.json',
-                tsconfigRootDir: './',
-                sourceType: 'module',
-            },
+  ...Codex,
+  {
+    files: ['src/**/*.ts'],
+    languageOptions: {
+      parser: TsParser,
+      parserOptions: {
+        project: './tsconfig.json',
+        tsconfigRootDir: './',
+        sourceType: 'module',
+      },
+    },
+    rules: {
+      'n/no-missing-import': ['off'],
+      'n/no-unsupported-features/node-builtins': ['off'],
+      'jsdoc/require-returns-description': ['off'],
+      '@typescript-eslint/naming-convention': [
+        'error',
+        {
+          'selector': 'variable',
+          'format': ['camelCase'],
+          'leadingUnderscore': 'allow'
         },
-        rules: {
-            'n/no-missing-import': ['off'],
-            'n/no-unsupported-features/node-builtins': ['off'],
-            'jsdoc/require-returns-description': ['off'],
-            'jsdoc/require-jsdoc': [
-                'error',
-                {
-                    'require': {
-                        'FunctionDeclaration': true,
-                        'MethodDefinition': true,
-                        'ClassDeclaration': true,
-                        'ArrowFunctionExpression': false,
-                        'FunctionExpression': false,
-                    }
-                }
-            ],
-            '@typescript-eslint/explicit-member-accessibility': ['off'],
-            '@typescript-eslint/naming-convention': [
-                'error',
-                {
-                    'selector': 'variable',
-                    'format': ['camelCase'],
-                    'leadingUnderscore': 'allow'
-                },
-            ],
-            '@typescript-eslint/no-unsafe-member-access': ['off'],
-            '@typescript-eslint/no-restricted-types': ['error',
-                {
-                    'types': {
-                        'String': "Use 'string' instead.",
-                        'Boolean': "Use 'boolean' instead.",
-                        'Number': "Use 'number' instead.",
-                        'Symbol': "Use 'symbol' instead.",
-                        'Object': "Use 'object' instead, or define a more specific type.",
-                        'Function': "Use a specific function type instead, like '(arg: type) => returnType'."
-                    }
-                }
-            ]
+      ],
+      '@typescript-eslint/no-unsafe-member-access': ['off'],
+      '@typescript-eslint/no-restricted-types': ['error',
+        {
+          'types': {
+            'String': "Use 'string' instead.",
+            'Boolean': "Use 'boolean' instead.",
+            'Number': "Use 'number' instead.",
+            'Symbol': "Use 'symbol' instead.",
+            'Object': "Use 'object' instead, or define a more specific type.",
+            'Function': "Use a specific function type instead, like '(arg: type) => returnType'."
+          }
         }
-    },
-    {
-        ignores: ['dev/**', 'eslint.config.mjs', 'vite.config.js', 'postcss.config.js']
+      ]
     }
+  },
+  {
+    ignores: ['dev/**', 'eslint.config.mjs', 'vite.config.js', 'postcss.config.js']
+  }
 ];

package.json

@@ -42,7 +42,7 @@
     "eslint-config-codex": "^2.0.2",
     "typescript": "^5.5.3",
     "typescript-eslint": "^8.4.0",
-    "vite": "^4.5.0",
+    "vite": "^5.4.3",
     "vite-plugin-css-injected-by-js": "^3.3.0",
     "vite-plugin-dts": "^3.9.1"
   },

src/index.ts

@@ -1,7 +1,7 @@
 import './index.css';
 import { getLineStartPosition } from './utils/string';
 import { IconBrackets } from '@codexteam/icons';
-import type { API, BlockTool, BlockToolConstructorOptions, PasteEvent, SanitizerConfig } from '@editorjs/editorjs';
+import type { API, BlockTool, BlockToolConstructorOptions, BlockToolData, PasteConfig, PasteEvent, SanitizerConfig, ToolboxConfig } from '@editorjs/editorjs';
 
 /**
  * CodeTool for Editor.js
@@ -12,7 +12,7 @@ import type { API, BlockTool, BlockToolConstructorOptions, PasteEvent, Sanitizer
 /**
  * Data structure for CodeTool's data
  */
-export interface CodeData {
+export interface CodeData extends BlockToolData {
   /**
    * The code content input by the user
    */
@@ -53,6 +53,16 @@ interface CodeToolNodes {
   textarea: HTMLTextAreaElement | null;
 }
 
+/**
+ * Options passed to the constructor of a block tool
+ */
+interface CodeToolConstructorOptions extends BlockToolConstructorOptions {
+  /**
+   * Data specific to the CodeTool
+   */
+  data: CodeData;
+}
+
 /**
  * Code Tool for the Editor.js allows to include code examples in your articles.
  */
@@ -86,7 +96,7 @@ export default class CodeTool implements BlockTool {
    * Notify core that read-only mode is supported
    * @returns true if read-only mode is supported
    */
-  static get isReadOnlySupported(): boolean {
+  public static get isReadOnlySupported(): boolean {
     return true;
   }
 
@@ -95,15 +105,10 @@ export default class CodeTool implements BlockTool {
    * This enables multi-line input within the code editor.
    * @returns true if line breaks are allowed in the textarea
    */
-  static get enableLineBreaks(): boolean {
+  public static get enableLineBreaks(): boolean {
     return true;
   }
 
-  /**
-   * CodeData — plugin saved data
-   * code - previously saved plugin code
-   */
-
   /**
    * Render plugin`s main Element and fill it with saved data
    * @param options - tool constricting options
@@ -112,7 +117,7 @@ export default class CodeTool implements BlockTool {
    * @param options.api - Editor.js API
    * @param options.readOnly - read only mode flag
    */
-  constructor({ data, config, api, readOnly }: BlockToolConstructorOptions) {
+  constructor({ data, config, api, readOnly }: CodeToolConstructorOptions) {
     this.api = api;
     this.readOnly = readOnly;
 
@@ -131,7 +136,7 @@ export default class CodeTool implements BlockTool {
     };
 
     this.data = {
-      code: data.code as string || '',
+      code: data.code ?? '',
     };
 
     this.nodes.holder = this.drawView();
@@ -199,7 +204,7 @@ export default class CodeTool implements BlockTool {
    * - icon: SVG representation of the Tool's icon
    * - title: Title to show in the toolbox
    */
-  static get toolbox(): { icon: string; title: string } {
+  public static get toolbox(): ToolboxConfig {
     return {
       icon: IconBrackets,
       title: 'Code',
@@ -210,7 +215,7 @@ export default class CodeTool implements BlockTool {
    * Default placeholder for CodeTool's textarea
    * @returns
    */
-  static get DEFAULT_PLACEHOLDER(): string {
+  public static get DEFAULT_PLACEHOLDER(): string {
     return 'Enter a code';
   }
 
@@ -219,7 +224,7 @@ export default class CodeTool implements BlockTool {
    *  Provides configuration to handle CODE tag.
    * @returns
    */
-  static get pasteConfig(): { tags: string[] } {
+  public static get pasteConfig(): PasteConfig {
     return {
       tags: ['pre'],
     };
@@ -229,7 +234,7 @@ export default class CodeTool implements BlockTool {
    * Automatic sanitize config
    * @returns
    */
-  static get sanitize(): SanitizerConfig {
+  public static get sanitize(): SanitizerConfig {
     return {
       code: true, // Allow HTML tags
     };