jsx-repl 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021-present, Yuxi (Evan) You
+
+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/README.md

@@ -0,0 +1,105 @@
+# jsx-repl
+
+JSX REPL, support Vite plugins and Volar plugins.
+
+## Basic Usage
+
+**Note: `jsx-repl` supports Monaco Editor, but also requires explicitly passing in the editor to be used for tree-shaking.**
+
+```ts
+// vite.config.ts
+import { defineConfig } from 'vite'
+export default defineConfig({
+  optimizeDeps: {
+    exclude: ['jsx-repl'],
+  },
+  // ...
+})
+```
+
+### With CodeMirror Editor
+
+Basic editing experience with no intellisense. Lighter weight, fewer network requests, better for embedding use cases.
+
+```vue
+<script setup>
+import { Repl } from 'jsx-repl'
+import CodeMirror from 'jsx-repl/codemirror-editor'
+</script>
+
+<template>
+  <Repl :editor="CodeMirror" />
+</template>
+```
+
+### With Monaco Editor
+
+With Volar support, autocomplete, type inference, and semantic highlighting. Heavier bundle, loads dts files from CDN, better for standalone use cases.
+
+```vue
+<script setup>
+import { Repl } from 'jsx-repl'
+import Monaco from 'jsx-repl/monaco-editor'
+</script>
+
+<template>
+  <Repl :editor="Monaco" />
+</template>
+```
+
+## Advanced Usage
+
+Customize the behavior of the REPL by manually initializing the store.
+
+See [v4 Migration Guide](https://github.com/vuejs/repl/releases/tag/v4.0.0)
+
+```vue
+<script setup>
+import { watchEffect, ref } from 'vue'
+import { Repl, useStore, useVueImportMap } from 'jsx-repl'
+import Monaco from 'jsx-repl/monaco-editor'
+
+// retrieve some configuration options from the URL
+const query = new URLSearchParams(location.search)
+
+const {
+  importMap: builtinImportMap,
+  vueVersion,
+  productionMode,
+} = useVueImportMap({
+  // specify the default URL to import Vue runtime from in the sandbox
+  // default is the CDN link from jsdelivr.com with version matching Vue's version
+  // from peerDependency
+  runtimeDev: 'cdn link to vue.runtime.esm-browser.js',
+  runtimeProd: 'cdn link to vue.runtime.esm-browser.prod.js',
+  serverRenderer: 'cdn link to server-renderer.esm-browser.js',
+})
+
+const store = useStore(
+  {
+    // pre-set import map
+    builtinImportMap,
+    vueVersion,
+    // starts on the output pane (mobile only) if the URL has a showOutput query
+    showOutput: ref(query.has('showOutput')),
+    // starts on a different tab on the output pane if the URL has a outputMode query
+    // and default to the "preview" tab
+    outputMode: ref(query.get('outputMode') || 'preview'),
+  },
+  // initialize repl with previously serialized state
+  location.hash,
+)
+
+// persist state to URL hash
+watchEffect(() => history.replaceState({}, '', store.serialize()))
+
+// use a specific version of Vue
+vueVersion.value = '3.2.8'
+// production mode is enabled
+productionMode.value = true
+</script>
+
+<template>
+  <Repl :store="store" :editor="Monaco" :showCompileOutput="true" />
+</template>
+```