detype 0.6.3 → 1.0.1

package/README.md

@@ -132,17 +132,17 @@ function transformFile(
 ): Promise<void>;
 
 // Remove magic comments without performing the TS to JS transform
-export function removeMagicComments(
+export async function removeMagicComments(
 	// Source code
 	code: string,
 	// File name for the source
 	fileName: string,
 	// Options to pass to prettier
 	prettierOptions?: PrettierOptions | null,
-): string;
+): Promise<string>;
 
 // Remove magic comments from the input file and write the output to another file
-export function removeMagicCommentsFromFile(
+export async function removeMagicCommentsFromFile(
 	inputFileName: string,
 	outputFileName: string,
 ): Promise<void>;
@@ -150,6 +150,11 @@ export function removeMagicCommentsFromFile(
 
 ## Change log
 
+### 1.0
+
+- BREAKING CHANGE: `removeMagicComments` is now async due to Prettier's API change
+- feat: support transform defineProps's and defineEmits's types to parameters ([PR by Dunqing](https://github.com/cyco130/detype/pull/11))
+
 ### 0.6
 
 - feature: Option to remove @ts-ignore and @ts-expect-error comments

package/dist/cli.js

@@ -33,15 +33,36 @@ var import_node_fs = __toESM(require("fs"));
 var import_core = require("@babel/core");
 var import_prettier = require("prettier");
 var import_compiler_sfc = require("@vuedx/compiler-sfc");
+var import_compiler_sfc2 = require("@vue/compiler-sfc");
 var import_template_ast_types = require("@vuedx/template-ast-types");
 var import_preset_typescript = __toESM(require("@babel/preset-typescript"));
 var import_string_prototype = require("string.prototype.replaceall");
 (0, import_string_prototype.shim)();
+function getDefinePropsObject(content) {
+  const matched = /\sprops:\s*\{/m.exec(content);
+  if (matched) {
+    const startContentIndex = matched.index + matched[0].length - 1;
+    let leftBracketCount = 1;
+    let endContentIndex = startContentIndex + 1;
+    while (leftBracketCount) {
+      if (content.charAt(endContentIndex) === "{") {
+        leftBracketCount++;
+      } else if (content.charAt(endContentIndex) === "}") {
+        leftBracketCount--;
+      }
+      endContentIndex++;
+    }
+    return content.substring(startContentIndex, endContentIndex);
+  }
+  return "";
+}
 async function transform(code, fileName, options = {}) {
-  var _a, _b, _c, _d;
+  var _a, _b, _c, _d, _e;
   const { prettierOptions, ...removeTypeOptions } = options;
   const originalCode = code;
   const originalFileName = fileName;
+  let propsContent = "";
+  let emitsContent = "";
   code = code.replaceAll("\r\n", "\n");
   if (fileName.endsWith(".vue")) {
     const parsedVue = (0, import_compiler_sfc.parse)(code);
@@ -49,6 +70,19 @@ async function transform(code, fileName, options = {}) {
       return originalCode;
     }
     let { script: script1, scriptSetup: script2 } = parsedVue.descriptor;
+    const isContainsDefinePropsType = script2 == null ? void 0 : script2.content.match(/defineProps\s*</m);
+    const isContainsDefineEmitType = script2 == null ? void 0 : script2.content.match(/defineEmits\s*</m);
+    if (isContainsDefinePropsType || isContainsDefineEmitType) {
+      const { content } = (0, import_compiler_sfc2.compileScript)(parsedVue.descriptor, {
+        id: "xxxxxxx"
+      });
+      if (isContainsDefinePropsType) {
+        propsContent = getDefinePropsObject(content);
+      }
+      if (isContainsDefineEmitType) {
+        emitsContent = ((_c = content.match(/\semits:\s(\[.*\]?)/m)) == null ? void 0 : _c[1]) || "";
+      }
+    }
     if (script1 && script2 && script1.loc.start.offset < script2.loc.start.offset) {
       [script2, script1] = [script1, script2];
     }
@@ -56,20 +90,26 @@ async function transform(code, fileName, options = {}) {
       code,
       fileName,
       script1,
-      (_c = parsedVue.descriptor.template) == null ? void 0 : _c.ast,
+      (_d = parsedVue.descriptor.template) == null ? void 0 : _d.ast,
       removeTypeOptions
     );
     code = await removeTypesFromVueSfcScript(
       code,
       fileName,
       script2,
-      (_d = parsedVue.descriptor.template) == null ? void 0 : _d.ast,
+      (_e = parsedVue.descriptor.template) == null ? void 0 : _e.ast,
       removeTypeOptions
     );
   } else {
     code = await removeTypes(code, fileName, removeTypeOptions);
   }
-  code = (0, import_prettier.format)(code, {
+  if (propsContent) {
+    code = code.replace("defineProps(", (str) => `${str}${propsContent}`);
+  }
+  if (emitsContent) {
+    code = code.replace("defineEmits(", (str) => `${str}${emitsContent}`);
+  }
+  code = await (0, import_prettier.format)(code, {
     ...prettierOptions,
     filepath: originalFileName
   });
@@ -138,9 +178,9 @@ async function removeTypesFromVueSfcScript(code, fileName, script, templateAst,
     (0, import_template_ast_types.traverse)(templateAst, {
       enter(node) {
         if ((0, import_template_ast_types.isSimpleExpressionNode)(node) && !node.isStatic) {
-          expressions.add(node.content);
+          expressions.add(`[${node.content}]`);
         } else if ((0, import_template_ast_types.isComponentNode)(node)) {
-          expressions.add(node.tag);
+          expressions.add(`[${node.tag}]`);
         }
       }
     });
@@ -185,7 +225,7 @@ function processMagicComments(input) {
   }
   return input;
 }
-function removeMagicComments(code, fileName, prettierOptions) {
+async function removeMagicComments(code, fileName, prettierOptions) {
   const REPLACE_COMMENT = "// @detype: replace\n";
   const WITH_COMMENT = "// @detype: with\n";
   const END_COMMENT = "// @detype: end\n";
@@ -207,7 +247,7 @@ function removeMagicComments(code, fileName, prettierOptions) {
     start = code.indexOf(REPLACE_COMMENT, before.length + keptText.length);
     startEnd = start + REPLACE_COMMENT.length;
   }
-  code = (0, import_prettier.format)(code, {
+  code = await (0, import_prettier.format)(code, {
     ...prettierOptions,
     filepath: fileName
   });
@@ -239,7 +279,7 @@ var import_fast_glob = __toESM(require("fast-glob"));
 // package.json
 var package_default = {
   name: "detype",
-  version: "0.6.3",
+  version: "1.0.1",
   description: "Removes TypeScript type annotations but keeps the formatting",
   main: "dist/index.js",
   bin: "detype.js",
@@ -263,28 +303,28 @@ var package_default = {
     "index.d.ts"
   ],
   dependencies: {
-    "@babel/core": "^7.21.4",
-    "@babel/preset-typescript": "^7.21.4",
-    "@vue/compiler-dom": "^3.2.47",
+    "@babel/core": "^7.23.7",
+    "@babel/preset-typescript": "^7.23.3",
+    "@vue/compiler-dom": "^3.4.13",
+    "@vue/compiler-sfc": "^3.4.13",
     "@vuedx/compiler-sfc": "0.7.1",
     "@vuedx/template-ast-types": "0.7.1",
-    "fast-glob": "^3.2.12",
-    prettier: "^2.8.7",
-    "string.prototype.replaceall": "^1.0.7"
+    "fast-glob": "^3.3.2",
+    prettier: "^3.2.2",
+    "string.prototype.replaceall": "^1.0.8"
   },
   devDependencies: {
-    "@babel/traverse": "^7.21.4",
-    "@cyco130/eslint-config": "^3.0.2",
-    "@types/babel__core": "^7.20.0",
-    "@types/babel__traverse": "^7.18.3",
-    "@types/node": "18.15.11",
-    "@types/prettier": "^2.7.2",
-    eslint: "^8.37.0",
+    "@babel/traverse": "^7.23.7",
+    "@cyco130/eslint-config": "^3.6.1",
+    "@types/babel__core": "^7.20.5",
+    "@types/babel__traverse": "^7.20.5",
+    "@types/node": "20.11.1",
+    eslint: "^8.56.0",
     "npm-run-all": "^4.1.5",
-    rimraf: "^4.4.1",
-    tsup: "^6.7.0",
-    typescript: "^5.0.3",
-    vitest: "0.29.8"
+    rimraf: "^5.0.5",
+    tsup: "^8.0.1",
+    typescript: "^5.3.3",
+    vitest: "1.2.0"
   },
   repository: {
     type: "git",
@@ -353,9 +393,7 @@ async function cli(...args2) {
       printUsage();
       return false;
     }
-    const files = (await (0, import_fast_glob.default)(unixify(input + "/**/*.{ts,tsx,vue}"))).filter(
-      (file) => !file.endsWith(".d.ts")
-    );
+    const files = (await (0, import_fast_glob.default)(unixify(input + "/**/*.{ts,tsx,vue}"))).filter((file) => !file.endsWith(".d.ts"));
     const dirs = [...new Set(files.map((file) => import_node_path.default.dirname(file)))].sort();
     await mkdir(import_node_path.default.normalize(output), { recursive: true });
     for (const dir of dirs) {
@@ -461,4 +499,7 @@ function unixify(name) {
 
 // src/cli.ts
 var args = process.argv.slice(2);
-cli(...args).then((success) => process.exit(success ? 0 : 1));
+cli(...args).then((success) => process.exit(success ? 0 : 1)).catch((error) => {
+  console.error(error);
+  process.exit(1);
+});

package/dist/index.d.ts

@@ -25,7 +25,7 @@ declare function transform(code: string, fileName: string, options?: TransformOp
  * @param fileName        File name for the source
  * @param prettierOptions Options to pass to prettier
  */
-declare function removeMagicComments(code: string, fileName: string, prettierOptions?: Options | null): string;
+declare function removeMagicComments(code: string, fileName: string, prettierOptions?: Options | null): Promise<string>;
 
 /**
  * Transform the input file and write the output to another file

package/dist/index.js

@@ -41,15 +41,36 @@ module.exports = __toCommonJS(src_exports);
 var import_core = require("@babel/core");
 var import_prettier = require("prettier");
 var import_compiler_sfc = require("@vuedx/compiler-sfc");
+var import_compiler_sfc2 = require("@vue/compiler-sfc");
 var import_template_ast_types = require("@vuedx/template-ast-types");
 var import_preset_typescript = __toESM(require("@babel/preset-typescript"));
 var import_string_prototype = require("string.prototype.replaceall");
 (0, import_string_prototype.shim)();
+function getDefinePropsObject(content) {
+  const matched = /\sprops:\s*\{/m.exec(content);
+  if (matched) {
+    const startContentIndex = matched.index + matched[0].length - 1;
+    let leftBracketCount = 1;
+    let endContentIndex = startContentIndex + 1;
+    while (leftBracketCount) {
+      if (content.charAt(endContentIndex) === "{") {
+        leftBracketCount++;
+      } else if (content.charAt(endContentIndex) === "}") {
+        leftBracketCount--;
+      }
+      endContentIndex++;
+    }
+    return content.substring(startContentIndex, endContentIndex);
+  }
+  return "";
+}
 async function transform(code, fileName, options = {}) {
-  var _a, _b, _c, _d;
+  var _a, _b, _c, _d, _e;
   const { prettierOptions, ...removeTypeOptions } = options;
   const originalCode = code;
   const originalFileName = fileName;
+  let propsContent = "";
+  let emitsContent = "";
   code = code.replaceAll("\r\n", "\n");
   if (fileName.endsWith(".vue")) {
     const parsedVue = (0, import_compiler_sfc.parse)(code);
@@ -57,6 +78,19 @@ async function transform(code, fileName, options = {}) {
       return originalCode;
     }
     let { script: script1, scriptSetup: script2 } = parsedVue.descriptor;
+    const isContainsDefinePropsType = script2 == null ? void 0 : script2.content.match(/defineProps\s*</m);
+    const isContainsDefineEmitType = script2 == null ? void 0 : script2.content.match(/defineEmits\s*</m);
+    if (isContainsDefinePropsType || isContainsDefineEmitType) {
+      const { content } = (0, import_compiler_sfc2.compileScript)(parsedVue.descriptor, {
+        id: "xxxxxxx"
+      });
+      if (isContainsDefinePropsType) {
+        propsContent = getDefinePropsObject(content);
+      }
+      if (isContainsDefineEmitType) {
+        emitsContent = ((_c = content.match(/\semits:\s(\[.*\]?)/m)) == null ? void 0 : _c[1]) || "";
+      }
+    }
     if (script1 && script2 && script1.loc.start.offset < script2.loc.start.offset) {
       [script2, script1] = [script1, script2];
     }
@@ -64,20 +98,26 @@ async function transform(code, fileName, options = {}) {
       code,
       fileName,
       script1,
-      (_c = parsedVue.descriptor.template) == null ? void 0 : _c.ast,
+      (_d = parsedVue.descriptor.template) == null ? void 0 : _d.ast,
       removeTypeOptions
     );
     code = await removeTypesFromVueSfcScript(
       code,
       fileName,
       script2,
-      (_d = parsedVue.descriptor.template) == null ? void 0 : _d.ast,
+      (_e = parsedVue.descriptor.template) == null ? void 0 : _e.ast,
       removeTypeOptions
     );
   } else {
     code = await removeTypes(code, fileName, removeTypeOptions);
   }
-  code = (0, import_prettier.format)(code, {
+  if (propsContent) {
+    code = code.replace("defineProps(", (str) => `${str}${propsContent}`);
+  }
+  if (emitsContent) {
+    code = code.replace("defineEmits(", (str) => `${str}${emitsContent}`);
+  }
+  code = await (0, import_prettier.format)(code, {
     ...prettierOptions,
     filepath: originalFileName
   });
@@ -146,9 +186,9 @@ async function removeTypesFromVueSfcScript(code, fileName, script, templateAst,
     (0, import_template_ast_types.traverse)(templateAst, {
       enter(node) {
         if ((0, import_template_ast_types.isSimpleExpressionNode)(node) && !node.isStatic) {
-          expressions.add(node.content);
+          expressions.add(`[${node.content}]`);
         } else if ((0, import_template_ast_types.isComponentNode)(node)) {
-          expressions.add(node.tag);
+          expressions.add(`[${node.tag}]`);
         }
       }
     });
@@ -193,7 +233,7 @@ function processMagicComments(input) {
   }
   return input;
 }
-function removeMagicComments(code, fileName, prettierOptions) {
+async function removeMagicComments(code, fileName, prettierOptions) {
   const REPLACE_COMMENT = "// @detype: replace\n";
   const WITH_COMMENT = "// @detype: with\n";
   const END_COMMENT = "// @detype: end\n";
@@ -215,7 +255,7 @@ function removeMagicComments(code, fileName, prettierOptions) {
     start = code.indexOf(REPLACE_COMMENT, before.length + keptText.length);
     startEnd = start + REPLACE_COMMENT.length;
   }
-  code = (0, import_prettier.format)(code, {
+  code = await (0, import_prettier.format)(code, {
     ...prettierOptions,
     filepath: fileName
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "detype",
-  "version": "0.6.3",
+  "version": "1.0.1",
   "description": "Removes TypeScript type annotations but keeps the formatting",
   "main": "dist/index.js",
   "bin": "detype.js",
@@ -12,28 +12,28 @@
     "index.d.ts"
   ],
   "dependencies": {
-    "@babel/core": "^7.21.4",
-    "@babel/preset-typescript": "^7.21.4",
-    "@vue/compiler-dom": "^3.2.47",
+    "@babel/core": "^7.23.7",
+    "@babel/preset-typescript": "^7.23.3",
+    "@vue/compiler-dom": "^3.4.13",
+    "@vue/compiler-sfc": "^3.4.13",
     "@vuedx/compiler-sfc": "0.7.1",
     "@vuedx/template-ast-types": "0.7.1",
-    "fast-glob": "^3.2.12",
-    "prettier": "^2.8.7",
-    "string.prototype.replaceall": "^1.0.7"
+    "fast-glob": "^3.3.2",
+    "prettier": "^3.2.2",
+    "string.prototype.replaceall": "^1.0.8"
   },
   "devDependencies": {
-    "@babel/traverse": "^7.21.4",
-    "@cyco130/eslint-config": "^3.0.2",
-    "@types/babel__core": "^7.20.0",
-    "@types/babel__traverse": "^7.18.3",
-    "@types/node": "18.15.11",
-    "@types/prettier": "^2.7.2",
-    "eslint": "^8.37.0",
+    "@babel/traverse": "^7.23.7",
+    "@cyco130/eslint-config": "^3.6.1",
+    "@types/babel__core": "^7.20.5",
+    "@types/babel__traverse": "^7.20.5",
+    "@types/node": "20.11.1",
+    "eslint": "^8.56.0",
     "npm-run-all": "^4.1.5",
-    "rimraf": "^4.4.1",
-    "tsup": "^6.7.0",
-    "typescript": "^5.0.3",
-    "vitest": "0.29.8"
+    "rimraf": "^5.0.5",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.3",
+    "vitest": "1.2.0"
   },
   "repository": {
     "type": "git",