Add changelog, ESLint configuration, and version updates (#14)

moutonjeremy · web-flow · commit 33e1eb980ceb · 2026-01-25T18:24:46.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,70 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2026-01-25
+
+### Added
+
+#### Core Editor (`@labbs/openblock-core`)
+- **Public ProseMirror API** - Full access to ProseMirror internals via `editor.pm.*`
+- **Block-based JSON document format** - Notion-like structure with full TypeScript support
+- **Schema System**
+  - Block nodes: paragraph, heading (h1-h6), blockquote, callout, codeBlock, divider, bulletList, orderedList, listItem, checkList, checkListItem, columnList, column, table, tableRow, tableCell, tableHeader, image, embed
+  - Mark types: bold, italic, underline, strikethrough, code, link, textColor, backgroundColor
+- **Plugin System**
+  - Slash menu plugin (`/` command palette)
+  - Bubble menu plugin (floating toolbar)
+  - Drag & drop plugin for block reordering
+  - Table plugin with row/column manipulation
+  - Media menu plugin for image/video controls
+  - Keyboard shortcuts plugin
+  - Input rules for auto-formatting (markdown shortcuts)
+  - Block ID management plugin
+  - Checklist plugin
+  - Multi-block selection plugin
+- **Table Commands** - addRowAfter, addRowBefore, deleteRow, addColumnAfter, addColumnBefore, deleteColumn, deleteTable, goToNextCell, goToPreviousCell
+- **Document Operations** - getDocument, setDocument, getBlock, insertBlocks, updateBlock, removeBlocks
+- **Text Formatting Commands** - toggleBold, toggleItalic, toggleUnderline, toggleStrikethrough, toggleCode, setTextColor, setBackgroundColor
+- **History Support** - Undo/redo via ProseMirror history
+- **CSS Auto-injection** - Automatic style injection with opt-out support
+
+#### React Package (`@labbs/openblock-react`)
+- **Hooks**
+  - `useOpenBlock` - Create and manage editor instances
+  - `useEditorContent` - Subscribe to document changes
+  - `useEditorSelection` - Track selection changes
+  - `useEditorFocus` - Monitor focus state
+  - `useCustomSlashMenuItems` - Generate menu items from custom blocks
+- **Components**
+  - `OpenBlockView` - Main editor view component
+  - `SlashMenu` - Command palette UI
+  - `BubbleMenu` - Floating formatting toolbar
+  - `TableHandles` - Row/column manipulation handles
+  - `TableMenu` - Table cell operations menu
+  - `MediaMenu` - Image/video controls
+  - `ColorPicker` - Color selection UI
+  - `LinkPopover` - Link editing popover
+- **Custom Blocks API** - `createReactBlockSpec` for creating React-based custom blocks
+- **Custom Block Hooks** - `useBlockEditor` and `useUpdateBlock` for custom block implementations
+
+### Documentation
+- React integration guide
+- Custom blocks guide
+- Custom marks guide
+- Plugins guide
+- Styling and theming guide
+- Comprehensive README with API reference
+
+---
+
+## [0.0.1] - 2026-01-17
+
+### Added
+- Initial project setup
+- Basic editor functionality
+- ProseMirror integration
+- React bindings foundation
diff --git a/LICENSE b/LICENSE
@@ -175,7 +175,7 @@
 
    END OF TERMS AND CONDITIONS
 
-   Copyright 2025 OpenBlock Contributors
+   Copyright 2026 OpenBlock Contributors
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
diff --git a/eslint.config.js b/eslint.config.js
@@ -0,0 +1,40 @@
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import globals from 'globals';
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+        ...globals.node,
+      },
+    },
+  },
+  {
+    rules: {
+      '@typescript-eslint/no-unused-vars': ['error', {
+        argsIgnorePattern: '^_',
+        varsIgnorePattern: '^_',
+      }],
+      '@typescript-eslint/no-explicit-any': 'warn',
+      '@typescript-eslint/explicit-function-return-type': 'off',
+      '@typescript-eslint/explicit-module-boundary-types': 'off',
+      '@typescript-eslint/no-non-null-assertion': 'warn',
+      'no-console': ['warn', { allow: ['warn', 'error'] }],
+      'prefer-const': 'error',
+      'no-var': 'error',
+    },
+  },
+  {
+    ignores: [
+      '**/dist/**',
+      '**/node_modules/**',
+      '**/*.js',
+      '**/*.mjs',
+      '**/*.cjs',
+    ],
+  }
+);
diff --git a/examples/basic/package.json b/examples/basic/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@labbs/openblock-example-basic",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "private": true,
   "type": "module",
   "scripts": {
diff --git a/package.json b/package.json
@@ -1,23 +1,40 @@
 {
   "name": "openblock",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "private": true,
+  "type": "module",
   "description": "A fully open-source, framework-agnostic rich text editor built on ProseMirror",
   "license": "Apache-2.0",
-  "author": "OpenBlock Contributors",
+  "author": "Labbs",
   "repository": {
     "type": "git",
-    "url": "https://github.com/openblock/openblock"
+    "url": "https://github.com/Labbs/openblock.git"
   },
+  "keywords": [
+    "editor",
+    "rich-text",
+    "prosemirror",
+    "block-editor",
+    "wysiwyg",
+    "notion-like",
+    "react",
+    "typescript",
+    "text-editor",
+    "markdown"
+  ],
   "scripts": {
     "build": "pnpm -r build",
     "dev": "pnpm -r --parallel dev",
-    "lint": "pnpm -r lint",
+    "lint": "eslint packages/*/src",
     "test": "pnpm -r test",
     "clean": "pnpm -r clean"
   },
   "devDependencies": {
-    "typescript": "^5.7.2"
+    "@eslint/js": "^9.39.2",
+    "eslint": "^9.39.2",
+    "globals": "^17.1.0",
+    "typescript": "^5.7.2",
+    "typescript-eslint": "^8.53.1"
   },
   "engines": {
     "node": ">=18.0.0",
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@labbs/openblock-core",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "description": "Framework-agnostic core for OpenBlock editor",
   "license": "Apache-2.0",
   "type": "module",
@@ -18,6 +18,18 @@
   "files": [
     "dist"
   ],
+  "keywords": [
+    "editor",
+    "rich-text",
+    "prosemirror",
+    "block-editor",
+    "wysiwyg",
+    "notion-like",
+    "typescript",
+    "text-editor",
+    "content-editor",
+    "document-editor"
+  ],
   "scripts": {
     "build": "vite build && cp -r src/styles dist/",
     "dev": "vite build --watch",
@@ -55,5 +67,9 @@
     "type": "git",
     "url": "https://github.com/Labbs/openblock.git",
     "directory": "packages/core"
+  },
+  "homepage": "https://github.com/Labbs/openblock#readme",
+  "bugs": {
+    "url": "https://github.com/Labbs/openblock/issues"
   }
 }
diff --git a/packages/core/src/blocks/nodeToBlock.ts b/packages/core/src/blocks/nodeToBlock.ts
@@ -62,28 +62,31 @@ export function nodeToBlock(node: PMNode): Block {
       }
       // If there are nested lists or other blocks, add as children
       if (node.childCount > 1) {
-        block.children = [];
+        const children: Block[] = [];
         node.forEach((child, _offset, index) => {
           if (index > 0) {
-            block.children!.push(nodeToBlock(child));
+            children.push(nodeToBlock(child));
           }
         });
+        block.children = children;
       }
     } else if (node.type.name === 'checkListItem') {
       // Check list items have inline content directly (not wrapped in paragraph)
       block.content = nodeContentToInline(node);
     } else if (node.type.name === 'tableCell' || node.type.name === 'tableHeader') {
       // Table cells: all block children become children
-      block.children = [];
+      const cellChildren: Block[] = [];
       node.forEach((child) => {
-        block.children!.push(nodeToBlock(child));
+        cellChildren.push(nodeToBlock(child));
       });
+      block.children = cellChildren;
     } else {
       // Lists, tables, tableRows: all children become block children
-      block.children = [];
+      const blockChildren: Block[] = [];
       node.forEach((child) => {
-        block.children!.push(nodeToBlock(child));
+        blockChildren.push(nodeToBlock(child));
       });
+      block.children = blockChildren;
     }
     return block;
   }
diff --git a/packages/core/src/editor/Editor.ts b/packages/core/src/editor/Editor.ts
@@ -886,10 +886,12 @@ export class OpenBlockEditor {
    * ```
    */
   on<K extends keyof EditorEvents>(event: K, handler: EventHandler<EditorEvents[K]>): () => void {
-    if (!this._listeners.has(event)) {
-      this._listeners.set(event, new Set());
+    let listeners = this._listeners.get(event);
+    if (!listeners) {
+      listeners = new Set();
+      this._listeners.set(event, listeners);
     }
-    this._listeners.get(event)!.add(handler as EventHandler<unknown>);
+    listeners.add(handler as EventHandler<unknown>);
     return () => this.off(event, handler);
   }
 
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -1,12 +1,12 @@
 /**
- * @openblock/core
+ * @labbs/openblock-core
  *
  * A fully open-source, framework-agnostic rich text editor built on ProseMirror.
  * All APIs are PUBLIC - this is a core principle of OpenBlock.
  *
  * @example
  * ```typescript
- * import { OpenBlockEditor } from '@openblock/core';
+ * import { OpenBlockEditor } from '@labbs/openblock-core';
  *
  * const editor = new OpenBlockEditor({
  *   element: document.getElementById('editor'),
diff --git a/packages/core/src/plugins/dragDropPlugin.ts b/packages/core/src/plugins/dragDropPlugin.ts
@@ -276,7 +276,7 @@ export function createDragDropPlugin(config: DragDropConfig = {}): Plugin {
   }
 
   // Cache for block positions to avoid repeated doc.descendants calls
-  let blockPosCache: Map<string, number> = new Map();
+  const blockPosCache: Map<string, number> = new Map();
   let lastDocVersion: number = -1;
 
   /**
diff --git a/packages/core/src/plugins/keyboardShortcutsPlugin.ts b/packages/core/src/plugins/keyboardShortcutsPlugin.ts
@@ -6,12 +6,20 @@
  * @module
  */
 
-import { Plugin } from 'prosemirror-state';
+import { Plugin, EditorState, Transaction } from 'prosemirror-state';
 import { keymap } from 'prosemirror-keymap';
 import { Schema } from 'prosemirror-model';
 import { toggleMark, setBlockType, wrapIn, lift } from 'prosemirror-commands';
 import { wrapInList, liftListItem, sinkListItem } from 'prosemirror-schema-list';
 import { undo, redo } from 'prosemirror-history';
+import { EditorView } from 'prosemirror-view';
+
+/** ProseMirror command type */
+type PMCommand = (
+  state: EditorState,
+  dispatch?: (tr: Transaction) => void,
+  view?: EditorView
+) => boolean;
 
 /**
  * A keyboard shortcut definition.
@@ -22,7 +30,7 @@ export interface KeyboardShortcut {
   /** Description of what the shortcut does */
   description: string;
   /** The action to perform - either a mark name, block type, or custom command */
-  action: string | ((state: any, dispatch?: any, view?: any) => boolean);
+  action: string | PMCommand;
 }
 
 /**
@@ -33,7 +41,7 @@ export interface KeyboardShortcutsConfig {
    * Custom shortcuts to add or override defaults.
    * Key is the shortcut (e.g., 'Mod-b'), value is the action.
    */
-  shortcuts?: Record<string, string | ((state: any, dispatch?: any, view?: any) => boolean)>;
+  shortcuts?: Record<string, string | PMCommand>;
 
   /**
    * Whether to include default formatting shortcuts.
@@ -92,7 +100,7 @@ export function createKeyboardShortcutsPlugin(
 ): Plugin {
   const { shortcuts = {}, includeDefaults = true, disabledShortcuts = [] } = config;
 
-  const keymapObj: Record<string, (state: any, dispatch?: any, view?: any) => boolean> = {};
+  const keymapObj: Record<string, PMCommand> = {};
 
   // Add default shortcuts if enabled
   if (includeDefaults) {
@@ -126,8 +134,8 @@ export function createKeyboardShortcutsPlugin(
  */
 function resolveAction(
   schema: Schema,
-  action: string | ((state: any, dispatch?: any, view?: any) => boolean)
-): ((state: any, dispatch?: any, view?: any) => boolean) | null {
+  action: string | PMCommand
+): PMCommand | null {
   if (typeof action === 'function') {
     return action;
   }
diff --git a/packages/core/src/schema/nodes/image.ts b/packages/core/src/schema/nodes/image.ts
@@ -34,7 +34,7 @@ export const imageNode: NodeSpec = {
           src: img?.getAttribute('src') || '',
           alt: img?.getAttribute('alt') || '',
           caption: element.querySelector('figcaption')?.textContent || '',
-          width: img?.getAttribute('data-width') ? parseInt(img.getAttribute('data-width')!) : null,
+          width: img?.getAttribute('data-width') ? parseInt(img.getAttribute('data-width') ?? '0') : null,
           alignment: element.getAttribute('data-alignment') || 'center',
         };
       },
diff --git a/packages/core/src/schema/nodes/orderedList.ts b/packages/core/src/schema/nodes/orderedList.ts
@@ -40,7 +40,7 @@ export const orderedListNode: NodeSpec = {
       tag: 'ol',
       getAttrs(node) {
         const ol = node as HTMLElement;
-        return { start: ol.hasAttribute('start') ? parseInt(ol.getAttribute('start')!, 10) : 1 };
+        return { start: ol.hasAttribute('start') ? parseInt(ol.getAttribute('start') ?? '1', 10) : 1 };
       },
     },
   ],
diff --git a/packages/react/package.json b/packages/react/package.json
diff --git a/packages/react/src/blocks/createReactBlockSpec.tsx b/packages/react/src/blocks/createReactBlockSpec.tsx
diff --git a/packages/react/src/hooks/useOpenBlock.ts b/packages/react/src/hooks/useOpenBlock.ts
diff --git a/packages/react/src/index.ts b/packages/react/src/index.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@labbs/openblock-example-basic",`
`3`		`- "version": "0.0.1",`
	`3`	`+ "version": "1.0.0",`
`4`	`4`	`"private": true,`
`5`	`5`	`"type": "module",`
`6`	`6`	`"scripts": {`
Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,12 @@`
`1`	`1`	`/**`
`2`		`- * @openblock/core`
	`2`	`+ * @labbs/openblock-core`
`3`	`3`	`*`
`4`	`4`	`* A fully open-source, framework-agnostic rich text editor built on ProseMirror.`
`5`	`5`	`* All APIs are PUBLIC - this is a core principle of OpenBlock.`
`6`	`6`	`*`
`7`	`7`	`* @example`
`8`	`8`	* ```typescript
`9`		`- * import { OpenBlockEditor } from '@openblock/core';`
	`9`	`+ * import { OpenBlockEditor } from '@labbs/openblock-core';`
`10`	`10`	`*`
`11`	`11`	`* const editor = new OpenBlockEditor({`
`12`	`12`	`* element: document.getElementById('editor'),`
Original file line number	Diff line number	Diff line change
`@@ -276,7 +276,7 @@ export function createDragDropPlugin(config: DragDropConfig = {}): Plugin {`
`276`	`276`	`}`
`277`	`277`
`278`	`278`	`// Cache for block positions to avoid repeated doc.descendants calls`
`279`		`- let blockPosCache: Map<string, number> = new Map();`
	`279`	`+ const blockPosCache: Map<string, number> = new Map();`
`280`	`280`	`let lastDocVersion: number = -1;`
`281`	`281`
`282`	`282`	`/**`