@tiptap/extension-code-block-lowlight 2.0.0-beta.20 → 2.0.0-beta.200

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tiptap/extension-code-block-lowlight",
   "description": "code block extension for tiptap",
-  "version": "2.0.0-beta.20",
+  "version": "2.0.0-beta.200",
   "homepage": "https://tiptap.dev",
   "keywords": [
     "tiptap",
@@ -21,15 +21,17 @@
     "dist"
   ],
   "peerDependencies": {
-    "@tiptap/core": "^2.0.0-beta.1"
+    "@tiptap/core": "^2.0.0-beta.193",
+    "@tiptap/extension-code-block": "^2.0.0-beta.193"
   },
   "dependencies": {
-    "@tiptap/extension-code-block": "^2.0.0-beta.14",
-    "@types/lowlight": "^0.0.2",
-    "lowlight": "^1.20.0",
-    "prosemirror-model": "^1.14.1",
-    "prosemirror-state": "^1.3.4",
-    "prosemirror-view": "^1.18.4"
+    "prosemirror-model": "^1.18.1",
+    "prosemirror-state": "^1.4.1",
+    "prosemirror-view": "^1.28.2"
   },
-  "gitHead": "5188de73e1c803d4daa983ce6c572d3ec9112548"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ueberdosis/tiptap",
+    "directory": "packages/extension-code-block-lowlight"
+  }
 }

package/src/code-block-lowlight.ts

@@ -1,23 +1,28 @@
-import lowlight from 'lowlight/lib/core'
 import CodeBlock, { CodeBlockOptions } from '@tiptap/extension-code-block'
+
 import { LowlightPlugin } from './lowlight-plugin'
 
 export interface CodeBlockLowlightOptions extends CodeBlockOptions {
   lowlight: any,
+  defaultLanguage: string | null | undefined,
 }
 
 export const CodeBlockLowlight = CodeBlock.extend<CodeBlockLowlightOptions>({
-  defaultOptions: {
-    ...CodeBlock.options,
-    lowlight,
+  addOptions() {
+    return {
+      ...this.parent?.(),
+      lowlight: {},
+      defaultLanguage: null,
+    }
   },
 
   addProseMirrorPlugins() {
     return [
       ...this.parent?.() || [],
       LowlightPlugin({
-        name: 'codeBlock',
+        name: this.name,
         lowlight: this.options.lowlight,
+        defaultLanguage: this.options.defaultLanguage,
       }),
     ]
   },

package/src/lowlight-plugin.ts

@@ -1,7 +1,9 @@
+import { findChildren } from '@tiptap/core'
+// @ts-ignore
+import highlight from 'highlight.js/lib/core'
+import { Node as ProsemirrorNode } from 'prosemirror-model'
 import { Plugin, PluginKey } from 'prosemirror-state'
 import { Decoration, DecorationSet } from 'prosemirror-view'
-import { Node as ProsemirrorNode } from 'prosemirror-model'
-import { findChildren } from '@tiptap/core'
 
 function parseNodes(nodes: any[], className: string[] = []): { text: string, classes: string[] }[] {
   return nodes
@@ -25,17 +27,32 @@ function parseNodes(nodes: any[], className: string[] = []): { text: string, cla
     .flat()
 }
 
-function getDecorations({ doc, name, lowlight }: { doc: ProsemirrorNode, name: string, lowlight: any }) {
+function getHighlightNodes(result: any) {
+  // `.value` for lowlight v1, `.children` for lowlight v2
+  return result.value || result.children || []
+}
+
+function registered(aliasOrLanguage: string) {
+  return Boolean(highlight.getLanguage(aliasOrLanguage))
+}
+
+function getDecorations({
+  doc,
+  name,
+  lowlight,
+  defaultLanguage,
+}: { doc: ProsemirrorNode, name: string, lowlight: any, defaultLanguage: string | null | undefined }) {
   const decorations: Decoration[] = []
 
   findChildren(doc, node => node.type.name === name)
     .forEach(block => {
       let from = block.pos + 1
-      const { language } = block.node.attrs
+      const language = block.node.attrs.language || defaultLanguage
       const languages = lowlight.listLanguages()
-      const nodes = language && languages.includes(language)
-        ? lowlight.highlight(language, block.node.textContent).value
-        : lowlight.highlightAuto(block.node.textContent).value
+
+      const nodes = language && (languages.includes(language) || registered(language))
+        ? getHighlightNodes(lowlight.highlight(language, block.node.textContent))
+        : getHighlightNodes(lowlight.highlightAuto(block.node.textContent))
 
       parseNodes(nodes).forEach(node => {
         const to = from + node.text.length
@@ -55,12 +72,25 @@ function getDecorations({ doc, name, lowlight }: { doc: ProsemirrorNode, name: s
   return DecorationSet.create(doc, decorations)
 }
 
-export function LowlightPlugin({ name, lowlight }: { name: string, lowlight: any }) {
-  return new Plugin({
+function isFunction(param: Function) {
+  return typeof param === 'function'
+}
+
+export function LowlightPlugin({ name, lowlight, defaultLanguage }: { name: string, lowlight: any, defaultLanguage: string | null | undefined }) {
+  if (!['highlight', 'highlightAuto', 'listLanguages'].every(api => isFunction(lowlight[api]))) {
+    throw Error('You should provide an instance of lowlight to use the code-block-lowlight extension')
+  }
+
+  const lowlightPlugin: Plugin<any> = new Plugin({
     key: new PluginKey('lowlight'),
 
     state: {
-      init: (_, { doc }) => getDecorations({ doc, name, lowlight }),
+      init: (_, { doc }) => getDecorations({
+        doc,
+        name,
+        lowlight,
+        defaultLanguage,
+      }),
       apply: (transaction, decorationSet, oldState, newState) => {
         const oldNodeName = oldState.selection.$head.parent.type.name
         const newNodeName = newState.selection.$head.parent.type.name
@@ -92,7 +122,12 @@ export function LowlightPlugin({ name, lowlight }: { name: string, lowlight: any
             })
           )
         ) {
-          return getDecorations({ doc: transaction.doc, name, lowlight })
+          return getDecorations({
+            doc: transaction.doc,
+            name,
+            lowlight,
+            defaultLanguage,
+          })
         }
 
         return decorationSet.map(transaction.mapping, transaction.doc)
@@ -101,8 +136,10 @@ export function LowlightPlugin({ name, lowlight }: { name: string, lowlight: any
 
     props: {
       decorations(state) {
-        return this.getState(state)
+        return lowlightPlugin.getState(state)
       },
     },
   })
+
+  return lowlightPlugin
 }

package/CHANGELOG.md

@@ -1,167 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-# [2.0.0-beta.20](https://github.com/ueberdosis/tiptap/compare/@tiptap/extension-code-block-lowlight@2.0.0-beta.19...@tiptap/extension-code-block-lowlight@2.0.0-beta.20) (2021-05-13)
-
-**Note:** Version bump only for package @tiptap/extension-code-block-lowlight
-
-
-
-
-
-# [2.0.0-beta.19](https://github.com/ueberdosis/tiptap/compare/@tiptap/extension-code-block-lowlight@2.0.0-beta.18...@tiptap/extension-code-block-lowlight@2.0.0-beta.19) (2021-05-13)
-
-**Note:** Version bump only for package @tiptap/extension-code-block-lowlight
-
-
-
-
-
-# [2.0.0-beta.18](https://github.com/ueberdosis/tiptap/compare/@tiptap/extension-code-block-lowlight@2.0.0-beta.17...@tiptap/extension-code-block-lowlight@2.0.0-beta.18) (2021-05-07)
-
-
-### Bug Fixes
-
-* revert adding exports ([bc320d0](https://github.com/ueberdosis/tiptap/commit/bc320d0b4b80b0e37a7e47a56e0f6daec6e65d98))
-
-
-
-
-
-# [2.0.0-beta.17](https://github.com/ueberdosis/tiptap/compare/@tiptap/extension-code-block-lowlight@2.0.0-beta.16...@tiptap/extension-code-block-lowlight@2.0.0-beta.17) (2021-05-06)
-
-
-### Bug Fixes
-
-* revert adding type: module ([f8d6475](https://github.com/ueberdosis/tiptap/commit/f8d6475e2151faea6f96baecdd6bd75880d50d2c))
-
-
-
-
-
-# [2.0.0-beta.16](https://github.com/ueberdosis/tiptap/compare/@tiptap/extension-code-block-lowlight@2.0.0-beta.15...@tiptap/extension-code-block-lowlight@2.0.0-beta.16) (2021-05-06)
-
-
-### Bug Fixes
-
-* add exports to package.json ([1277fa4](https://github.com/ueberdosis/tiptap/commit/1277fa47151e9c039508cdb219bdd0ffe647f4ee))
-
-
-
-
-
-# [2.0.0-beta.15](https://github.com/ueberdosis/tiptap/compare/@tiptap/extension-code-block-lowlight@2.0.0-beta.14...@tiptap/extension-code-block-lowlight@2.0.0-beta.15) (2021-05-06)
-
-**Note:** Version bump only for package @tiptap/extension-code-block-lowlight
-
-
-
-
-
-# [2.0.0-beta.14](https://github.com/ueberdosis/tiptap/compare/@tiptap/extension-code-block-lowlight@2.0.0-beta.13...@tiptap/extension-code-block-lowlight@2.0.0-beta.14) (2021-05-05)
-
-**Note:** Version bump only for package @tiptap/extension-code-block-lowlight
-
-
-
-
-
-# [2.0.0-beta.13](https://github.com/ueberdosis/tiptap/compare/@tiptap/extension-code-block-lowlight@2.0.0-beta.12...@tiptap/extension-code-block-lowlight@2.0.0-beta.13) (2021-05-04)
-
-**Note:** Version bump only for package @tiptap/extension-code-block-lowlight
-
-
-
-
-
-# [2.0.0-beta.12](https://github.com/ueberdosis/tiptap/compare/@tiptap/extension-code-block-lowlight@2.0.0-beta.11...@tiptap/extension-code-block-lowlight@2.0.0-beta.12) (2021-04-27)
-
-**Note:** Version bump only for package @tiptap/extension-code-block-lowlight
-
-
-
-
-
-# [2.0.0-beta.11](https://github.com/ueberdosis/tiptap/compare/@tiptap/extension-code-block-lowlight@2.0.0-beta.10...@tiptap/extension-code-block-lowlight@2.0.0-beta.11) (2021-04-23)
-
-**Note:** Version bump only for package @tiptap/extension-code-block-lowlight
-
-
-
-
-
-# [2.0.0-beta.10](https://github.com/ueberdosis/tiptap/compare/@tiptap/extension-code-block-lowlight@2.0.0-beta.9...@tiptap/extension-code-block-lowlight@2.0.0-beta.10) (2021-04-22)
-
-**Note:** Version bump only for package @tiptap/extension-code-block-lowlight
-
-
-
-
-
-# [2.0.0-beta.9](https://github.com/ueberdosis/tiptap/compare/@tiptap/extension-code-block-lowlight@2.0.0-beta.8...@tiptap/extension-code-block-lowlight@2.0.0-beta.9) (2021-04-21)
-
-**Note:** Version bump only for package @tiptap/extension-code-block-lowlight
-
-
-
-
-
-# [2.0.0-beta.8](https://github.com/ueberdosis/tiptap/compare/@tiptap/extension-code-block-lowlight@2.0.0-beta.7...@tiptap/extension-code-block-lowlight@2.0.0-beta.8) (2021-04-16)
-
-**Note:** Version bump only for package @tiptap/extension-code-block-lowlight
-
-
-
-
-
-# [2.0.0-beta.7](https://github.com/ueberdosis/tiptap/compare/@tiptap/extension-code-block-lowlight@2.0.0-beta.6...@tiptap/extension-code-block-lowlight@2.0.0-beta.7) (2021-04-15)
-
-**Note:** Version bump only for package @tiptap/extension-code-block-lowlight
-
-
-
-
-
-# [2.0.0-beta.6](https://github.com/ueberdosis/tiptap/compare/@tiptap/extension-code-block-lowlight@2.0.0-beta.4...@tiptap/extension-code-block-lowlight@2.0.0-beta.6) (2021-04-14)
-
-**Note:** Version bump only for package @tiptap/extension-code-block-lowlight
-
-
-
-
-
-# [2.0.0-beta.4](https://github.com/ueberdosis/tiptap/compare/@tiptap/extension-code-block-lowlight@2.0.0-beta.3...@tiptap/extension-code-block-lowlight@2.0.0-beta.4) (2021-04-14)
-
-
-### Bug Fixes
-
-* fix lowlight decorations for vue 3 ([daa5dc0](https://github.com/ueberdosis/tiptap/commit/daa5dc0fb1ec2db6889565fc9c091f3dbdbbda6d))
-
-
-
-
-
-# [2.0.0-beta.3](https://github.com/ueberdosis/tiptap/compare/@tiptap/extension-code-block-lowlight@2.0.0-beta.2...@tiptap/extension-code-block-lowlight@2.0.0-beta.3) (2021-04-12)
-
-
-### Features
-
-* add parentConfig to extension context for more extendable extensions, fix [#259](https://github.com/ueberdosis/tiptap/issues/259) ([5e1ec5d](https://github.com/ueberdosis/tiptap/commit/5e1ec5d2a66be164f505d631f97861ab9344ba96))
-
-
-
-
-
-# [2.0.0-beta.2](https://github.com/ueberdosis/tiptap/compare/@tiptap/extension-code-block-lowlight@2.0.0-beta.1...@tiptap/extension-code-block-lowlight@2.0.0-beta.2) (2021-04-11)
-
-**Note:** Version bump only for package @tiptap/extension-code-block-lowlight
-
-
-
-
-
-# 2.0.0-beta.1 (2021-04-08)
-
-**Note:** Version bump only for package @tiptap/extension-code-block-lowlight

package/LICENSE.md

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2021, überdosis GbR
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.