Merge pull request #59 from reedsy/catchup

Catch up to upstream

CHANGELOG.md

@@ -1,8 +1,15 @@
 # [Unreleased]
 
+- **Clipboard** Add support for Quill v1 list attributes
+- Fix overload declarations for `quill.formatText()` and other methods
+
+# 2.0.0-rc.4
+
 - Include source maps for Parchment
 - **Clipboard** Support pasting links copied from iOS share sheets
 - Fix config parsing where undefined values were kept
+- Expose types for Quill options
+- Remove empty .css.js files generated by bundlers
 
 # 2.0.0-rc.3
 

README.md

@@ -49,7 +49,7 @@ Instantiate a new Quill object with a css selector for the div that should becom
 ```html
 <!-- Include Quill stylesheet -->
 <link
-  href="https://cdn.jsdelivr.net/npm/[email protected].2/dist/quill.snow.css"
+  href="https://cdn.jsdelivr.net/npm/[email protected].4/dist/quill.snow.css"
   rel="stylesheet"
 />
 
@@ -67,7 +67,7 @@ Instantiate a new Quill object with a css selector for the div that should becom
 </div>
 
 <!-- Include the Quill library -->
-<script src="https://cdn.jsdelivr.net/npm/[email protected].2/dist/quill.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/[email protected].4/dist/quill.js"></script>
 
 <!-- Initialize Quill editor -->
 <script>
@@ -89,24 +89,24 @@ npm install quill@rc
 
 ```html
 <!-- Main Quill library -->
-<script src="https://cdn.jsdelivr.net/npm/[email protected].2/dist/quill.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/[email protected].4/dist/quill.js"></script>
 
 <!-- Theme included stylesheets -->
 <link
-  href="https://cdn.jsdelivr.net/npm/[email protected].2/dist/quill.snow.css"
+  href="https://cdn.jsdelivr.net/npm/[email protected].4/dist/quill.snow.css"
   rel="stylesheet"
 />
 <link
-  href="https://cdn.jsdelivr.net/npm/[email protected].2/dist/quill.bubble.css"
+  href="https://cdn.jsdelivr.net/npm/[email protected].4/dist/quill.bubble.css"
   rel="stylesheet"
 />
 
 <!-- Core build with no theme, formatting, non-essential modules -->
 <link
-  href="https://cdn.jsdelivr.net/npm/[email protected].2/dist/quill.core.css"
+  href="https://cdn.jsdelivr.net/npm/[email protected].4/dist/quill.core.css"
   rel="stylesheet"
 />
-<script src="https://cdn.jsdelivr.net/npm/[email protected].2/dist/quill.core.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/[email protected].4/dist/quill.core.js"></script>
 ```
 
 ## Community

package.json

@@ -1,6 +1,6 @@
 {
   "name": "quill-monorepo",
-  "version": "2.0.0-rc.3",
+  "version": "2.0.0-rc.4",
   "description": "Quill development environment",
   "private": true,
   "author": "Jason Chen <[email protected]>",

packages/quill/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reedsy/quill",
-  "version": "2.0.0-reedsy-5.0.3",
+  "version": "2.0.0-reedsy-5.0.4",
   "description": "Your powerful, rich text editor",
   "author": "Jason Chen <[email protected]>",
   "homepage": "https://quilljs.com",

packages/quill/scripts/build

@@ -13,6 +13,8 @@ mv $TMPDIR/src/* $DIST
 rm -rf $TMPDIR
 npx babel src --out-dir $DIST --copy-files --no-copy-ignored --extensions .ts --source-maps
 npx webpack -- --mode $1
+# https://github.com/webpack-contrib/mini-css-extract-plugin/issues/151
+rm -rf $DIST/dist/*.css.js $DIST/dist/*.css.js.*
 cp package.json $DIST
 cp README.md $DIST
 cp LICENSE $DIST

packages/quill/src/core.ts

@@ -1,4 +1,10 @@
-import Quill from './core/quill.js';
+import Quill, { Parchment, Range } from './core/quill.js';
+import type {
+  DebugLevel,
+  EmitterSource,
+  ExpandedQuillOptions,
+  QuillOptions,
+} from './core/quill.js';
 
 import Block, { BlockEmbed } from './blots/block.js';
 import Break from './blots/break.js';
@@ -19,7 +25,8 @@ import Composition from './core/composition.js';
 import Selection from './core/selection.js';
 import UINode from './modules/uiNode.js';
 
-export { Delta, Op, OpIterator, AttributeMap };
+export { Delta, Op, OpIterator, AttributeMap, Parchment, Range };
+export type { DebugLevel, EmitterSource, ExpandedQuillOptions, QuillOptions };
 
 Quill.register({
   'blots/block': Block,

packages/quill/src/core/quill.ts

@@ -31,18 +31,41 @@ const debug = logger('quill');
 const globalRegistry = new Parchment.Registry();
 Parchment.ParentBlot.uiClass = 'ql-ui';
 
-interface Options {
+/**
+ * Options for initializing a Quill instance
+ */
+export interface QuillOptions {
   theme?: string;
   debug?: DebugLevel | boolean;
   registry?: Parchment.Registry;
+  /**
+   * Whether to disable the editing
+   * @default false
+   */
   readOnly?: boolean;
+
+  /**
+   * Placeholder text to display when the editor is empty
+   * @default ""
+   */
   placeholder?: string;
   bounds?: HTMLElement | string | null;
   modules?: Record<string, unknown>;
+
+  /**
+   * A list of formats that are recognized and can exist within the editor contents.
+   * `null` means all formats are allowed.
+   * @default null
+   */
   formats?: string[] | null;
 }
 
-interface ExpandedOptions extends Omit<Options, 'theme' | 'formats'> {
+/**
+ * Similar to QuillOptions, but with all properties expanded to their default values,
+ * and all selectors resolved to HTMLElements.
+ */
+export interface ExpandedQuillOptions
+  extends Omit<QuillOptions, 'theme' | 'formats'> {
   theme: ThemeConstructor;
   registry: Parchment.Registry;
   container: HTMLElement;
@@ -64,7 +87,7 @@ class Quill {
     readOnly: false,
     registry: globalRegistry,
     theme: 'default',
-  } satisfies Partial<Options>;
+  } satisfies Partial<QuillOptions>;
   static events = Emitter.events;
   static sources = Emitter.sources;
   static version = typeof QUILL_VERSION === 'undefined' ? 'dev' : QUILL_VERSION;
@@ -146,7 +169,7 @@ class Quill {
   root: HTMLDivElement;
   scroll: Scroll;
   emitter: Emitter;
-  allowReadOnlyEdits: boolean;
+  protected allowReadOnlyEdits: boolean;
   editor: Editor;
   composition: Composition;
   selection: Selection;
@@ -157,9 +180,9 @@ class Quill {
   history: History;
   uploader: Uploader;
 
-  options: ExpandedOptions;
+  options: ExpandedQuillOptions;
 
-  constructor(container: HTMLElement | string, options: Options = {}) {
+  constructor(container: HTMLElement | string, options: QuillOptions = {}) {
     this.options = expandConfig(container, options);
     this.container = this.options.container;
     if (this.container == null) {
@@ -390,7 +413,13 @@ class Quill {
     length: number,
     name: string,
     value: unknown,
-    source: EmitterSource,
+    source?: EmitterSource,
+  ): Delta;
+  formatText(
+    index: number,
+    length: number,
+    formats: Record<string, unknown>,
+    source?: EmitterSource,
   ): Delta;
   formatText(
     index: number | { index: number; length: number },
@@ -546,24 +575,24 @@ class Quill {
     );
   }
 
-  insertText(index: number, text: string, source: EmitterSource): Delta;
+  insertText(index: number, text: string, source?: EmitterSource): Delta;
   insertText(
     index: number,
     text: string,
     formats: Record<string, unknown>,
-    source: EmitterSource,
+    source?: EmitterSource,
   ): Delta;
   insertText(
     index: number,
     text: string,
     name: string,
     value: unknown,
-    source: EmitterSource,
+    source?: EmitterSource,
   ): Delta;
   insertText(
     index: number,
     text: string,
-    name: string | Record<string, unknown> | EmitterSource,
+    name?: string | Record<string, unknown> | EmitterSource,
     value?: unknown,
     source?: EmitterSource,
   ): Delta {
@@ -625,8 +654,8 @@ class Quill {
     return this.emitter.once(...args);
   }
 
-  removeFormat(...args: Parameters<typeof overload>) {
-    const [index, length, , source] = overload(...args);
+  removeFormat(index: number, length: number, source?: EmitterSource) {
+    [index, length, , source] = overload(index, length, source);
     return modify.call(
       this,
       () => {
@@ -748,16 +777,16 @@ function expandModuleConfig(config: Record<string, unknown> | undefined) {
   );
 }
 
-function omitUndefinedValuesFromOptions(obj: Options) {
+function omitUndefinedValuesFromOptions(obj: QuillOptions) {
   return Object.fromEntries(
     Object.entries(obj).filter((entry) => entry[1] !== undefined),
   );
 }
 
 function expandConfig(
   containerOrSelector: HTMLElement | string,
-  options: Options,
-): ExpandedOptions {
+  options: QuillOptions,
+): ExpandedQuillOptions {
   const container = resolveSelector(containerOrSelector);
   if (!container) {
     throw new Error('Invalid Quill container');
@@ -775,7 +804,7 @@ function expandConfig(
   const { modules: quillModuleDefaults, ...quillDefaults } = Quill.DEFAULTS;
   const { modules: themeModuleDefaults, ...themeDefaults } = theme.DEFAULTS;
 
-  const modules: ExpandedOptions['modules'] = merge(
+  const modules: ExpandedQuillOptions['modules'] = merge(
     {},
     expandModuleConfig(quillModuleDefaults),
     expandModuleConfig(themeModuleDefaults),
@@ -1005,4 +1034,7 @@ function shiftRange(
   return new Range(start, end - start);
 }
 
+export type { DebugLevel, EmitterSource };
+export { Parchment, Range };
+
 export { globalRegistry, expandConfig, overload, Quill as default };

packages/quill/src/modules/clipboard.ts

@@ -539,8 +539,14 @@ function matchIndent(node: Node, delta: Delta, scroll: ScrollBlot) {
 }
 
 function matchList(node: Node, delta: Delta, scroll: ScrollBlot) {
-  // @ts-expect-error
-  const list = node.tagName === 'OL' ? 'ordered' : 'bullet';
+  const element = node as Element;
+  let list = element.tagName === 'OL' ? 'ordered' : 'bullet';
+
+  const checkedAttr = element.getAttribute('data-checked');
+  if (checkedAttr) {
+    list = checkedAttr === 'true' ? 'checked' : 'unchecked';
+  }
+
   return applyFormat(delta, 'list', list, scroll);
 }
 

packages/quill/src/quill.ts

@@ -1,4 +1,10 @@
-import Quill from './core.js';
+import Quill, { Parchment, Range } from './core.js';
+import type {
+  DebugLevel,
+  EmitterSource,
+  ExpandedQuillOptions,
+  QuillOptions,
+} from './core.js';
 
 import { AlignClass, AlignStyle } from './formats/align.js';
 import {
@@ -108,4 +114,7 @@ Quill.register(
   true,
 );
 
+export type { DebugLevel, EmitterSource, ExpandedQuillOptions, QuillOptions };
+export { Parchment, Range };
+
 export default Quill;