chore: release v0.1.2

Author: xiaoluoboding

CHANGELOG.md

@@ -1,17 +1,23 @@
-## [0.1.1](https://github.com/xiaoluoboding/vue-sfc2esm/compare/v0.1.0...v0.1.1) (2021-04-26)
+## [0.1.2](https://github.com/xiaoluoboding/vue-sfc2esm/compare/v0.1.1...v0.1.2) (2021-04-28)
 
 
 ### Features
 
-* isolate file errors & remove crypto fn ([99cf104](https://github.com/xiaoluoboding/vue-sfc2esm/commit/99cf104229cf2c3382a4ca523a38b19227b07e30))
+* add code comment ([345f5b5](https://github.com/xiaoluoboding/vue-sfc2esm/commit/345f5b5e2f56d05379399bdaea949ae7ee797fea))
+* make deleteFile function could without confirm ([fa3fd42](https://github.com/xiaoluoboding/vue-sfc2esm/commit/fa3fd422b495b2b80aae03a334e93258e266aa48))
 
 
 
 ## [0.1.1](https://github.com/xiaoluoboding/vue-sfc2esm/compare/v0.1.0...v0.1.1) (2021-04-26)
 
 
+### Features
+
+* isolate file errors & remove crypto fn ([99cf104](https://github.com/xiaoluoboding/vue-sfc2esm/commit/99cf104229cf2c3382a4ca523a38b19227b07e30))
+
+
 
-## 0.1.1 (2021-04-26)
+# [0.1.0](https://github.com/xiaoluoboding/vue-sfc2esm/compare/5e18fb5f646bbab738a87996918b226d19bed5bc...v0.1.0) (2021-04-24)
 
 
 ### Features

lib/vue-sfc2esm.cjs.js

@@ -1,5 +1,5 @@
 /*!
- * vue-sfc2esm v0.1.1
+ * vue-sfc2esm v0.1.2
  * (c) 2021 xiaoluoboding
  * @license MIT
  */
@@ -40,6 +40,11 @@ const COMP_IDENTIFIER = `__sfc__`;
  * but we may swap it out with a version fetched from CDNs
  */
 let SFCCompiler = defaultCompiler__namespace;
+/**
+ * Compile the `activeFile` in the store. It will change the File.compiled info.
+ *
+ * @param File
+ */
 async function compileFile({ filename, code, compiled }) {
     if (!code.trim()) {
         compiled.errors = [];
@@ -235,7 +240,9 @@ const IMPORT_MAP_CODE = `
   "imports": {
   }
 }`.trim();
-// Virtual Simple File System
+/**
+ * Simple Virtual File System
+ */
 class File {
     constructor(filename, code = '') {
         this.compiled = {
@@ -276,6 +283,11 @@ for (const file in store.files) {
         compileFile(store.files[file]);
     }
 }
+/**
+ * Export the files code.
+ *
+ * @returns exported
+ */
 function exportFiles() {
     const exported = {};
     for (const filename in store.files) {
@@ -287,20 +299,39 @@ function setActive(filename, code) {
     store.activeFilename = filename;
     store.activeFile.code = code;
 }
+/**
+ * Record File errors when compiling file.
+ *
+ * @param errors
+ */
 function recordFileErrors(errors) {
     store.activeFile.compiled.errors = errors;
 }
+/**
+ * Check whether has a filename in store.
+ *
+ * @param filename
+ */
+function hasFile(filename) {
+    if (!(filename in store.files)) {
+        recordFileErrors([`File "${filename}" is not exists.`]);
+        return;
+    }
+}
+/**
+ * Add a file into the store, ready for compilation.
+ *
+ * @param filename
+ * @param code
+ */
 function addFile(filename, code) {
     if (!filename.endsWith('.vue') &&
         !filename.endsWith('.js') &&
         filename !== 'import-map.json') {
         recordFileErrors(['Sandbox only supports *.vue, *.js files or import-map.json.']);
         return;
     }
-    if (filename in store.files) {
-        recordFileErrors([`File "${filename}" already exists.`]);
-        return;
-    }
+    hasFile(filename);
     const file = (store.files[filename] = new File(filename));
     if (filename === 'import-map.json') {
         file.code = IMPORT_MAP_CODE;
@@ -310,23 +341,43 @@ function addFile(filename, code) {
     }
     setActive(filename, file.code);
 }
+/**
+ * Change the file code, It will trigger `compileFile` action.
+ *
+ * @param filename
+ * @param code
+ */
 function changeFile(filename, code) {
-    if (!(filename in store.files)) {
-        recordFileErrors([`File "${filename}" is not exists.`]);
-        return;
-    }
+    hasFile(filename);
     const file = store.files[filename];
     setActive(file.filename, code);
 }
-function deleteFile(filename) {
-    if (confirm(`Are you sure you want to delete ${filename}?`)) {
+/**
+ * Delete the file in the store. with or without confirmation.
+ *
+ * @param filename
+ * @param withConfirm
+ */
+function deleteFile(filename, withConfirm) {
+    hasFile(filename);
+    const doDelete = () => {
         if (store.activeFilename === filename) {
             store.activeFilename = APP_FILE;
         }
         delete store.files[filename];
+    };
+    if (withConfirm && confirm(`Are you sure you want to delete ${filename}?`)) {
+        doDelete();
+        return;
     }
+    doDelete();
 }
 
+/**
+ * Transpiled Vue SFC File to ES modules with `@vue/compiler-sfc`.
+ *
+ * @param filename
+ */
 async function compileModules(filename) {
     if (filename !== activeFilename.value)
         return [];

lib/vue-sfc2esm.d.ts

@@ -1,17 +1,31 @@
+/**
+ * Transpiled Vue SFC File to ES modules with `@vue/compiler-sfc`.
+ *
+ * @param filename
+ */
 declare function compileModules(filename: string): Promise<Array<string>>;
 
+/**
+ * Record the code & errors when a sfc file has been compiled.
+ */
 interface FileCompiled {
     js: string;
     css: string;
     ssr: string;
     errors: Array<string | Error>;
 }
+/**
+ * Simple Virtual File System
+ */
 declare class File {
     filename: string;
     code: string;
     compiled: FileCompiled;
     constructor(filename: string, code?: string);
 }
+/**
+ * `vue-sfc2esm` built-in store.
+ */
 interface Store {
     files: Record<string, File>;
     activeFilename: string;
@@ -20,12 +34,45 @@ interface Store {
     errors: Array<string | Error>;
 }
 declare const store: Store;
+/**
+ * Export the files code.
+ *
+ * @returns exported
+ */
 declare function exportFiles(): Record<string, string>;
+/**
+ * Record File errors when compiling file.
+ *
+ * @param errors
+ */
 declare function recordFileErrors(errors: Array<string | Error>): void;
+/**
+ * Add a file into the store, ready for compilation.
+ *
+ * @param filename
+ * @param code
+ */
 declare function addFile(filename: string, code: string): void;
+/**
+ * Change the file code, It will trigger `compileFile` action.
+ *
+ * @param filename
+ * @param code
+ */
 declare function changeFile(filename: string, code: string): void;
-declare function deleteFile(filename: string): void;
+/**
+ * Delete the file in the store. with or without confirmation.
+ *
+ * @param filename
+ * @param withConfirm
+ */
+declare function deleteFile(filename: string, withConfirm?: boolean): void;
 
+/**
+ * Compile the `activeFile` in the store. It will change the File.compiled info.
+ *
+ * @param File
+ */
 declare function compileFile({ filename, code, compiled }: File): Promise<void>;
 
 export { addFile, changeFile, compileFile, compileModules, deleteFile, exportFiles, recordFileErrors, store };

lib/vue-sfc2esm.esm.js

@@ -1,5 +1,5 @@
 /*!
- * vue-sfc2esm v0.1.1
+ * vue-sfc2esm v0.1.2
  * (c) 2021 xiaoluoboding
  * @license MIT
  */
@@ -14,6 +14,11 @@ const COMP_IDENTIFIER = `__sfc__`;
  * but we may swap it out with a version fetched from CDNs
  */
 let SFCCompiler = defaultCompiler;
+/**
+ * Compile the `activeFile` in the store. It will change the File.compiled info.
+ *
+ * @param File
+ */
 async function compileFile({ filename, code, compiled }) {
     if (!code.trim()) {
         compiled.errors = [];
@@ -209,7 +214,9 @@ const IMPORT_MAP_CODE = `
   "imports": {
   }
 }`.trim();
-// Virtual Simple File System
+/**
+ * Simple Virtual File System
+ */
 class File {
     constructor(filename, code = '') {
         this.compiled = {
@@ -250,6 +257,11 @@ for (const file in store.files) {
         compileFile(store.files[file]);
     }
 }
+/**
+ * Export the files code.
+ *
+ * @returns exported
+ */
 function exportFiles() {
     const exported = {};
     for (const filename in store.files) {
@@ -261,20 +273,39 @@ function setActive(filename, code) {
     store.activeFilename = filename;
     store.activeFile.code = code;
 }
+/**
+ * Record File errors when compiling file.
+ *
+ * @param errors
+ */
 function recordFileErrors(errors) {
     store.activeFile.compiled.errors = errors;
 }
+/**
+ * Check whether has a filename in store.
+ *
+ * @param filename
+ */
+function hasFile(filename) {
+    if (!(filename in store.files)) {
+        recordFileErrors([`File "${filename}" is not exists.`]);
+        return;
+    }
+}
+/**
+ * Add a file into the store, ready for compilation.
+ *
+ * @param filename
+ * @param code
+ */
 function addFile(filename, code) {
     if (!filename.endsWith('.vue') &&
         !filename.endsWith('.js') &&
         filename !== 'import-map.json') {
         recordFileErrors(['Sandbox only supports *.vue, *.js files or import-map.json.']);
         return;
     }
-    if (filename in store.files) {
-        recordFileErrors([`File "${filename}" already exists.`]);
-        return;
-    }
+    hasFile(filename);
     const file = (store.files[filename] = new File(filename));
     if (filename === 'import-map.json') {
         file.code = IMPORT_MAP_CODE;
@@ -284,23 +315,43 @@ function addFile(filename, code) {
     }
     setActive(filename, file.code);
 }
+/**
+ * Change the file code, It will trigger `compileFile` action.
+ *
+ * @param filename
+ * @param code
+ */
 function changeFile(filename, code) {
-    if (!(filename in store.files)) {
-        recordFileErrors([`File "${filename}" is not exists.`]);
-        return;
-    }
+    hasFile(filename);
     const file = store.files[filename];
     setActive(file.filename, code);
 }
-function deleteFile(filename) {
-    if (confirm(`Are you sure you want to delete ${filename}?`)) {
+/**
+ * Delete the file in the store. with or without confirmation.
+ *
+ * @param filename
+ * @param withConfirm
+ */
+function deleteFile(filename, withConfirm) {
+    hasFile(filename);
+    const doDelete = () => {
         if (store.activeFilename === filename) {
             store.activeFilename = APP_FILE;
         }
         delete store.files[filename];
+    };
+    if (withConfirm && confirm(`Are you sure you want to delete ${filename}?`)) {
+        doDelete();
+        return;
     }
+    doDelete();
 }
 
+/**
+ * Transpiled Vue SFC File to ES modules with `@vue/compiler-sfc`.
+ *
+ * @param filename
+ */
 async function compileModules(filename) {
     if (filename !== activeFilename.value)
         return [];