muggle-string 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-present Johnson Chu
+
+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,70 @@
+This library aims to provide codegen helpers and data structure for Vue language plugin API v1.x that does not depend on Volar runtime.
+
+## Why "Muggle"?
+
+A better situation is Volar can use magic-string on the Vue plugin API, but currently can't do this easily.
+
+This solution is just for Vue language plugin API v1.x and planned to be deprecate in v2.
+
+## Usage
+
+The example is base-on [magic-string readme](https://github.com/rich-harris/magic-string#usage).
+
+```html
+<script>problems = 99</script>
+
+<more-script lang="js">console.log( answer )</more-script>
+```
+
+```ts
+import {
+  toString,
+  overwrite, // not yet support
+} from 'muggle-string';
+
+/** @type {import('@volar/vue-language-core').VueLanguagePlugin} */
+const plugin = () => {
+	return {
+		resolveEmbeddedFile(fileName, sfc, embeddedFile) {
+			if (embeddedFile.fileName.replace(fileName, '').match(/^\.(js|ts|jsx|tsx)$/)) {
+
+        const s = embeddedFile.content;
+        toString(s); // 'problems = 99'
+
+        overwrite(s, 0, 8, 'answer'); // not yet support
+        toString(s); // 'answer = 99'
+
+        overwrite(s, 11, 13, '42'); // not yet support
+        toString(s); // 'answer = 42'
+
+        // add string by Array method directly
+        s.unshift('var ');
+        s.push(';');
+        toString(s); // 'var answer = 42;'
+
+        for (const block of sfc.customBlocks) {
+          if (block.type === 'more-script') {
+            s.push([
+              block.content, // text to add
+              block.name, // source
+              0, // content offset in source
+              {
+                 // langauge capabilities to enable in this segment
+                hover: true,
+                references: true,
+                definition: true,
+                diagnostic: true,
+                rename: true,
+                completion: true,
+                semanticTokens: true,
+              },
+            ]);
+            toString(s); // 'var answer = 42;console.log( answer )'
+          }
+        }
+      }
+    }
+  };
+};
+module.exports = plugin;
+```

package/out/index.d.ts

@@ -0,0 +1,18 @@
+export declare type Segment<T = '--'> = T extends '--' ? SegmentWithoutData : SegmentWithData<T>;
+export declare type SegmentWithoutData = [
+    string,
+    // text
+    string | undefined,
+    // source
+    number | [number, number]
+] | string;
+export declare type SegmentWithData<T> = [
+    string,
+    // text
+    string | undefined,
+    // source
+    number | [number, number],
+    T
+] | string;
+export declare function getLength(segments: Segment<any>[]): number;
+export declare function toString(segments: Segment<any>[]): string;

package/out/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toString = exports.getLength = void 0;
+function getLength(segments) {
+    let length = 0;
+    for (const segment of segments) {
+        length += typeof segment == 'string' ? segment.length : segment[0].length;
+    }
+    return length;
+}
+exports.getLength = getLength;
+function toString(segments) {
+    return segments.map(s => typeof s === 'string' ? s : s[0]).join('');
+}
+exports.toString = toString;

package/package.json

@@ -0,0 +1,17 @@
+{
+	"name": "muggle-string",
+	"version": "0.1.0",
+	"main": "out/index.js",
+	"license": "MIT",
+	"files": [
+		"out/**/*.js",
+		"out/**/*.d.ts"
+	],
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/johnsoncodehk/muggle-string.git"
+	},
+	"devDependencies": {
+		"typescript": "latest"
+	}
+}