@tiptap/extension-code-block 2.0.0-beta.9 → 2.0.0-rc.1

package/dist/index.umd.js

@@ -0,0 +1,215 @@
+(function (global, factory) {
+  typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('@tiptap/core'), require('@tiptap/pm/state')) :
+  typeof define === 'function' && define.amd ? define(['exports', '@tiptap/core', '@tiptap/pm/state'], factory) :
+  (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["@tiptap/extension-code-block"] = {}, global.core, global.state));
+})(this, (function (exports, core, state) { 'use strict';
+
+  const backtickInputRegex = /^```([a-z]+)?[\s\n]$/;
+  const tildeInputRegex = /^~~~([a-z]+)?[\s\n]$/;
+  const CodeBlock = core.Node.create({
+      name: 'codeBlock',
+      addOptions() {
+          return {
+              languageClassPrefix: 'language-',
+              exitOnTripleEnter: true,
+              exitOnArrowDown: true,
+              HTMLAttributes: {},
+          };
+      },
+      content: 'text*',
+      marks: '',
+      group: 'block',
+      code: true,
+      defining: true,
+      addAttributes() {
+          return {
+              language: {
+                  default: null,
+                  parseHTML: element => {
+                      var _a;
+                      const { languageClassPrefix } = this.options;
+                      const classNames = [...(((_a = element.firstElementChild) === null || _a === void 0 ? void 0 : _a.classList) || [])];
+                      const languages = classNames
+                          .filter(className => className.startsWith(languageClassPrefix))
+                          .map(className => className.replace(languageClassPrefix, ''));
+                      const language = languages[0];
+                      if (!language) {
+                          return null;
+                      }
+                      return language;
+                  },
+                  rendered: false,
+              },
+          };
+      },
+      parseHTML() {
+          return [
+              {
+                  tag: 'pre',
+                  preserveWhitespace: 'full',
+              },
+          ];
+      },
+      renderHTML({ node, HTMLAttributes }) {
+          return [
+              'pre',
+              core.mergeAttributes(this.options.HTMLAttributes, HTMLAttributes),
+              [
+                  'code',
+                  {
+                      class: node.attrs.language
+                          ? this.options.languageClassPrefix + node.attrs.language
+                          : null,
+                  },
+                  0,
+              ],
+          ];
+      },
+      addCommands() {
+          return {
+              setCodeBlock: attributes => ({ commands }) => {
+                  return commands.setNode(this.name, attributes);
+              },
+              toggleCodeBlock: attributes => ({ commands }) => {
+                  return commands.toggleNode(this.name, 'paragraph', attributes);
+              },
+          };
+      },
+      addKeyboardShortcuts() {
+          return {
+              'Mod-Alt-c': () => this.editor.commands.toggleCodeBlock(),
+              // remove code block when at start of document or code block is empty
+              Backspace: () => {
+                  const { empty, $anchor } = this.editor.state.selection;
+                  const isAtStart = $anchor.pos === 1;
+                  if (!empty || $anchor.parent.type.name !== this.name) {
+                      return false;
+                  }
+                  if (isAtStart || !$anchor.parent.textContent.length) {
+                      return this.editor.commands.clearNodes();
+                  }
+                  return false;
+              },
+              // exit node on triple enter
+              Enter: ({ editor }) => {
+                  if (!this.options.exitOnTripleEnter) {
+                      return false;
+                  }
+                  const { state } = editor;
+                  const { selection } = state;
+                  const { $from, empty } = selection;
+                  if (!empty || $from.parent.type !== this.type) {
+                      return false;
+                  }
+                  const isAtEnd = $from.parentOffset === $from.parent.nodeSize - 2;
+                  const endsWithDoubleNewline = $from.parent.textContent.endsWith('\n\n');
+                  if (!isAtEnd || !endsWithDoubleNewline) {
+                      return false;
+                  }
+                  return editor
+                      .chain()
+                      .command(({ tr }) => {
+                      tr.delete($from.pos - 2, $from.pos);
+                      return true;
+                  })
+                      .exitCode()
+                      .run();
+              },
+              // exit node on arrow down
+              ArrowDown: ({ editor }) => {
+                  if (!this.options.exitOnArrowDown) {
+                      return false;
+                  }
+                  const { state } = editor;
+                  const { selection, doc } = state;
+                  const { $from, empty } = selection;
+                  if (!empty || $from.parent.type !== this.type) {
+                      return false;
+                  }
+                  const isAtEnd = $from.parentOffset === $from.parent.nodeSize - 2;
+                  if (!isAtEnd) {
+                      return false;
+                  }
+                  const after = $from.after();
+                  if (after === undefined) {
+                      return false;
+                  }
+                  const nodeAfter = doc.nodeAt(after);
+                  if (nodeAfter) {
+                      return false;
+                  }
+                  return editor.commands.exitCode();
+              },
+          };
+      },
+      addInputRules() {
+          return [
+              core.textblockTypeInputRule({
+                  find: backtickInputRegex,
+                  type: this.type,
+                  getAttributes: match => ({
+                      language: match[1],
+                  }),
+              }),
+              core.textblockTypeInputRule({
+                  find: tildeInputRegex,
+                  type: this.type,
+                  getAttributes: match => ({
+                      language: match[1],
+                  }),
+              }),
+          ];
+      },
+      addProseMirrorPlugins() {
+          return [
+              // this plugin creates a code block for pasted content from VS Code
+              // we can also detect the copied code language
+              new state.Plugin({
+                  key: new state.PluginKey('codeBlockVSCodeHandler'),
+                  props: {
+                      handlePaste: (view, event) => {
+                          if (!event.clipboardData) {
+                              return false;
+                          }
+                          // don’t create a new code block within code blocks
+                          if (this.editor.isActive(this.type.name)) {
+                              return false;
+                          }
+                          const text = event.clipboardData.getData('text/plain');
+                          const vscode = event.clipboardData.getData('vscode-editor-data');
+                          const vscodeData = vscode ? JSON.parse(vscode) : undefined;
+                          const language = vscodeData === null || vscodeData === void 0 ? void 0 : vscodeData.mode;
+                          if (!text || !language) {
+                              return false;
+                          }
+                          const { tr } = view.state;
+                          // create an empty code block
+                          tr.replaceSelectionWith(this.type.create({ language }));
+                          // put cursor inside the newly created code block
+                          tr.setSelection(state.TextSelection.near(tr.doc.resolve(Math.max(0, tr.selection.from - 2))));
+                          // add text to code block
+                          // strip carriage return chars from text pasted as code
+                          // see: https://github.com/ProseMirror/prosemirror-view/commit/a50a6bcceb4ce52ac8fcc6162488d8875613aacd
+                          tr.insertText(text.replace(/\r\n?/g, '\n'));
+                          // store meta information
+                          // this is useful for other plugins that depends on the paste event
+                          // like the paste rule plugin
+                          tr.setMeta('paste', true);
+                          view.dispatch(tr);
+                          return true;
+                      },
+                  },
+              }),
+          ];
+      },
+  });
+
+  exports.CodeBlock = CodeBlock;
+  exports.backtickInputRegex = backtickInputRegex;
+  exports["default"] = CodeBlock;
+  exports.tildeInputRegex = tildeInputRegex;
+
+  Object.defineProperty(exports, '__esModule', { value: true });
+
+}));
+//# sourceMappingURL=index.umd.js.map

package/dist/index.umd.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.umd.js","sources":["../src/code-block.ts"],"sourcesContent":["import { mergeAttributes, Node, textblockTypeInputRule } from '@tiptap/core'\nimport { Plugin, PluginKey, TextSelection } from '@tiptap/pm/state'\n\nexport interface CodeBlockOptions {\n  /**\n   * Adds a prefix to language classes that are applied to code tags.\n   * Defaults to `'language-'`.\n   */\n  languageClassPrefix: string\n  /**\n   * Define whether the node should be exited on triple enter.\n   * Defaults to `true`.\n   */\n  exitOnTripleEnter: boolean\n  /**\n   * Define whether the node should be exited on arrow down if there is no node after it.\n   * Defaults to `true`.\n   */\n  exitOnArrowDown: boolean\n  /**\n   * Custom HTML attributes that should be added to the rendered HTML tag.\n   */\n  HTMLAttributes: Record<string, any>\n}\n\ndeclare module '@tiptap/core' {\n  interface Commands<ReturnType> {\n    codeBlock: {\n      /**\n       * Set a code block\n       */\n      setCodeBlock: (attributes?: { language: string }) => ReturnType\n      /**\n       * Toggle a code block\n       */\n      toggleCodeBlock: (attributes?: { language: string }) => ReturnType\n    }\n  }\n}\n\nexport const backtickInputRegex = /^```([a-z]+)?[\\s\\n]$/\nexport const tildeInputRegex = /^~~~([a-z]+)?[\\s\\n]$/\n\nexport const CodeBlock = Node.create<CodeBlockOptions>({\n  name: 'codeBlock',\n\n  addOptions() {\n    return {\n      languageClassPrefix: 'language-',\n      exitOnTripleEnter: true,\n      exitOnArrowDown: true,\n      HTMLAttributes: {},\n    }\n  },\n\n  content: 'text*',\n\n  marks: '',\n\n  group: 'block',\n\n  code: true,\n\n  defining: true,\n\n  addAttributes() {\n    return {\n      language: {\n        default: null,\n        parseHTML: element => {\n          const { languageClassPrefix } = this.options\n          const classNames = [...(element.firstElementChild?.classList || [])]\n          const languages = classNames\n            .filter(className => className.startsWith(languageClassPrefix))\n            .map(className => className.replace(languageClassPrefix, ''))\n          const language = languages[0]\n\n          if (!language) {\n            return null\n          }\n\n          return language\n        },\n        rendered: false,\n      },\n    }\n  },\n\n  parseHTML() {\n    return [\n      {\n        tag: 'pre',\n        preserveWhitespace: 'full',\n      },\n    ]\n  },\n\n  renderHTML({ node, HTMLAttributes }) {\n    return [\n      'pre',\n      mergeAttributes(this.options.HTMLAttributes, HTMLAttributes),\n      [\n        'code',\n        {\n          class: node.attrs.language\n            ? this.options.languageClassPrefix + node.attrs.language\n            : null,\n        },\n        0,\n      ],\n    ]\n  },\n\n  addCommands() {\n    return {\n      setCodeBlock:\n        attributes => ({ commands }) => {\n          return commands.setNode(this.name, attributes)\n        },\n      toggleCodeBlock:\n        attributes => ({ commands }) => {\n          return commands.toggleNode(this.name, 'paragraph', attributes)\n        },\n    }\n  },\n\n  addKeyboardShortcuts() {\n    return {\n      'Mod-Alt-c': () => this.editor.commands.toggleCodeBlock(),\n\n      // remove code block when at start of document or code block is empty\n      Backspace: () => {\n        const { empty, $anchor } = this.editor.state.selection\n        const isAtStart = $anchor.pos === 1\n\n        if (!empty || $anchor.parent.type.name !== this.name) {\n          return false\n        }\n\n        if (isAtStart || !$anchor.parent.textContent.length) {\n          return this.editor.commands.clearNodes()\n        }\n\n        return false\n      },\n\n      // exit node on triple enter\n      Enter: ({ editor }) => {\n        if (!this.options.exitOnTripleEnter) {\n          return false\n        }\n\n        const { state } = editor\n        const { selection } = state\n        const { $from, empty } = selection\n\n        if (!empty || $from.parent.type !== this.type) {\n          return false\n        }\n\n        const isAtEnd = $from.parentOffset === $from.parent.nodeSize - 2\n        const endsWithDoubleNewline = $from.parent.textContent.endsWith('\\n\\n')\n\n        if (!isAtEnd || !endsWithDoubleNewline) {\n          return false\n        }\n\n        return editor\n          .chain()\n          .command(({ tr }) => {\n            tr.delete($from.pos - 2, $from.pos)\n\n            return true\n          })\n          .exitCode()\n          .run()\n      },\n\n      // exit node on arrow down\n      ArrowDown: ({ editor }) => {\n        if (!this.options.exitOnArrowDown) {\n          return false\n        }\n\n        const { state } = editor\n        const { selection, doc } = state\n        const { $from, empty } = selection\n\n        if (!empty || $from.parent.type !== this.type) {\n          return false\n        }\n\n        const isAtEnd = $from.parentOffset === $from.parent.nodeSize - 2\n\n        if (!isAtEnd) {\n          return false\n        }\n\n        const after = $from.after()\n\n        if (after === undefined) {\n          return false\n        }\n\n        const nodeAfter = doc.nodeAt(after)\n\n        if (nodeAfter) {\n          return false\n        }\n\n        return editor.commands.exitCode()\n      },\n    }\n  },\n\n  addInputRules() {\n    return [\n      textblockTypeInputRule({\n        find: backtickInputRegex,\n        type: this.type,\n        getAttributes: match => ({\n          language: match[1],\n        }),\n      }),\n      textblockTypeInputRule({\n        find: tildeInputRegex,\n        type: this.type,\n        getAttributes: match => ({\n          language: match[1],\n        }),\n      }),\n    ]\n  },\n\n  addProseMirrorPlugins() {\n    return [\n      // this plugin creates a code block for pasted content from VS Code\n      // we can also detect the copied code language\n      new Plugin({\n        key: new PluginKey('codeBlockVSCodeHandler'),\n        props: {\n          handlePaste: (view, event) => {\n            if (!event.clipboardData) {\n              return false\n            }\n\n            // don’t create a new code block within code blocks\n            if (this.editor.isActive(this.type.name)) {\n              return false\n            }\n\n            const text = event.clipboardData.getData('text/plain')\n            const vscode = event.clipboardData.getData('vscode-editor-data')\n            const vscodeData = vscode ? JSON.parse(vscode) : undefined\n            const language = vscodeData?.mode\n\n            if (!text || !language) {\n              return false\n            }\n\n            const { tr } = view.state\n\n            // create an empty code block\n            tr.replaceSelectionWith(this.type.create({ language }))\n\n            // put cursor inside the newly created code block\n            tr.setSelection(TextSelection.near(tr.doc.resolve(Math.max(0, tr.selection.from - 2))))\n\n            // add text to code block\n            // strip carriage return chars from text pasted as code\n            // see: https://github.com/ProseMirror/prosemirror-view/commit/a50a6bcceb4ce52ac8fcc6162488d8875613aacd\n            tr.insertText(text.replace(/\\r\\n?/g, '\\n'))\n\n            // store meta information\n            // this is useful for other plugins that depends on the paste event\n            // like the paste rule plugin\n            tr.setMeta('paste', true)\n\n            view.dispatch(tr)\n\n            return true\n          },\n        },\n      }),\n    ]\n  },\n})\n"],"names":["Node","mergeAttributes","textblockTypeInputRule","Plugin","PluginKey","TextSelection"],"mappings":";;;;;;AAwCO,QAAM,kBAAkB,GAAG,uBAAsB;AACjD,QAAM,eAAe,GAAG,uBAAsB;AAExC,QAAA,SAAS,GAAGA,SAAI,CAAC,MAAM,CAAmB;EACrD,IAAA,IAAI,EAAE,WAAW;MAEjB,UAAU,GAAA;UACR,OAAO;EACL,YAAA,mBAAmB,EAAE,WAAW;EAChC,YAAA,iBAAiB,EAAE,IAAI;EACvB,YAAA,eAAe,EAAE,IAAI;EACrB,YAAA,cAAc,EAAE,EAAE;WACnB,CAAA;OACF;EAED,IAAA,OAAO,EAAE,OAAO;EAEhB,IAAA,KAAK,EAAE,EAAE;EAET,IAAA,KAAK,EAAE,OAAO;EAEd,IAAA,IAAI,EAAE,IAAI;EAEV,IAAA,QAAQ,EAAE,IAAI;MAEd,aAAa,GAAA;UACX,OAAO;EACL,YAAA,QAAQ,EAAE;EACR,gBAAA,OAAO,EAAE,IAAI;kBACb,SAAS,EAAE,OAAO,IAAG;;EACnB,oBAAA,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;EAC5C,oBAAA,MAAM,UAAU,GAAG,CAAC,IAAI,CAAA,CAAA,EAAA,GAAA,OAAO,CAAC,iBAAiB,0CAAE,SAAS,KAAI,EAAE,CAAC,CAAC,CAAA;sBACpE,MAAM,SAAS,GAAG,UAAU;2BACzB,MAAM,CAAC,SAAS,IAAI,SAAS,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;EAC9D,yBAAA,GAAG,CAAC,SAAS,IAAI,SAAS,CAAC,OAAO,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC,CAAA;EAC/D,oBAAA,MAAM,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA;sBAE7B,IAAI,CAAC,QAAQ,EAAE;EACb,wBAAA,OAAO,IAAI,CAAA;EACZ,qBAAA;EAED,oBAAA,OAAO,QAAQ,CAAA;mBAChB;EACD,gBAAA,QAAQ,EAAE,KAAK;EAChB,aAAA;WACF,CAAA;OACF;MAED,SAAS,GAAA;UACP,OAAO;EACL,YAAA;EACE,gBAAA,GAAG,EAAE,KAAK;EACV,gBAAA,kBAAkB,EAAE,MAAM;EAC3B,aAAA;WACF,CAAA;OACF;EAED,IAAA,UAAU,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,EAAA;UACjC,OAAO;cACL,KAAK;cACLC,oBAAe,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,cAAc,CAAC;EAC5D,YAAA;kBACE,MAAM;EACN,gBAAA;EACE,oBAAA,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ;4BACtB,IAAI,CAAC,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ;EACxD,0BAAE,IAAI;EACT,iBAAA;kBACD,CAAC;EACF,aAAA;WACF,CAAA;OACF;MAED,WAAW,GAAA;UACT,OAAO;cACL,YAAY,EACV,UAAU,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAI;kBAC7B,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAA;eAC/C;cACH,eAAe,EACb,UAAU,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAI;EAC7B,gBAAA,OAAO,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,UAAU,CAAC,CAAA;eAC/D;WACJ,CAAA;OACF;MAED,oBAAoB,GAAA;UAClB,OAAO;cACL,WAAW,EAAE,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,EAAE;;cAGzD,SAAS,EAAE,MAAK;EACd,gBAAA,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAA;EACtD,gBAAA,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,KAAK,CAAC,CAAA;EAEnC,gBAAA,IAAI,CAAC,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE;EACpD,oBAAA,OAAO,KAAK,CAAA;EACb,iBAAA;kBAED,IAAI,SAAS,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE;sBACnD,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAA;EACzC,iBAAA;EAED,gBAAA,OAAO,KAAK,CAAA;eACb;;EAGD,YAAA,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,KAAI;EACpB,gBAAA,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE;EACnC,oBAAA,OAAO,KAAK,CAAA;EACb,iBAAA;EAED,gBAAA,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAA;EACxB,gBAAA,MAAM,EAAE,SAAS,EAAE,GAAG,KAAK,CAAA;EAC3B,gBAAA,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,SAAS,CAAA;EAElC,gBAAA,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE;EAC7C,oBAAA,OAAO,KAAK,CAAA;EACb,iBAAA;EAED,gBAAA,MAAM,OAAO,GAAG,KAAK,CAAC,YAAY,KAAK,KAAK,CAAC,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAA;EAChE,gBAAA,MAAM,qBAAqB,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;EAEvE,gBAAA,IAAI,CAAC,OAAO,IAAI,CAAC,qBAAqB,EAAE;EACtC,oBAAA,OAAO,KAAK,CAAA;EACb,iBAAA;EAED,gBAAA,OAAO,MAAM;EACV,qBAAA,KAAK,EAAE;EACP,qBAAA,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,KAAI;EAClB,oBAAA,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAA;EAEnC,oBAAA,OAAO,IAAI,CAAA;EACb,iBAAC,CAAC;EACD,qBAAA,QAAQ,EAAE;EACV,qBAAA,GAAG,EAAE,CAAA;eACT;;EAGD,YAAA,SAAS,EAAE,CAAC,EAAE,MAAM,EAAE,KAAI;EACxB,gBAAA,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE;EACjC,oBAAA,OAAO,KAAK,CAAA;EACb,iBAAA;EAED,gBAAA,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAA;EACxB,gBAAA,MAAM,EAAE,SAAS,EAAE,GAAG,EAAE,GAAG,KAAK,CAAA;EAChC,gBAAA,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,SAAS,CAAA;EAElC,gBAAA,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE;EAC7C,oBAAA,OAAO,KAAK,CAAA;EACb,iBAAA;EAED,gBAAA,MAAM,OAAO,GAAG,KAAK,CAAC,YAAY,KAAK,KAAK,CAAC,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAA;kBAEhE,IAAI,CAAC,OAAO,EAAE;EACZ,oBAAA,OAAO,KAAK,CAAA;EACb,iBAAA;EAED,gBAAA,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,CAAA;kBAE3B,IAAI,KAAK,KAAK,SAAS,EAAE;EACvB,oBAAA,OAAO,KAAK,CAAA;EACb,iBAAA;kBAED,MAAM,SAAS,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;EAEnC,gBAAA,IAAI,SAAS,EAAE;EACb,oBAAA,OAAO,KAAK,CAAA;EACb,iBAAA;EAED,gBAAA,OAAO,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAA;eAClC;WACF,CAAA;OACF;MAED,aAAa,GAAA;UACX,OAAO;EACL,YAAAC,2BAAsB,CAAC;EACrB,gBAAA,IAAI,EAAE,kBAAkB;kBACxB,IAAI,EAAE,IAAI,CAAC,IAAI;EACf,gBAAA,aAAa,EAAE,KAAK,KAAK;EACvB,oBAAA,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;mBACnB,CAAC;eACH,CAAC;EACF,YAAAA,2BAAsB,CAAC;EACrB,gBAAA,IAAI,EAAE,eAAe;kBACrB,IAAI,EAAE,IAAI,CAAC,IAAI;EACf,gBAAA,aAAa,EAAE,KAAK,KAAK;EACvB,oBAAA,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;mBACnB,CAAC;eACH,CAAC;WACH,CAAA;OACF;MAED,qBAAqB,GAAA;UACnB,OAAO;;;EAGL,YAAA,IAAIC,YAAM,CAAC;EACT,gBAAA,GAAG,EAAE,IAAIC,eAAS,CAAC,wBAAwB,CAAC;EAC5C,gBAAA,KAAK,EAAE;EACL,oBAAA,WAAW,EAAE,CAAC,IAAI,EAAE,KAAK,KAAI;EAC3B,wBAAA,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE;EACxB,4BAAA,OAAO,KAAK,CAAA;EACb,yBAAA;;EAGD,wBAAA,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;EACxC,4BAAA,OAAO,KAAK,CAAA;EACb,yBAAA;0BAED,MAAM,IAAI,GAAG,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;0BACtD,MAAM,MAAM,GAAG,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAA;EAChE,wBAAA,MAAM,UAAU,GAAG,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;0BAC1D,MAAM,QAAQ,GAAG,UAAU,KAAA,IAAA,IAAV,UAAU,KAAV,KAAA,CAAA,GAAA,KAAA,CAAA,GAAA,UAAU,CAAE,IAAI,CAAA;EAEjC,wBAAA,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE;EACtB,4BAAA,OAAO,KAAK,CAAA;EACb,yBAAA;EAED,wBAAA,MAAM,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,CAAA;;EAGzB,wBAAA,EAAE,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAA;;EAGvD,wBAAA,EAAE,CAAC,YAAY,CAACC,mBAAa,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;;;;EAKvF,wBAAA,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAA;;;;EAK3C,wBAAA,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;EAEzB,wBAAA,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;EAEjB,wBAAA,OAAO,IAAI,CAAA;uBACZ;EACF,iBAAA;eACF,CAAC;WACH,CAAA;OACF;EACF,CAAA;;;;;;;;;;;;;"}

package/dist/packages/extension-code-block/src/code-block.d.ts

@@ -1,26 +1,43 @@
-import { Command, Node } from '@tiptap/core';
+import { Node } from '@tiptap/core';
 export interface CodeBlockOptions {
+    /**
+     * Adds a prefix to language classes that are applied to code tags.
+     * Defaults to `'language-'`.
+     */
     languageClassPrefix: string;
+    /**
+     * Define whether the node should be exited on triple enter.
+     * Defaults to `true`.
+     */
+    exitOnTripleEnter: boolean;
+    /**
+     * Define whether the node should be exited on arrow down if there is no node after it.
+     * Defaults to `true`.
+     */
+    exitOnArrowDown: boolean;
+    /**
+     * Custom HTML attributes that should be added to the rendered HTML tag.
+     */
     HTMLAttributes: Record<string, any>;
 }
 declare module '@tiptap/core' {
-    interface Commands {
+    interface Commands<ReturnType> {
         codeBlock: {
             /**
              * Set a code block
              */
             setCodeBlock: (attributes?: {
                 language: string;
-            }) => Command;
+            }) => ReturnType;
             /**
              * Toggle a code block
              */
             toggleCodeBlock: (attributes?: {
                 language: string;
-            }) => Command;
+            }) => ReturnType;
         };
     }
 }
 export declare const backtickInputRegex: RegExp;
 export declare const tildeInputRegex: RegExp;
-export declare const CodeBlock: Node<CodeBlockOptions>;
+export declare const CodeBlock: Node<CodeBlockOptions, any>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tiptap/extension-code-block",
   "description": "code block extension for tiptap",
-  "version": "2.0.0-beta.9",
+  "version": "2.0.0-rc.1",
   "homepage": "https://tiptap.dev",
   "keywords": [
     "tiptap",
@@ -12,19 +12,37 @@
     "type": "github",
     "url": "https://github.com/sponsors/ueberdosis"
   },
-  "main": "dist/tiptap-extension-code-block.cjs.js",
-  "umd": "dist/tiptap-extension-code-block.umd.js",
-  "module": "dist/tiptap-extension-code-block.esm.js",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/packages/extension-code-block/src/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "umd": "dist/index.umd.js",
   "types": "dist/packages/extension-code-block/src/index.d.ts",
   "files": [
     "src",
     "dist"
   ],
   "peerDependencies": {
-    "@tiptap/core": "^2.0.0-beta.1"
+    "@tiptap/core": "2.0.0-rc.1",
+    "@tiptap/pm": "2.0.0-rc.1"
+  },
+  "devDependencies": {
+    "@tiptap/core": "2.0.0-rc.1",
+    "@tiptap/pm": "2.0.0-rc.1"
   },
-  "dependencies": {
-    "prosemirror-inputrules": "^1.1.3"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ueberdosis/tiptap",
+    "directory": "packages/extension-code-block"
   },
-  "gitHead": "c64520b74dab6b127c78960c1bd0af237b1f68fb"
-}
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "npm run clean && rollup -c"
+  }
+}

package/src/code-block.ts

@@ -1,35 +1,56 @@
-import { Command, Node } from '@tiptap/core'
-import { textblockTypeInputRule } from 'prosemirror-inputrules'
+import { mergeAttributes, Node, textblockTypeInputRule } from '@tiptap/core'
+import { Plugin, PluginKey, TextSelection } from '@tiptap/pm/state'
 
 export interface CodeBlockOptions {
-  languageClassPrefix: string,
-  HTMLAttributes: Record<string, any>,
+  /**
+   * Adds a prefix to language classes that are applied to code tags.
+   * Defaults to `'language-'`.
+   */
+  languageClassPrefix: string
+  /**
+   * Define whether the node should be exited on triple enter.
+   * Defaults to `true`.
+   */
+  exitOnTripleEnter: boolean
+  /**
+   * Define whether the node should be exited on arrow down if there is no node after it.
+   * Defaults to `true`.
+   */
+  exitOnArrowDown: boolean
+  /**
+   * Custom HTML attributes that should be added to the rendered HTML tag.
+   */
+  HTMLAttributes: Record<string, any>
 }
 
 declare module '@tiptap/core' {
-  interface Commands {
+  interface Commands<ReturnType> {
     codeBlock: {
       /**
        * Set a code block
        */
-      setCodeBlock: (attributes?: { language: string }) => Command,
+      setCodeBlock: (attributes?: { language: string }) => ReturnType
       /**
        * Toggle a code block
        */
-      toggleCodeBlock: (attributes?: { language: string }) => Command,
+      toggleCodeBlock: (attributes?: { language: string }) => ReturnType
     }
   }
 }
 
-export const backtickInputRegex = /^```(?<language>[a-z]*)? $/
-export const tildeInputRegex = /^~~~(?<language>[a-z]*)? $/
+export const backtickInputRegex = /^```([a-z]+)?[\s\n]$/
+export const tildeInputRegex = /^~~~([a-z]+)?[\s\n]$/
 
 export const CodeBlock = Node.create<CodeBlockOptions>({
   name: 'codeBlock',
 
-  defaultOptions: {
-    languageClassPrefix: 'language-',
-    HTMLAttributes: {},
+  addOptions() {
+    return {
+      languageClassPrefix: 'language-',
+      exitOnTripleEnter: true,
+      exitOnArrowDown: true,
+      HTMLAttributes: {},
+    }
   },
 
   content: 'text*',
@@ -47,27 +68,20 @@ export const CodeBlock = Node.create<CodeBlockOptions>({
       language: {
         default: null,
         parseHTML: element => {
-          const classAttribute = element.firstElementChild?.getAttribute('class')
+          const { languageClassPrefix } = this.options
+          const classNames = [...(element.firstElementChild?.classList || [])]
+          const languages = classNames
+            .filter(className => className.startsWith(languageClassPrefix))
+            .map(className => className.replace(languageClassPrefix, ''))
+          const language = languages[0]
 
-          if (!classAttribute) {
+          if (!language) {
             return null
           }
 
-          const regexLanguageClassPrefix = new RegExp(`^(${this.options.languageClassPrefix})`)
-
-          return {
-            language: classAttribute.replace(regexLanguageClassPrefix, ''),
-          }
-        },
-        renderHTML: attributes => {
-          if (!attributes.language) {
-            return null
-          }
-
-          return {
-            class: this.options.languageClassPrefix + attributes.language,
-          }
+          return language
         },
+        rendered: false,
       },
     }
   },
@@ -81,18 +95,32 @@ export const CodeBlock = Node.create<CodeBlockOptions>({
     ]
   },
 
-  renderHTML({ HTMLAttributes }) {
-    return ['pre', this.options.HTMLAttributes, ['code', HTMLAttributes, 0]]
+  renderHTML({ node, HTMLAttributes }) {
+    return [
+      'pre',
+      mergeAttributes(this.options.HTMLAttributes, HTMLAttributes),
+      [
+        'code',
+        {
+          class: node.attrs.language
+            ? this.options.languageClassPrefix + node.attrs.language
+            : null,
+        },
+        0,
+      ],
+    ]
   },
 
   addCommands() {
     return {
-      setCodeBlock: attributes => ({ commands }) => {
-        return commands.setNode('codeBlock', attributes)
-      },
-      toggleCodeBlock: attributes => ({ commands }) => {
-        return commands.toggleNode('codeBlock', 'paragraph', attributes)
-      },
+      setCodeBlock:
+        attributes => ({ commands }) => {
+          return commands.setNode(this.name, attributes)
+        },
+      toggleCodeBlock:
+        attributes => ({ commands }) => {
+          return commands.toggleNode(this.name, 'paragraph', attributes)
+        },
     }
   },
 
@@ -115,13 +143,145 @@ export const CodeBlock = Node.create<CodeBlockOptions>({
 
         return false
       },
+
+      // exit node on triple enter
+      Enter: ({ editor }) => {
+        if (!this.options.exitOnTripleEnter) {
+          return false
+        }
+
+        const { state } = editor
+        const { selection } = state
+        const { $from, empty } = selection
+
+        if (!empty || $from.parent.type !== this.type) {
+          return false
+        }
+
+        const isAtEnd = $from.parentOffset === $from.parent.nodeSize - 2
+        const endsWithDoubleNewline = $from.parent.textContent.endsWith('\n\n')
+
+        if (!isAtEnd || !endsWithDoubleNewline) {
+          return false
+        }
+
+        return editor
+          .chain()
+          .command(({ tr }) => {
+            tr.delete($from.pos - 2, $from.pos)
+
+            return true
+          })
+          .exitCode()
+          .run()
+      },
+
+      // exit node on arrow down
+      ArrowDown: ({ editor }) => {
+        if (!this.options.exitOnArrowDown) {
+          return false
+        }
+
+        const { state } = editor
+        const { selection, doc } = state
+        const { $from, empty } = selection
+
+        if (!empty || $from.parent.type !== this.type) {
+          return false
+        }
+
+        const isAtEnd = $from.parentOffset === $from.parent.nodeSize - 2
+
+        if (!isAtEnd) {
+          return false
+        }
+
+        const after = $from.after()
+
+        if (after === undefined) {
+          return false
+        }
+
+        const nodeAfter = doc.nodeAt(after)
+
+        if (nodeAfter) {
+          return false
+        }
+
+        return editor.commands.exitCode()
+      },
     }
   },
 
   addInputRules() {
     return [
-      textblockTypeInputRule(backtickInputRegex, this.type, ({ groups }: any) => groups),
-      textblockTypeInputRule(tildeInputRegex, this.type, ({ groups }: any) => groups),
+      textblockTypeInputRule({
+        find: backtickInputRegex,
+        type: this.type,
+        getAttributes: match => ({
+          language: match[1],
+        }),
+      }),
+      textblockTypeInputRule({
+        find: tildeInputRegex,
+        type: this.type,
+        getAttributes: match => ({
+          language: match[1],
+        }),
+      }),
+    ]
+  },
+
+  addProseMirrorPlugins() {
+    return [
+      // this plugin creates a code block for pasted content from VS Code
+      // we can also detect the copied code language
+      new Plugin({
+        key: new PluginKey('codeBlockVSCodeHandler'),
+        props: {
+          handlePaste: (view, event) => {
+            if (!event.clipboardData) {
+              return false
+            }
+
+            // don’t create a new code block within code blocks
+            if (this.editor.isActive(this.type.name)) {
+              return false
+            }
+
+            const text = event.clipboardData.getData('text/plain')
+            const vscode = event.clipboardData.getData('vscode-editor-data')
+            const vscodeData = vscode ? JSON.parse(vscode) : undefined
+            const language = vscodeData?.mode
+
+            if (!text || !language) {
+              return false
+            }
+
+            const { tr } = view.state
+
+            // create an empty code block
+            tr.replaceSelectionWith(this.type.create({ language }))
+
+            // put cursor inside the newly created code block
+            tr.setSelection(TextSelection.near(tr.doc.resolve(Math.max(0, tr.selection.from - 2))))
+
+            // add text to code block
+            // strip carriage return chars from text pasted as code
+            // see: https://github.com/ProseMirror/prosemirror-view/commit/a50a6bcceb4ce52ac8fcc6162488d8875613aacd
+            tr.insertText(text.replace(/\r\n?/g, '\n'))
+
+            // store meta information
+            // this is useful for other plugins that depends on the paste event
+            // like the paste rule plugin
+            tr.setMeta('paste', true)
+
+            view.dispatch(tr)
+
+            return true
+          },
+        },
+      }),
     ]
   },
 })