feat(core): add context to extension builder (#22)

The key-value storage context has been added to the ExtensionBuilder, which allows you to transfer data between extensions.

Author: d3m1d0v

src/core/ExtensionBuilder.ts

@@ -38,7 +38,24 @@ enum PluginPriority {
 
 const DEFAULT_PRIORITY = PluginPriority.Medium;
 
+type BuilderContext<T extends object> = {
+    has(key: keyof T): boolean;
+    get<K extends keyof T>(key: K): T[K] | undefined;
+    set<K extends keyof T>(key: K, value: T[K]): BuilderContext<T>;
+};
+
+declare global {
+    namespace YfmEditor {
+        interface Context {}
+    }
+}
+
 export class ExtensionBuilder {
+    static createContext(): BuilderContext<YfmEditor.Context> {
+        return new Map();
+    }
+
+    // eslint-disable-next-line @typescript-eslint/member-ordering
     static readonly PluginPriority = PluginPriority;
     readonly PluginPriority = ExtensionBuilder.PluginPriority;
 
@@ -48,6 +65,12 @@ export class ExtensionBuilder {
     #plugins: {cb: AddPmPluginCallback; priority: number}[] = [];
     #actions: [string, AddActionCallback][] = [];
 
+    readonly context: BuilderContext<YfmEditor.Context>;
+
+    constructor(context?: BuilderContext<YfmEditor.Context>) {
+        this.context = context ?? ExtensionBuilder.createContext();
+    }
+
     use(extension: Extension): this;
     use<T>(extension: ExtensionWithOptions<T>, options: T): this;
     use(extension: ExtensionWithParams, ...params: any[]): this {

src/extensions/markdown/Breaks/index.ts

@@ -1,5 +1,6 @@
 import type {NodeType} from 'prosemirror-model';
 import {chainCommands, exitCode} from 'prosemirror-commands';
+import {logger} from '../../../logger';
 import type {ExtensionAuto, Keymap} from '../../../core';
 import {isMac} from '../../../utils/platform';
 import {nodeTypeFactory} from '../../../utils/schema';
@@ -10,12 +11,25 @@ export const hbType = nodeTypeFactory(hardBreak);
 export const sbType = nodeTypeFactory(softBreak);
 
 export type BreaksOptions = {
-    // TODO: [builder context] get this parameter from builder context
-    /** @default 'hard' */
+    /**
+     * This option is used if the 'breaks' parameter is not specified via the context
+     * @default 'hard'
+     */
+    // TODO: [context] make this deprecated
     preferredBreak?: 'hard' | 'soft';
 };
 
 export const Breaks: ExtensionAuto<BreaksOptions> = (builder, opts) => {
+    let preferredBreak: 'hard' | 'soft';
+    if (builder.context.has('breaks')) {
+        preferredBreak = builder.context.get('breaks') ? 'soft' : 'hard';
+    } else {
+        preferredBreak = opts.preferredBreak ?? 'hard';
+        logger.info(
+            "[Breaks extension]: Parameter 'breaks' is not defined in context; value from options is used",
+        );
+    }
+
     builder.addNode(hardBreak, () => ({
         spec: {
             inline: true,
@@ -62,7 +76,7 @@ export const Breaks: ExtensionAuto<BreaksOptions> = (builder, opts) => {
     }));
 
     builder.addKeymap(({schema}) => {
-        const cmd = addBr((opts?.preferredBreak === 'soft' ? sbType : hbType)(schema));
+        const cmd = addBr((preferredBreak === 'soft' ? sbType : hbType)(schema));
         const keys: Keymap = {
             'Shift-Enter': cmd,
         };
@@ -80,3 +94,14 @@ const addBr = (br: NodeType) =>
         dispatch?.(state.tr.replaceSelectionWith(br.create()).scrollIntoView());
         return true;
     });
+
+declare global {
+    namespace YfmEditor {
+        interface Context {
+            /**
+             * Same as @type {MarkdownIt.Options.breaks}
+             */
+            breaks: boolean;
+        }
+    }
+}

src/extensions/markdown/Html/index.ts

@@ -1,10 +1,16 @@
+import {logger} from '../../../logger';
 import {createExtension, ExtensionAuto} from '../../../core';
 import {HtmlNode} from './const';
 import {fromYfm} from './fromYfm';
 import {spec} from './spec';
 import {toYfm} from './toYfm';
 
 export const Html: ExtensionAuto = (builder) => {
+    if (builder.context.has('html') && builder.context.get('html') === false) {
+        logger.info('[HTML extension]: Skip extension, because HTML disabled via context');
+        return;
+    }
+
     builder.addNode(HtmlNode.Block, () => ({
         spec: spec[HtmlNode.Block],
         fromYfm: {tokenSpec: fromYfm[HtmlNode.Block]},
@@ -24,3 +30,14 @@ export const Html: ExtensionAuto = (builder) => {
  * Remove after WIKI-16660
  */
 export const HtmlE = createExtension((b, o = {}) => b.use(Html, o));
+
+declare global {
+    namespace YfmEditor {
+        interface Context {
+            /**
+             * Same as @type {MarkdownIt.Options.html}
+             */
+            html: boolean;
+        }
+    }
+}