@scalar/use-codemirror 0.11.4 → 0.11.6

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @scalar/use-codemirror
 
+## 0.11.6
+
+### Patch Changes
+
+- 9e3348a: feat: set placeholder usage
+
+## 0.11.5
+
+### Patch Changes
+
+- 6b32eee: feat: add json linter
+
 ## 0.11.4
 
 ### Patch Changes

package/dist/hooks/useCodeMirror.d.ts

@@ -15,12 +15,18 @@ type BaseParameters = {
     classes?: MaybeRefOrGetter<string[] | undefined>;
     /** Put the editor into read-only mode */
     readOnly?: MaybeRefOrGetter<boolean | undefined>;
+    /** Disable indent with tab */
+    disableTabIndent?: MaybeRefOrGetter<boolean | undefined>;
     /** Option to show line numbers in the editor */
     lineNumbers?: MaybeRefOrGetter<boolean | undefined>;
     withVariables?: MaybeRefOrGetter<boolean | undefined>;
     disableEnter?: MaybeRefOrGetter<boolean | undefined>;
+    disableCloseBrackets?: MaybeRefOrGetter<boolean | undefined>;
+    /** Option to lint and show error in the editor */
+    lint?: MaybeRefOrGetter<boolean | undefined>;
     onBlur?: (v: string) => void;
     onFocus?: (v: string) => void;
+    placeholder?: MaybeRefOrGetter<string | undefined>;
 };
 export type UseCodeMirrorParameters = (BaseParameters & {
     /** Prefill the content. Will be ignored when a provider is given. */

package/dist/hooks/useCodeMirror.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useCodeMirror.d.ts","sourceRoot":"","sources":["../../src/hooks/useCodeMirror.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,KAAK,SAAS,EAAe,MAAM,mBAAmB,CAAA;AAC/D,OAAO,EACL,UAAU,EAKX,MAAM,kBAAkB,CAAA;AACzB,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,GAAG,EAMT,MAAM,KAAK,CAAA;AAGZ,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAGlD,KAAK,cAAc,GAAG;IACpB,yCAAyC;IACzC,aAAa,EAAE,GAAG,CAAC,cAAc,GAAG,IAAI,CAAC,CAAA;IACzC,mDAAmD;IACnD,UAAU,CAAC,EAAE,gBAAgB,CAAC,SAAS,EAAE,CAAC,CAAA;IAC1C,8BAA8B;IAC9B,YAAY,CAAC,EAAE,gBAAgB,CAAC,OAAO,GAAG,SAAS,CAAC,CAAA;IACpD,mDAAmD;IACnD,QAAQ,EAAE,gBAAgB,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAAA;IAC1D,2CAA2C;IAC3C,OAAO,CAAC,EAAE,gBAAgB,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC,CAAA;IAChD,yCAAyC;IACzC,QAAQ,CAAC,EAAE,gBAAgB,CAAC,OAAO,GAAG,SAAS,CAAC,CAAA;IAChD,gDAAgD;IAChD,WAAW,CAAC,EAAE,gBAAgB,CAAC,OAAO,GAAG,SAAS,CAAC,CAAA;IACnD,aAAa,CAAC,EAAE,gBAAgB,CAAC,OAAO,GAAG,SAAS,CAAC,CAAA;IACrD,YAAY,CAAC,EAAE,gBAAgB,CAAC,OAAO,GAAG,SAAS,CAAC,CAAA;IACpD,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;IAC5B,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,uBAAuB,GAC/B,CAAC,cAAc,GAAG;IAChB,qEAAqE;IACrE,OAAO,EAAE,gBAAgB,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;IAC7C,QAAQ,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;CAC9B,CAAC,GACF,CAAC,cAAc,GAAG;IAChB,QAAQ,EAAE,gBAAgB,CAAC,SAAS,GAAG,IAAI,CAAC,CAAA;IAC5C,OAAO,CAAC,EAAE,gBAAgB,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;IAC9C,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;CAC/B,CAAC,CAAA;AAsBN,sCAAsC;AACtC,eAAO,MAAM,aAAa,WAChB,uBAAuB,KAC9B;IACD,oBAAoB,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;IAChD,UAAU,EAAE,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,CAAA;CA+HnC,CAAA"}
+{"version":3,"file":"useCodeMirror.d.ts","sourceRoot":"","sources":["../../src/hooks/useCodeMirror.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,KAAK,SAAS,EAAe,MAAM,mBAAmB,CAAA;AAC/D,OAAO,EACL,UAAU,EAMX,MAAM,kBAAkB,CAAA;AACzB,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,GAAG,EAMT,MAAM,KAAK,CAAA;AAGZ,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAGlD,KAAK,cAAc,GAAG;IACpB,yCAAyC;IACzC,aAAa,EAAE,GAAG,CAAC,cAAc,GAAG,IAAI,CAAC,CAAA;IACzC,mDAAmD;IACnD,UAAU,CAAC,EAAE,gBAAgB,CAAC,SAAS,EAAE,CAAC,CAAA;IAC1C,8BAA8B;IAC9B,YAAY,CAAC,EAAE,gBAAgB,CAAC,OAAO,GAAG,SAAS,CAAC,CAAA;IACpD,mDAAmD;IACnD,QAAQ,EAAE,gBAAgB,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAAA;IAC1D,2CAA2C;IAC3C,OAAO,CAAC,EAAE,gBAAgB,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC,CAAA;IAChD,yCAAyC;IACzC,QAAQ,CAAC,EAAE,gBAAgB,CAAC,OAAO,GAAG,SAAS,CAAC,CAAA;IAChD,8BAA8B;IAC9B,gBAAgB,CAAC,EAAE,gBAAgB,CAAC,OAAO,GAAG,SAAS,CAAC,CAAA;IACxD,gDAAgD;IAChD,WAAW,CAAC,EAAE,gBAAgB,CAAC,OAAO,GAAG,SAAS,CAAC,CAAA;IACnD,aAAa,CAAC,EAAE,gBAAgB,CAAC,OAAO,GAAG,SAAS,CAAC,CAAA;IACrD,YAAY,CAAC,EAAE,gBAAgB,CAAC,OAAO,GAAG,SAAS,CAAC,CAAA;IACpD,oBAAoB,CAAC,EAAE,gBAAgB,CAAC,OAAO,GAAG,SAAS,CAAC,CAAA;IAC5D,kDAAkD;IAClD,IAAI,CAAC,EAAE,gBAAgB,CAAC,OAAO,GAAG,SAAS,CAAC,CAAA;IAC5C,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;IAC5B,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;IAC7B,WAAW,CAAC,EAAE,gBAAgB,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;CACnD,CAAA;AAED,MAAM,MAAM,uBAAuB,GAC/B,CAAC,cAAc,GAAG;IAChB,qEAAqE;IACrE,OAAO,EAAE,gBAAgB,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;IAC7C,QAAQ,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;CAC9B,CAAC,GACF,CAAC,cAAc,GAAG;IAChB,QAAQ,EAAE,gBAAgB,CAAC,SAAS,GAAG,IAAI,CAAC,CAAA;IAC5C,OAAO,CAAC,EAAE,gBAAgB,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;IAC9C,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;CAC/B,CAAC,CAAA;AAsBN,sCAAsC;AACtC,eAAO,MAAM,aAAa,WAChB,uBAAuB,KAC9B;IACD,oBAAoB,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;IAChD,UAAU,EAAE,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,CAAA;CAmInC,CAAA"}

package/dist/hooks/useCodeMirror.js

@@ -1,167 +1,209 @@
-import { autocompletion as M, closeBrackets as k, completionKeymap as C, closeBracketsKeymap as S } from "@codemirror/autocomplete";
-import { indentWithTab as w } from "@codemirror/commands";
-import { css as H } from "@codemirror/lang-css";
-import { html as N } from "@codemirror/lang-html";
-import { json as T } from "@codemirror/lang-json";
+import { autocompletion as j, completionKeymap as w, closeBrackets as B, closeBracketsKeymap as I } from "@codemirror/autocomplete";
+import { indentWithTab as O } from "@codemirror/commands";
+import { css as K } from "@codemirror/lang-css";
+import { html as L } from "@codemirror/lang-html";
+import { json as R } from "@codemirror/lang-json";
 import { yaml as V } from "@codemirror/lang-yaml";
-import { syntaxHighlighting as K, defaultHighlightStyle as O, indentOnInput as R, bracketMatching as j } from "@codemirror/language";
-import { StateEffect as A } from "@codemirror/state";
-import { EditorView as c, highlightSpecialChars as B, keymap as a, lineNumbers as I } from "@codemirror/view";
-import { ref as L, watch as h, onBeforeUnmount as P, toValue as i, computed as U } from "vue";
-import { customTheme as W } from "../themes/index.js";
-import { variables as q } from "./variables.js";
-const u = (e) => "provider" in e && !!i(e.provider), z = {
+import { syntaxHighlighting as A, defaultHighlightStyle as z, indentOnInput as J, bracketMatching as v } from "@codemirror/language";
+import { linter as P } from "@codemirror/lint";
+import { StateEffect as U } from "@codemirror/state";
+import { EditorView as d, highlightSpecialChars as W, keymap as a, placeholder as q, lineNumbers as D } from "@codemirror/view";
+import { ref as G, watch as m, onBeforeUnmount as Q, toValue as t, computed as X } from "vue";
+import { customTheme as Y } from "../themes/index.js";
+import { variables as Z } from "./variables.js";
+const u = (e) => "provider" in e && !!t(e.provider), _ = {
   key: "Mod-a",
   run: (e) => (e.dispatch({
     selection: { anchor: 0, head: e.state.doc.length },
     scrollIntoView: !1
   }), !0)
-}, oe = (e) => {
-  const o = L(null);
-  h(
+}, de = (e) => {
+  const i = G(null);
+  m(
     e.codeMirrorRef,
     () => {
-      var t;
-      (t = o.value) == null || t.destroy(), l();
+      var o;
+      (o = i.value) == null || o.destroy(), l();
     },
     { immediate: !0 }
-  ), P(() => {
-    var t;
-    return (t = o.value) == null ? void 0 : t.destroy();
+  ), Q(() => {
+    var o;
+    return (o = i.value) == null ? void 0 : o.destroy();
   });
   function l() {
     if (e.codeMirrorRef.value) {
-      const t = u(e) ? i(e.provider) : null, f = v({
+      const o = u(e) ? t(e.provider) : null, h = x({
         ...s.value,
-        provider: t
+        provider: o
       });
-      o.value = new c({
+      i.value = new d({
         parent: e.codeMirrorRef.value,
-        extensions: f
-      }), u(e) || r(i(e.content));
+        extensions: h
+      }), u(e) || n(t(e.content));
     }
   }
-  const s = U(() => ({
+  const s = X(() => ({
     onChange: e.onChange,
     onBlur: e.onBlur,
     onFocus: e.onFocus,
-    language: i(e.language),
-    classes: i(e.classes),
-    readOnly: i(e.readOnly),
-    lineNumbers: i(e.lineNumbers),
-    withVariables: i(e.withVariables),
-    disableEnter: i(e.withVariables),
-    withoutTheme: i(e.withoutTheme),
-    additionalExtensions: i(e.extensions)
+    disableTabIndent: t(e.disableTabIndent),
+    language: t(e.language),
+    classes: t(e.classes),
+    readOnly: t(e.readOnly),
+    lineNumbers: t(e.lineNumbers),
+    withVariables: t(e.withVariables),
+    disableEnter: t(e.disableEnter),
+    disableCloseBrackets: t(e.disableCloseBrackets),
+    withoutTheme: t(e.withoutTheme),
+    lint: t(e.lint),
+    additionalExtensions: t(e.extensions),
+    placeholder: t(e.placeholder)
   }));
-  h(
-    () => u(e) ? i(e.provider) : null,
+  m(
+    () => u(e) ? t(e.provider) : null,
     () => {
-      var t;
-      u(e) && ((t = o.value) == null || t.destroy(), l());
+      var o;
+      u(e) && ((o = i.value) == null || o.destroy(), l());
     }
-  ), h(
+  ), m(
     s,
     () => {
-      if (o.value) {
-        const t = u(e) ? i(e.provider) : null, f = v({
+      if (i.value) {
+        const o = u(e) ? t(e.provider) : null, h = x({
           ...s.value,
-          provider: t
+          provider: o
         });
-        o.value.dispatch({
-          effects: A.reconfigure.of(f)
+        i.value.dispatch({
+          effects: U.reconfigure.of(h)
         });
       } else
         return;
     },
     { immediate: !0 }
   );
-  const r = (t = "") => {
-    o.value && o.value.state.doc.toString() !== t && o.value.dispatch({
+  const n = (o = "") => {
+    i.value && i.value.state.doc.toString() !== o && i.value.dispatch({
       changes: {
         from: 0,
-        to: o.value.state.doc.length,
-        insert: t
+        to: i.value.state.doc.length,
+        insert: o
       },
       selection: {
         anchor: Math.min(
-          o.value.state.selection.main.anchor,
-          t.length
+          i.value.state.selection.main.anchor,
+          o.length
         )
       }
     });
   };
-  return h(
-    () => i(e.content),
+  return m(
+    () => t(e.content),
     () => {
-      u(e) || r(i(e.content));
+      u(e) || n(t(e.content));
     },
     { immediate: !0 }
   ), {
     /** Replaces the current content with the given value. */
-    setCodeMirrorContent: r,
+    setCodeMirrorContent: n,
     /** Codemirror instance */
-    codeMirror: o
+    codeMirror: i
   };
-}, g = {
-  html: N,
-  json: T,
+}, y = {
+  html: L,
+  json: R,
   yaml: V,
-  css: H
+  css: K
 };
-function v({
+function x({
   onChange: e,
-  onBlur: o,
+  onBlur: i,
   onFocus: l,
   provider: s,
-  language: r,
-  classes: t = [],
-  readOnly: f = !1,
-  lineNumbers: p = !1,
-  withVariables: y = !1,
-  disableEnter: b = !1,
-  withoutTheme: x = !1,
-  additionalExtensions: E = []
+  language: n,
+  classes: o = [],
+  readOnly: h = !1,
+  lineNumbers: E = !1,
+  withVariables: k = !1,
+  disableEnter: C = !1,
+  disableCloseBrackets: M = !1,
+  disableTabIndent: S = !1,
+  withoutTheme: T = !1,
+  lint: H = !1,
+  additionalExtensions: N = [],
+  placeholder: g
 }) {
-  const n = [
-    B(),
-    K(O, { fallback: !0 }),
-    c.theme({
+  const r = [
+    W(),
+    A(z, { fallback: !0 }),
+    d.theme({
       ".cm-line": {
         lineHeight: "20px"
       },
       ".cm-gutterElement": {
         lineHeight: "20px"
+      },
+      ".cm-tooltip": {
+        border: "1px solid #f5c6cb",
+        fontSize: "12px"
+      },
+      ".cm-tooltip-lint": {
+        backgroundColor: "#ffffff"
+      },
+      ".cm-diagnostic-error": {
+        borderLeft: "0",
+        color: "#dc1b19"
       }
     }),
     // Listen to updates
-    c.updateListener.of((d) => {
-      d.docChanged && (e == null || e(d.state.doc.toString()));
+    d.updateListener.of((c) => {
+      c.docChanged && (e == null || e(c.state.doc.toString()));
     }),
-    c.domEventHandlers({
-      blur: (d, m) => {
-        o == null || o(m.state.doc.toString());
+    d.domEventHandlers({
+      blur: (c, f) => {
+        i == null || i(f.state.doc.toString());
       },
-      focus: (d, m) => {
-        l == null || l(m.state.doc.toString());
+      focus: (c, f) => {
+        l == null || l(f.state.doc.toString());
       }
     }),
     // Add Classes
-    c.editorAttributes.of({ class: t.join(" ") }),
-    ...E
+    d.editorAttributes.of({ class: o.join(" ") }),
+    ...N
   ];
-  return s && n.push(s), x || n.push(W), f ? n.push(c.editable.of(!1)) : n.push(
-    R(),
+  if (s && r.push(s), T || r.push(Y), h ? r.push(d.editable.of(!1)) : (r.push(
+    J(),
+    v(),
     j(),
-    M(),
-    k(),
+    a.of([...w, _]),
+    v()
+  ), M || r.push(B(), a.of([...I])), S ? r.push(
     a.of([
-      ...C,
-      ...S,
-      w,
-      z
+      {
+        key: "Tab",
+        run: () => !1,
+        // Prevent default Tab behavior
+        shift: () => !1
+        // Prevent default Shift+Tab behavior
+      }
     ])
-  ), r && g[r] && n.push(g[r]()), p && n.push(I()), y && n.push(q()), b && n.push(
+  ) : r.push(a.of([O]))), g && r.push(q(g)), n && y[n] && r.push(y[n]()), H && n === "json") {
+    const c = P((f) => {
+      const b = [];
+      try {
+        JSON.parse(f.state.doc.toString());
+      } catch (p) {
+        p instanceof Error && b.push({
+          from: 0,
+          to: f.state.doc.length,
+          severity: "error",
+          message: p.message
+        });
+      }
+      return b;
+    });
+    r.push(c);
+  }
+  return E && r.push(D()), k && r.push(Z()), C && r.push(
     a.of([
       {
         key: "Enter",
@@ -177,8 +219,8 @@ function v({
         run: () => !0
       }
     ])
-  ), n;
+  ), r;
 }
 export {
-  oe as useCodeMirror
+  de as useCodeMirror
 };

package/package.json

@@ -16,7 +16,7 @@
     "vue",
     "vue3"
   ],
-  "version": "0.11.4",
+  "version": "0.11.6",
   "engines": {
     "node": ">=18"
   },
@@ -31,8 +31,8 @@
   ],
   "module": "dist/index.js",
   "optionalDependencies": {
-    "yjs": "^13.6.0",
-    "y-codemirror.next": "^0.3.2"
+    "y-codemirror.next": "^0.3.2",
+    "yjs": "^13.6.0"
   },
   "dependencies": {
     "@codemirror/autocomplete": "^6.12.0",
@@ -42,6 +42,7 @@
     "@codemirror/lang-json": "^6.0.0",
     "@codemirror/lang-yaml": "^6.0.0",
     "@codemirror/language": "^6.10.1",
+    "@codemirror/lint": "^6.8.1",
     "@codemirror/state": "^6.4.0",
     "@codemirror/view": "^6.23.1",
     "@lezer/common": "^1.2.1",
@@ -62,7 +63,7 @@
     "vue-tsc": "^2.0.13",
     "y-codemirror.next": "^0.3.2",
     "yjs": "^13.6.0",
-    "@scalar/build-tooling": "0.1.7"
+    "@scalar/build-tooling": "0.1.9"
   },
   "scripts": {
     "build": "vite build && pnpm types:build && tsc-alias -p tsconfig.build.json",