@scalar/use-codemirror 0.1.4 → 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Scalar
+
+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.

package/package.json

@@ -1,16 +1,22 @@
 {
   "name": "@scalar/use-codemirror",
-  "version": "0.1.4",
+  "version": "0.3.0",
   "author": "Scalar",
-  "license": "UNLICENSED",
+  "license": "MIT",
   "engines": {
     "node": ">=18"
   },
   "type": "module",
   "main": "dist/index.js",
+  "module": "dist/index.js",
   "files": [
+    "src",
     "dist"
   ],
+  "exports": {
+    "development": "./src/index.ts",
+    "import": "./dist/index.js"
+  },
   "dependencies": {
     "@codemirror/lang-javascript": "6.1.9",
     "@codemirror/lang-json": "6.0.1",

package/src/index.ts

@@ -0,0 +1 @@
+export * from './useCodeMirror'

package/src/useCodeMirror.test.ts

@@ -0,0 +1,7 @@
+import { describe, expect, it } from 'vitest'
+
+describe('example', () => {
+  it('executes tests', () => {
+    expect(true).toBe(true)
+  })
+})

package/src/useCodeMirror.ts

@@ -0,0 +1,162 @@
+import { type Extension, StateEffect } from '@codemirror/state'
+import { type EditorViewConfig } from '@codemirror/view'
+import { duotoneDark, duotoneLight } from '@uiw/codemirror-theme-duotone'
+import { EditorView } from 'codemirror'
+import { type Ref, ref, watch } from 'vue'
+
+/** TODO: This is a static value, make it work with a dynamic parameter. */
+const isDark = ref(false)
+
+type UseCodeMirrorParameters = {
+  /**
+   * Some additional CodeMirror extensions.
+   */
+  extensions: Extension[]
+  /**
+   * Prefill the content. Will be ignored when a provider is given.
+   */
+  content?: string
+  /**
+   * Inverse the dark mode.
+   */
+  forceDarkMode?: boolean
+  /**
+   * Whether to load a theme.
+   */
+  withoutTheme?: boolean
+}
+
+export const useCodeMirror = (
+  parameters: UseCodeMirrorParameters,
+): {
+  value: Ref<string>
+  codeMirrorRef: Ref<HTMLDivElement | null>
+  codeMirror: Ref<EditorView | null>
+  setCodeMirrorContent: (content: string) => void
+  reconfigureCodeMirror: (newExtensions: Extension[]) => void
+  restartCodeMirror: (newExtensions: Extension[]) => void
+} => {
+  const { extensions, content, forceDarkMode, withoutTheme } = parameters
+  const value = ref(content ?? '')
+  const codeMirrorRef = ref<HTMLDivElement | null>(null)
+  const codeMirror = ref<EditorView | null>(null)
+
+  // Unmounts CodeMirror if it’s mounted already, and mounts CodeMirror, if the given ref exists.
+  watch(codeMirrorRef, () => {
+    destroyCodeMirror()
+    mountCodeMirror(extensions)
+  })
+
+  // Initializes CodeMirror.
+  const mountCodeMirror = (withCustomExtensions: Extension[]) => {
+    if (codeMirrorRef.value) {
+      const configuration: EditorViewConfig = {
+        parent: codeMirrorRef.value,
+        extensions: addDefaultExtensions(withCustomExtensions),
+      }
+
+      // Only set the content, when not in collaborative editing mode
+      if (content) {
+        configuration.doc = content
+      }
+
+      codeMirror.value = new EditorView(configuration)
+    }
+  }
+
+  // Extend the given extension list with a dark/light theme.
+  const addDefaultExtensions = (newExtensions: Extension[] = []) => {
+    const theme = withoutTheme
+      ? null
+      : forceDarkMode
+      ? duotoneLight
+      : isDark.value
+      ? duotoneDark
+      : duotoneLight
+    // Themes
+    const defaultExtensions: Extension[] = [
+      EditorView.theme({}, { dark: forceDarkMode ? false : isDark.value }),
+      theme,
+    ].filter((extension) => extension !== null) as Extension[]
+
+    return [...defaultExtensions, newExtensions]
+  }
+
+  watch(isDark, () => {
+    const { extensions: configuredExtensions } = parameters
+
+    if (!forceDarkMode) {
+      reconfigureCodeMirror(configuredExtensions)
+    }
+  })
+
+  // Removes CodeMirror.
+  const destroyCodeMirror = () => {
+    codeMirror.value?.destroy()
+  }
+
+  const setCodeMirrorContent = (newValue: string) => {
+    if (!codeMirror.value) {
+      return
+    }
+
+    value.value = newValue
+
+    codeMirror.value.dispatch({
+      changes: {
+        from: 0,
+        to: codeMirror.value.state.doc.length,
+        insert: newValue,
+      },
+      selection: {
+        anchor: Math.min(
+          codeMirror.value.state.selection.main.anchor,
+          newValue.length,
+        ),
+      },
+    })
+  }
+
+  const reconfigureCodeMirror = (newExtensions: Extension[]) => {
+    if (!codeMirror.value) {
+      return
+    }
+
+    codeMirror.value.dispatch({
+      effects: StateEffect.reconfigure.of(addDefaultExtensions(newExtensions)),
+    })
+  }
+
+  const restartCodeMirror = (newExtensions: Extension[]) => {
+    destroyCodeMirror()
+    mountCodeMirror(newExtensions)
+  }
+
+  return {
+    /**
+     * The current value
+     */
+    value,
+    /**
+     * An empty reference used to mount CodeMirror when bound to the DOM.
+     */
+    codeMirrorRef,
+    /**
+     * The CodeMirror instance.
+     */
+    // @ts-ignore
+    codeMirror,
+    /**
+     * Replaces the current content with the given value.
+     */
+    setCodeMirrorContent,
+    /**
+     * Reconfigure the used extensions.
+     */
+    reconfigureCodeMirror,
+    /**
+     * Restarts CodeMirror (destroy + mount)
+     */
+    restartCodeMirror,
+  }
+}