detype 0.3.5 → 0.4.2

package/README.md

@@ -6,7 +6,9 @@
 npm i -g detype
 ```
 
-**detype** is a command line tool and library to remove type annotations and other TypeScript specific syntax constructs and output vanilla JavaScript **without altering the source formatting** too much. It supports `.ts`, `.tsx`, as well as `.vue` extensions.
+Suppose you have a library that you want to provide usage examples for. **detype** can help you generate vanilla JavaScript samples from TypeScript samples automatically and remove the burden of maintaining two separate versions of what is essentially the same code.
+
+It is a command line tool and a library that removes type annotations and other TypeScript specific syntax constructs and outputs vanilla JavaScript **without altering the source formatting** too much. It supports `.ts`, `.tsx`, as well as `.vue` files.
 
 In other words, it turns this:
 
@@ -43,26 +45,68 @@ export function bar(foo) {
 }
 ```
 
-It achieves this using [Babel](https://babeljs.io/), [Babel's TypeScript preset](https://babeljs.io/docs/en/babel-preset-typescript), a small custom Babel plugin to remove comments attached to TypeScript-only constructs, and [Prettier](https://prettier.io/). For Vue files, it uses the tools from the [VueDX project](https://github.com/vuedx/languagetools) The output is very close to hand-written JavaScript, especially if you were already using Prettier for formatting.
+The output is very close to hand-written JavaScript, especially if you were already using Prettier for formatting.
 
-**One possible use case** is the following: Suppose you have a library that you want to provide usage examples for. Automatically generating vanilla JavaScript samples from TypeScript samples using `detype` would remove the burden of maintaining two separate versions of what is essentially the same code.
+## Doesn't `tsc` already do that?
 
-## Installation
+There are lots of tools for transpiling TypeScript into plain JavaScript (`tsc`, `babel`, `swc`, `esbuild`, `sucrase` etc.) but none of them is perfectly suitable for this specific use case. Most of them don't preserve the formatting at all. `sucrase` comes close, but it doesn't remove comments attached to TypeScript-only constructs.
 
-```sh
-npm install detype
+`detype` uses [Babel](https://babeljs.io/), a small Babel plugin to remove comments attached to TypeScript-only constructs, and [Prettier](https://prettier.io/) under the hood. For Vue files, it also uses the tools from the [VueDX project](https://github.com/vuedx/languagetools).
+
+## Magic comments
+
+Sometimes you want the generated JavaScript to be slightly different than the TypeScript original. You can use the magic comments feature to achieve this:
+
+Input:
+
+```ts
+// @detype: replace
+// These two lines will be removed
+console.log("Hello from TypeScript");
+// @detype: with
+// // Notice the double comments!
+// console.log("Hello from JavaScript");
+// @detype: end
+```
+
+Output:
+
+```js
+// Notice the double comments!
+console.log("Hello from JavaScript");
+```
+
+If you just want to remove the magic comments, you can use the `-m` CLI flag or the `removeMagicComments` function to generate uncluttered TypeScript like this:
+
+```ts
+// These two lines will be removed
+console.log("Hello from TypeScript");
 ```
 
+## System requirements
+
 `detype` requires Node version 12.22.7 or later.
 
 ## CLI Usage
 
-```sh
-detype input.ts output.js
-detype file.ts # Output to file.js
-detype file.tsx # Output to file.jsx
-detype file.ts output-dir # Output to output-dir/file.sjs
-detype input-dir output-dir # Process recursively, rename .ts(x) as .js(x)
+```
+detype [-m | --remove-magic-comments] <INPUT> [OUTPUT]
+
+  INPUT   Input file or directory
+
+  OUTPUT  Output file or directory
+    (optional if it can be inferred and it won't overwrite the source file)
+
+  -m, --remove-magic-comments
+    Remove magic comments only, don't perform ts > js transform
+
+detype [-v | --version]
+
+  Print version and exit
+
+detype [-h | --help]
+
+  Print this help and exit
 ```
 
 ## Node API
@@ -70,31 +114,51 @@ detype input-dir output-dir # Process recursively, rename .ts(x) as .js(x)
 ```ts
 // Transform TypeScript code into vanilla JavaScript without affecting the formatting
 function transform(
-	// Source coude
-	code: string,
-	// File name for the source (useful for distinguishing between .ts and .tsx)
-	fileName: string,
-	// Options to pass to prettier
-	prettierOptions?: PrettierOptions | null,
+  // Source code
+  code: string,
+  // File name for the source
+  fileName: string,
+  // Options to pass to prettier
+  prettierOptions?: PrettierOptions | null,
 ): Promise<string>;
 
 // Transform the input file and write the output to another file
 function transformFile(
-	inputFileName: string,
-	outputFileName: string,
+  inputFileName: string,
+  outputFileName: string,
+): Promise<void>;
+
+// Remove magic comments without performing the TS to JS transform
+export function removeMagicComments(
+  // Source code
+  code: string,
+  // File name for the source
+  fileName: string,
+  // Options to pass to prettier
+  prettierOptions?: PrettierOptions | null,
+): string;
+
+// Remove magic comments from the input file and write the output to another file
+export function removeMagicCommentsFromFile(
+  inputFileName: string,
+  outputFileName: string,
 ): Promise<void>;
 ```
 
 ## Change log
-## 0.3
-- feat: Magic comments
-- feat: Expose type declarations
+### 0.4
+- feature: CLI support for removing magic comments
+- chore: Improve documentation
+
+### 0.3
+- feature: Magic comments
+- feature: Expose type declarations
 - fix: Better empty line handling
 
-## 0.2
-- feat: for Vue single file components
+### 0.2
+- feature: for Vue single file components
 
-## 0.1
+### 0.1
 - Initial release
 
 ## Credits

package/dist/cli.js

@@ -21,33 +21,30 @@ var __spreadValues = (a, b) => {
   return a;
 };
 var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
-var __reExport = (target, module2, desc) => {
-  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
-    for (let key of __getOwnPropNames(module2))
-      if (!__hasOwnProp.call(target, key) && key !== "default")
-        __defProp(target, key, { get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable });
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
   }
-  return target;
-};
-var __toModule = (module2) => {
-  return __reExport(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", module2 && module2.__esModule && "default" in module2 ? { get: () => module2.default, enumerable: true } : { value: module2, enumerable: true })), module2);
+  return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod));
 
 // src/cli-lib.ts
-var import_fs2 = __toModule(require("fs"));
-var import_path = __toModule(require("path"));
+var import_fs2 = __toESM(require("fs"));
+var import_path = __toESM(require("path"));
 
 // src/transformFile.ts
-var import_fs = __toModule(require("fs"));
+var import_fs = __toESM(require("fs"));
 
 // src/transform.ts
-var import_core = __toModule(require("@babel/core"));
-var import_prettier = __toModule(require("prettier"));
-var import_compiler_sfc = __toModule(require("@vuedx/compiler-sfc"));
-var import_template_ast_types = __toModule(require("@vuedx/template-ast-types"));
-var import_preset_typescript = __toModule(require("@babel/preset-typescript"));
-var import_string_prototype = __toModule(require("string.prototype.replaceall"));
+var import_core = require("@babel/core");
+var import_prettier = require("prettier");
+var import_compiler_sfc = require("@vuedx/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)();
 async function transform(code, fileName, prettierOptions) {
   var _a, _b, _c, _d;
@@ -117,7 +114,7 @@ async function removeTypesFromVueSfcScript(code, fileName, script, templateAst)
   if (script === null || script.lang !== "ts")
     return code;
   if (script.setup && templateAst) {
-    const expressions = new Set();
+    const expressions = /* @__PURE__ */ new Set();
     (0, import_template_ast_types.traverse)(templateAst, {
       enter(node) {
         if ((0, import_template_ast_types.isSimpleExpressionNode)(node) && !node.isStatic) {
@@ -166,9 +163,36 @@ function processMagicComments(input) {
   }
   return input;
 }
+function removeMagicComments(code, fileName, prettierOptions) {
+  const REPLACE_COMMENT = "// @detype: replace\n";
+  const WITH_COMMENT = "// @detype: with\n";
+  const END_COMMENT = "// @detype: end\n";
+  let start = code.indexOf(REPLACE_COMMENT);
+  let startEnd = start + REPLACE_COMMENT.length;
+  while (start >= 0) {
+    const middle = code.indexOf(WITH_COMMENT, start);
+    if (middle < 0)
+      return code;
+    const middleEnd = middle + WITH_COMMENT.length;
+    const end = code.indexOf(END_COMMENT, middleEnd);
+    if (end < 0)
+      return code;
+    const endEnd = end + END_COMMENT.length;
+    const before = code.slice(0, start);
+    const keptText = code.slice(startEnd, middle);
+    const after = code.slice(endEnd);
+    code = before + keptText + after;
+    start = code.indexOf(REPLACE_COMMENT, before.length + keptText.length);
+    startEnd = start + REPLACE_COMMENT.length;
+  }
+  code = (0, import_prettier.format)(code, __spreadProps(__spreadValues({}, prettierOptions), {
+    filepath: fileName
+  }));
+  return code;
+}
 
 // src/transformFile.ts
-var import_prettier2 = __toModule(require("prettier"));
+var import_prettier2 = require("prettier");
 var { readFile, writeFile } = import_fs.default.promises;
 async function transformFile(inputFileName, outputFileName) {
   const code = await readFile(inputFileName, "utf-8");
@@ -176,14 +200,119 @@ async function transformFile(inputFileName, outputFileName) {
   const output = await transform(code, inputFileName, prettierConfig);
   await writeFile(outputFileName, output, "utf-8");
 }
+async function removeMagicCommentsFromFile(inputFileName, outputFileName) {
+  const code = await readFile(inputFileName, "utf-8");
+  const prettierConfig = await (0, import_prettier2.resolveConfig)(inputFileName);
+  const output = await removeMagicComments(code, inputFileName, prettierConfig);
+  await writeFile(outputFileName, output, "utf-8");
+}
+
+// src/cli-lib.ts
+var import_fast_glob = __toESM(require("fast-glob"));
+
+// package.json
+var name = "detype";
+var version = "0.4.2";
+var description = "Removes TypeScript type annotations but keeps the formatting";
+var main = "dist/index.js";
+var bin = "detype.js";
+var engines = {
+  node: ">=12.22.7"
+};
+var scripts = {
+  prepublishOnly: "pnpm build",
+  build: "node build.mjs",
+  watch: "node build.mjs --watch",
+  test: "run-p 'test:*'",
+  "test:unit": "jest",
+  "test:typecheck": "tsc -p tsconfig.json --noEmit",
+  "test:lint": "eslint src --max-warnings 0",
+  format: "prettier . --write"
+};
+var files = [
+  "dist/**/*",
+  "index.d.ts"
+];
+var dependencies = {
+  "@babel/core": "^7.17.8",
+  "@babel/preset-typescript": "^7.16.7",
+  "@vuedx/compiler-sfc": "^0.7.1",
+  "@vuedx/template-ast-types": "^0.7.2",
+  "fast-glob": "^3.2.11",
+  prettier: "^2.6.2",
+  "string.prototype.replaceall": "^1.0.6"
+};
+var devDependencies = {
+  "@babel/traverse": "^7.17.3",
+  "@types/jest": "^27.4.1",
+  "@types/node": "17.0.23",
+  "@typescript-eslint/eslint-plugin": "^5.17.0",
+  "@typescript-eslint/parser": "^5.17.0",
+  esbuild: "^0.14.31",
+  "esbuild-jest": "^0.5.0",
+  "esbuild-node-externals": "^1.4.1",
+  eslint: "^8.12.0",
+  "eslint-config-prettier": "^8.5.0",
+  "eslint-import-resolver-typescript": "^2.7.1",
+  "eslint-plugin-import": "^2.25.4",
+  "eslint-plugin-no-only-tests": "^2.6.0",
+  "eslint-plugin-only-warn": "^1.0.3",
+  "eslint-plugin-ssr-friendly": "^1.0.6",
+  jest: "^27.5.1",
+  "npm-run-all": "^4.1.5",
+  rimraf: "^3.0.2",
+  typescript: "^4.6.3"
+};
+var repository = {
+  type: "git",
+  url: "git+https://github.com/cyco130/detype.git"
+};
+var keywords = [
+  "typescript",
+  "formatting",
+  "vue",
+  "sfc"
+];
+var author = "Fatih Ayg\xFCn <cyco130@gmail.com>";
+var license = "MIT";
+var bugs = {
+  url: "https://github.com/cyco130/detype/issues"
+};
+var homepage = "https://github.com/cyco130/detype#readme";
+var package_default = {
+  name,
+  version,
+  description,
+  main,
+  bin,
+  engines,
+  scripts,
+  files,
+  dependencies,
+  devDependencies,
+  repository,
+  keywords,
+  author,
+  license,
+  bugs,
+  homepage
+};
 
 // src/cli-lib.ts
-var import_fast_glob = __toModule(require("fast-glob"));
 var { stat, mkdir } = import_fs2.default.promises;
-async function cli(input, output) {
-  if (!input) {
+async function cli(...args2) {
+  let [flag, input, output] = args2;
+  if (!flag || flag === "-h" || flag === "--help") {
     printUsage();
-    return false;
+    return !!flag;
+  }
+  if (flag === "-v" || flag === "--version") {
+    console.log(VERSION);
+    return true;
+  }
+  const removeMagic = flag === "-m" || flag === "--remove-magic-comments";
+  if (!removeMagic) {
+    [input, output] = args2;
   }
   const inputStat = await stat(input);
   if (inputStat.isDirectory()) {
@@ -192,19 +321,19 @@ async function cli(input, output) {
       printUsage();
       return false;
     }
-    const files = (await (0, import_fast_glob.default)(import_path.default.join(input, "**/*.{ts,tsx,vue}"))).filter((file) => !file.endsWith(".d.ts"));
-    const dirs = [...new Set(files.map((file) => import_path.default.dirname(file)))].sort();
-    await mkdirp(output);
+    const files2 = (await (0, import_fast_glob.default)(import_path.default.join(input, "**/*.{ts,tsx,vue}"))).filter((file) => !file.endsWith(".d.ts"));
+    const dirs = [...new Set(files2.map((file) => import_path.default.dirname(file)))].sort();
+    await mkdir(output, { recursive: true });
     for (const dir of dirs) {
       const outDir = import_path.default.join(output, import_path.default.relative(input, dir));
       if (outDir === output)
         continue;
-      await mkdirp(outDir);
+      await mkdir(outDir, { recursive: true });
     }
-    for (const file of files) {
+    for (const file of files2) {
       const inputDir = import_path.default.dirname(import_path.default.relative(input, file));
       const outputName = inferName(file, import_path.default.join(output, inputDir));
-      await transformFile(file, outputName);
+      removeMagic ? await removeMagicCommentsFromFile(file, outputName) : await transformFile(file, outputName);
     }
     return true;
   }
@@ -219,46 +348,63 @@ async function cli(input, output) {
       output = inferName(input, output);
     }
   } else {
+    if (removeMagic) {
+      console.error("Output file name is required when removing magic comments");
+      return false;
+    }
+    if (input.endsWith(".vue")) {
+      console.error("Output file name is required for .vue files");
+      return false;
+    }
     output = inferName(input);
   }
   const outputDir = import_path.default.dirname(output);
   if (outputDir) {
-    await mkdirp(outputDir);
+    await mkdir(outputDir, { recursive: true });
   }
-  await transformFile(input, output);
+  removeMagic ? await removeMagicCommentsFromFile(input, output) : await transformFile(input, output);
   return true;
-}
-function inferName(input, outputDir) {
-  let output;
-  const { dir, name, ext } = import_path.default.parse(input);
-  if (ext === ".ts") {
-    output = import_path.default.join(outputDir != null ? outputDir : dir, name + ".js");
-  } else if (ext === ".tsx") {
-    output = import_path.default.join(outputDir != null ? outputDir : dir, name + ".jsx");
-  } else if (ext === ".vue") {
-    output = import_path.default.join(outputDir != null ? outputDir : dir, name + ".vue");
-  } else {
-    throw new Error(`Unknwon file extension ${input}`);
-  }
-  return output;
-}
-async function mkdirp(dir) {
-  await mkdir(dir, { recursive: true }).catch((error) => {
-    if (error && error.code == "EEXIST") {
-      return;
+  function inferName(input2, outputDir2) {
+    let output2;
+    const { dir, name: name2, ext } = import_path.default.parse(input2);
+    if (removeMagic) {
+      output2 = import_path.default.join(outputDir2 != null ? outputDir2 : dir, `${name2}${ext}`);
+    } else if (ext === ".ts") {
+      output2 = import_path.default.join(outputDir2 != null ? outputDir2 : dir, name2 + ".js");
+    } else if (ext === ".tsx") {
+      output2 = import_path.default.join(outputDir2 != null ? outputDir2 : dir, name2 + ".jsx");
+    } else if (ext === ".vue") {
+      output2 = import_path.default.join(outputDir2 != null ? outputDir2 : dir, name2 + ".vue");
+    } else {
+      throw new Error(`Unknwon file extension ${input2}`);
     }
-    throw error;
-  });
+    return output2;
+  }
 }
 function printUsage() {
-  console.error(`Usage:
-  detype input.ts output.js
-  detype file.ts # Output to file.js
-  detype file.tsx # Output to file.jsx
-  detype file.ts output-dir # Output to output-dir/file.sjs
-  detype input-dir output-dir # Process recursively, rename .ts(x) as .js(x)`);
+  console.error(USAGE);
 }
+var USAGE = `Usage:
+
+  detype [-m | --remove-magic-comments] <INPUT> [OUTPUT]
+
+    INPUT   Input file or directory
+
+    OUTPUT  Output file or directory
+      (optional if it can be inferred and won't it overwrite the source file)
+
+    -m, --remove-magic-comments
+      Remove magic comments only, don't perform ts > js transform
+
+  detype [-v | --version]
+
+    Print version and exit
+
+  detype [-h | --help]
+
+    Print this help and exit`;
+var VERSION = package_default.version;
 
 // src/cli.ts
 var args = process.argv.slice(2);
-cli(args[0], args[1]).then((success) => process.exit(success ? 0 : 1));
+cli(...args).then((success) => process.exit(success ? 0 : 1));

package/dist/index.js

@@ -21,38 +21,38 @@ var __spreadValues = (a, b) => {
   return a;
 };
 var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
 var __export = (target, all) => {
-  __markAsModule(target);
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
 };
-var __reExport = (target, module2, desc) => {
-  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
-    for (let key of __getOwnPropNames(module2))
-      if (!__hasOwnProp.call(target, key) && key !== "default")
-        __defProp(target, key, { get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable });
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
   }
-  return target;
-};
-var __toModule = (module2) => {
-  return __reExport(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", module2 && module2.__esModule && "default" in module2 ? { get: () => module2.default, enumerable: true } : { value: module2, enumerable: true })), module2);
+  return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
-__export(exports, {
+var src_exports = {};
+__export(src_exports, {
   removeMagicComments: () => removeMagicComments,
+  removeMagicCommentsFromFile: () => removeMagicCommentsFromFile,
   transform: () => transform,
   transformFile: () => transformFile
 });
+module.exports = __toCommonJS(src_exports);
 
 // src/transform.ts
-var import_core = __toModule(require("@babel/core"));
-var import_prettier = __toModule(require("prettier"));
-var import_compiler_sfc = __toModule(require("@vuedx/compiler-sfc"));
-var import_template_ast_types = __toModule(require("@vuedx/template-ast-types"));
-var import_preset_typescript = __toModule(require("@babel/preset-typescript"));
-var import_string_prototype = __toModule(require("string.prototype.replaceall"));
+var import_core = require("@babel/core");
+var import_prettier = require("prettier");
+var import_compiler_sfc = require("@vuedx/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)();
 async function transform(code, fileName, prettierOptions) {
   var _a, _b, _c, _d;
@@ -122,7 +122,7 @@ async function removeTypesFromVueSfcScript(code, fileName, script, templateAst)
   if (script === null || script.lang !== "ts")
     return code;
   if (script.setup && templateAst) {
-    const expressions = new Set();
+    const expressions = /* @__PURE__ */ new Set();
     (0, import_template_ast_types.traverse)(templateAst, {
       enter(node) {
         if ((0, import_template_ast_types.isSimpleExpressionNode)(node) && !node.isStatic) {
@@ -171,34 +171,37 @@ function processMagicComments(input) {
   }
   return input;
 }
-function removeMagicComments(input) {
+function removeMagicComments(code, fileName, prettierOptions) {
   const REPLACE_COMMENT = "// @detype: replace\n";
   const WITH_COMMENT = "// @detype: with\n";
   const END_COMMENT = "// @detype: end\n";
-  let start = input.indexOf(REPLACE_COMMENT);
+  let start = code.indexOf(REPLACE_COMMENT);
   let startEnd = start + REPLACE_COMMENT.length;
   while (start >= 0) {
-    const middle = input.indexOf(WITH_COMMENT, start);
+    const middle = code.indexOf(WITH_COMMENT, start);
     if (middle < 0)
-      return input;
+      return code;
     const middleEnd = middle + WITH_COMMENT.length;
-    const end = input.indexOf(END_COMMENT, middleEnd);
+    const end = code.indexOf(END_COMMENT, middleEnd);
     if (end < 0)
-      return input;
+      return code;
     const endEnd = end + END_COMMENT.length;
-    const before = input.slice(0, start);
-    const keptText = input.slice(startEnd, middle);
-    const after = input.slice(endEnd);
-    input = before + keptText + after;
-    start = input.indexOf(REPLACE_COMMENT, before.length + keptText.length);
+    const before = code.slice(0, start);
+    const keptText = code.slice(startEnd, middle);
+    const after = code.slice(endEnd);
+    code = before + keptText + after;
+    start = code.indexOf(REPLACE_COMMENT, before.length + keptText.length);
     startEnd = start + REPLACE_COMMENT.length;
   }
-  return input;
+  code = (0, import_prettier.format)(code, __spreadProps(__spreadValues({}, prettierOptions), {
+    filepath: fileName
+  }));
+  return code;
 }
 
 // src/transformFile.ts
-var import_fs = __toModule(require("fs"));
-var import_prettier2 = __toModule(require("prettier"));
+var import_fs = __toESM(require("fs"));
+var import_prettier2 = require("prettier");
 var { readFile, writeFile } = import_fs.default.promises;
 async function transformFile(inputFileName, outputFileName) {
   const code = await readFile(inputFileName, "utf-8");
@@ -206,9 +209,16 @@ async function transformFile(inputFileName, outputFileName) {
   const output = await transform(code, inputFileName, prettierConfig);
   await writeFile(outputFileName, output, "utf-8");
 }
+async function removeMagicCommentsFromFile(inputFileName, outputFileName) {
+  const code = await readFile(inputFileName, "utf-8");
+  const prettierConfig = await (0, import_prettier2.resolveConfig)(inputFileName);
+  const output = await removeMagicComments(code, inputFileName, prettierConfig);
+  await writeFile(outputFileName, output, "utf-8");
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   removeMagicComments,
+  removeMagicCommentsFromFile,
   transform,
   transformFile
 });

package/index.d.ts

@@ -5,7 +5,7 @@ export { PrettierOptions };
 /**
  * Transform TypeScript code into vanilla JavaScript without affecting the formatting
  * @param code            Source coude
- * @param fileName        File name for the source (useful for distinguishing between .ts and .tsx)
+ * @param fileName        File name for the source
  * @param prettierOptions Options to pass to prettier
  */
 export function transform(
@@ -26,6 +26,22 @@ export function transformFile(
 
 /**
  * Removes magic comments without performing the TS to JS transform
- * @param input
+ * @param code            Source coude
+ * @param fileName        File name for the source
+ * @param prettierOptions Options to pass to prettier
+ */
+export function removeMagicComments(
+	code: string,
+	fileName: string,
+	prettierOptions?: PrettierOptions | null,
+): string;
+
+/**
+ * Remove magic comments from the input file and write the output to another file
+ * @param inputFileName
+ * @param outputFileName
  */
-export function removeMagicComments(input: string): string;
+export function removeMagicCommentsFromFile(
+	inputFileName: string,
+	outputFileName: string,
+): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "detype",
-  "version": "0.3.5",
+  "version": "0.4.2",
   "description": "Removes TypeScript type annotations but keeps the formatting",
   "main": "dist/index.js",
   "bin": "detype.js",
@@ -12,34 +12,34 @@
     "index.d.ts"
   ],
   "dependencies": {
-    "@babel/core": "^7.15.8",
-    "@babel/preset-typescript": "^7.15.0",
+    "@babel/core": "^7.17.8",
+    "@babel/preset-typescript": "^7.16.7",
     "@vuedx/compiler-sfc": "^0.7.1",
     "@vuedx/template-ast-types": "^0.7.2",
-    "fast-glob": "^3.2.7",
-    "prettier": "^2.4.1",
+    "fast-glob": "^3.2.11",
+    "prettier": "^2.6.2",
     "string.prototype.replaceall": "^1.0.6"
   },
   "devDependencies": {
-    "@babel/traverse": "^7.15.4",
-    "@types/jest": "^27.0.2",
-    "@types/node": "12.12.6",
-    "@typescript-eslint/eslint-plugin": "^4.33.0",
-    "@typescript-eslint/parser": "^4.33.0",
-    "esbuild": "^0.13.4",
+    "@babel/traverse": "^7.17.3",
+    "@types/jest": "^27.4.1",
+    "@types/node": "17.0.23",
+    "@typescript-eslint/eslint-plugin": "^5.17.0",
+    "@typescript-eslint/parser": "^5.17.0",
+    "esbuild": "^0.14.31",
     "esbuild-jest": "^0.5.0",
-    "esbuild-node-externals": "^1.3.0",
-    "eslint": "^7.32.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-import-resolver-typescript": "^2.5.0",
-    "eslint-plugin-import": "^2.24.2",
+    "esbuild-node-externals": "^1.4.1",
+    "eslint": "^8.12.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-import-resolver-typescript": "^2.7.1",
+    "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-no-only-tests": "^2.6.0",
     "eslint-plugin-only-warn": "^1.0.3",
-    "eslint-plugin-ssr-friendly": "^1.0.5",
-    "jest": "^27.2.4",
+    "eslint-plugin-ssr-friendly": "^1.0.6",
+    "jest": "^27.5.1",
     "npm-run-all": "^4.1.5",
     "rimraf": "^3.0.2",
-    "typescript": "^4.4.3"
+    "typescript": "^4.6.3"
   },
   "repository": {
     "type": "git",
@@ -65,5 +65,6 @@
     "test:typecheck": "tsc -p tsconfig.json --noEmit",
     "test:lint": "eslint src --max-warnings 0",
     "format": "prettier . --write"
-  }
+  },
+  "readme": "# detype\n\n> Remove the types, keep the formatting\n\n```sh\nnpm i -g detype\n```\n\nSuppose you have a library that you want to provide usage examples for. **detype** can help you generate vanilla JavaScript samples from TypeScript samples automatically and remove the burden of maintaining two separate versions of what is essentially the same code.\n\nIt is a command line tool and a library that removes type annotations and other TypeScript specific syntax constructs and outputs vanilla JavaScript **without altering the source formatting** too much. It supports `.ts`, `.tsx`, as well as `.vue` files.\n\nIn other words, it turns this:\n\n```ts\nimport type { ParsedPath } from \"path\";\n\nlet x: string;\n\n// This comment should be kept\n\n// This comment should be deleted\n// Ditto for this\ninterface Foo {\n  // This should go too\n  bar: number;\n}\n\n// This comment should also be kept\nexport function bar(foo: Foo): Date {\n  return new Date();\n}\n```\n\ninto this:\n\n```js\nlet x;\n\n// This comment should be kept\n\n// This comment should also be kept\nexport function bar(foo) {\n  return new Date();\n}\n```\n\nThe output is very close to hand-written JavaScript, especially if you were already using Prettier for formatting.\n\n## Doesn't `tsc` already do that?\n\nThere are lots of tools for transpiling TypeScript into plain JavaScript (`tsc`, `babel`, `swc`, `esbuild`, `sucrase` etc.) but none of them is perfectly suitable for this specific use case. Most of them don't preserve the formatting at all. `sucrase` comes close, but it doesn't remove comments attached to TypeScript-only constructs.\n\n`detype` uses [Babel](https://babeljs.io/), a small Babel plugin to remove comments attached to TypeScript-only constructs, and [Prettier](https://prettier.io/) under the hood. For Vue files, it also uses the tools from the [VueDX project](https://github.com/vuedx/languagetools).\n\n## Magic comments\n\nSometimes you want the generated JavaScript to be slightly different than the TypeScript original. You can use the magic comments feature to achieve this:\n\nInput:\n\n```ts\n// @detype: replace\n// These two lines will be removed\nconsole.log(\"Hello from TypeScript\");\n// @detype: with\n// // Notice the double comments!\n// console.log(\"Hello from JavaScript\");\n// @detype: end\n```\n\nOutput:\n\n```js\n// Notice the double comments!\nconsole.log(\"Hello from JavaScript\");\n```\n\nIf you just want to remove the magic comments, you can use the `-m` CLI flag or the `removeMagicComments` function to generate uncluttered TypeScript like this:\n\n```ts\n// These two lines will be removed\nconsole.log(\"Hello from TypeScript\");\n```\n\n## System requirements\n\n`detype` requires Node version 12.22.7 or later.\n\n## CLI Usage\n\n```\ndetype [-m | --remove-magic-comments] <INPUT> [OUTPUT]\n\n  INPUT   Input file or directory\n\n  OUTPUT  Output file or directory\n    (optional if it can be inferred and it won't overwrite the source file)\n\n  -m, --remove-magic-comments\n    Remove magic comments only, don't perform ts > js transform\n\ndetype [-v | --version]\n\n  Print version and exit\n\ndetype [-h | --help]\n\n  Print this help and exit\n```\n\n## Node API\n\n```ts\n// Transform TypeScript code into vanilla JavaScript without affecting the formatting\nfunction transform(\n  // Source code\n  code: string,\n  // File name for the source\n  fileName: string,\n  // Options to pass to prettier\n  prettierOptions?: PrettierOptions | null,\n): Promise<string>;\n\n// Transform the input file and write the output to another file\nfunction transformFile(\n  inputFileName: string,\n  outputFileName: string,\n): Promise<void>;\n\n// Remove magic comments without performing the TS to JS transform\nexport function removeMagicComments(\n  // Source code\n  code: string,\n  // File name for the source\n  fileName: string,\n  // Options to pass to prettier\n  prettierOptions?: PrettierOptions | null,\n): string;\n\n// Remove magic comments from the input file and write the output to another file\nexport function removeMagicCommentsFromFile(\n  inputFileName: string,\n  outputFileName: string,\n): Promise<void>;\n```\n\n## Change log\n### 0.4\n- feature: CLI support for removing magic comments\n- chore: Improve documentation\n\n### 0.3\n- feature: Magic comments\n- feature: Expose type declarations\n- fix: Better empty line handling\n\n### 0.2\n- feature: for Vue single file components\n\n### 0.1\n- Initial release\n\n## Credits\nFatih Aygün, under MIT License"
 }