detype 0.4.2 → 0.5.0

package/README.md

@@ -22,13 +22,13 @@ let x: string;
 // This comment should be deleted
 // Ditto for this
 interface Foo {
-  // This should go too
-  bar: number;
+	// This should go too
+	bar: number;
 }
 
 // This comment should also be kept
 export function bar(foo: Foo): Date {
-  return new Date();
+	return new Date();
 }
 ```
 
@@ -41,7 +41,7 @@ let x;
 
 // This comment should also be kept
 export function bar(foo) {
-  return new Date();
+	return new Date();
 }
 ```
 
@@ -85,7 +85,7 @@ console.log("Hello from TypeScript");
 
 ## System requirements
 
-`detype` requires Node version 12.22.7 or later.
+`detype` requires Node version 14.19.3 or later.
 
 ## CLI Usage
 
@@ -114,52 +114,63 @@ detype [-h | --help]
 ```ts
 // Transform TypeScript code into vanilla JavaScript without affecting the formatting
 function transform(
-  // Source code
-  code: string,
-  // File name for the source
-  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,
+	// 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,
+	inputFileName: string,
+	outputFileName: string,
 ): Promise<void>;
 ```
 
 ## Change log
+
+### 0.5
+
+- BREAKING CHANGE: Drop support for Node 12
+- chore: Set up CI workflows
+
 ### 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
+
 - feature: for Vue single file components
 
 ### 0.1
+
 - Initial release
 
 ## Credits
-Fatih Aygün, under MIT License
+
+Fatih Aygün, under MIT License

package/dist/cli.js

@@ -212,56 +212,51 @@ var import_fast_glob = __toESM(require("fast-glob"));
 
 // package.json
 var name = "detype";
-var version = "0.4.2";
+var version = "0.5.0";
 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"
+  node: ">=14.19.3"
 };
 var scripts = {
-  prepublishOnly: "pnpm build",
-  build: "node build.mjs",
-  watch: "node build.mjs --watch",
+  prepack: "rimraf dist && pnpm build",
+  build: "tsup",
+  dev: "tsup --watch",
+  cq: "pnpm run test:typecheck && pnpm run test:lint && pnpm run test:prettier",
   test: "run-p 'test:*'",
-  "test:unit": "jest",
+  "test:unit": "vitest run",
   "test:typecheck": "tsc -p tsconfig.json --noEmit",
   "test:lint": "eslint src --max-warnings 0",
-  format: "prettier . --write"
+  "test:prettier": "prettier --check --ignore-path .gitignore --ignore-unknown . '!pnpm-lock.yaml'",
+  format: "prettier . --write --ignore-path .gitignore --ignore-unknown . '!pnpm-lock.yaml'"
 };
 var files = [
   "dist/**/*",
   "index.d.ts"
 ];
 var dependencies = {
-  "@babel/core": "^7.17.8",
-  "@babel/preset-typescript": "^7.16.7",
+  "@babel/core": "^7.18.2",
+  "@babel/preset-typescript": "^7.17.12",
   "@vuedx/compiler-sfc": "^0.7.1",
-  "@vuedx/template-ast-types": "^0.7.2",
+  "@vuedx/template-ast-types": "^0.7.3",
   "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",
+  "@babel/traverse": "^7.18.2",
+  "@cyco130/eslint-config": "^1.1.0",
+  "@types/babel__core": "^7.1.19",
+  "@types/babel__traverse": "^7.17.1",
+  "@types/node": "17.0.36",
+  "@types/prettier": "^2.6.3",
+  eslint: "^8.16.0",
   "npm-run-all": "^4.1.5",
   rimraf: "^3.0.2",
-  typescript: "^4.6.3"
+  tsup: "^6.0.1",
+  typescript: "^4.7.2",
+  vitest: "^0.13.0"
 };
 var repository = {
   type: "git",
@@ -301,7 +296,8 @@ var package_default = {
 // src/cli-lib.ts
 var { stat, mkdir } = import_fs2.default.promises;
 async function cli(...args2) {
-  let [flag, input, output] = args2;
+  const [flag] = args2;
+  let [, input, output] = args2;
   if (!flag || flag === "-h" || flag === "--help") {
     printUsage();
     return !!flag;
@@ -321,19 +317,19 @@ async function cli(...args2) {
       printUsage();
       return false;
     }
-    const files2 = (await (0, import_fast_glob.default)(import_path.default.join(input, "**/*.{ts,tsx,vue}"))).filter((file) => !file.endsWith(".d.ts"));
+    const files2 = (await (0, import_fast_glob.default)(unixify(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 });
+    await mkdir(import_path.default.normalize(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 mkdir(outDir, { recursive: true });
+      await mkdir(import_path.default.normalize(outDir), { recursive: true });
     }
     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));
-      removeMagic ? await removeMagicCommentsFromFile(file, outputName) : await transformFile(file, outputName);
+      removeMagic ? await removeMagicCommentsFromFile(import_path.default.normalize(file), import_path.default.normalize(outputName)) : await transformFile(import_path.default.normalize(file), import_path.default.normalize(outputName));
     }
     return true;
   }
@@ -360,21 +356,21 @@ async function cli(...args2) {
   }
   const outputDir = import_path.default.dirname(output);
   if (outputDir) {
-    await mkdir(outputDir, { recursive: true });
+    await mkdir(import_path.default.normalize(outputDir), { recursive: true });
   }
-  removeMagic ? await removeMagicCommentsFromFile(input, output) : await transformFile(input, output);
+  removeMagic ? await removeMagicCommentsFromFile(import_path.default.normalize(input), import_path.default.normalize(output)) : await transformFile(import_path.default.normalize(input), import_path.default.normalize(output));
   return true;
   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}`);
+      output2 = import_path.default.join(outputDir2 ?? dir, `${name2}${ext}`);
     } else if (ext === ".ts") {
-      output2 = import_path.default.join(outputDir2 != null ? outputDir2 : dir, name2 + ".js");
+      output2 = import_path.default.join(outputDir2 ?? dir, name2 + ".js");
     } else if (ext === ".tsx") {
-      output2 = import_path.default.join(outputDir2 != null ? outputDir2 : dir, name2 + ".jsx");
+      output2 = import_path.default.join(outputDir2 ?? dir, name2 + ".jsx");
     } else if (ext === ".vue") {
-      output2 = import_path.default.join(outputDir2 != null ? outputDir2 : dir, name2 + ".vue");
+      output2 = import_path.default.join(outputDir2 ?? dir, name2 + ".vue");
     } else {
       throw new Error(`Unknwon file extension ${input2}`);
     }
@@ -404,6 +400,9 @@ var USAGE = `Usage:
 
     Print this help and exit`;
 var VERSION = package_default.version;
+function unixify(name2) {
+  return name2.replaceAll(import_path.default.sep, "/");
+}
 
 // src/cli.ts
 var args = process.argv.slice(2);

package/dist/index.d.ts

@@ -0,0 +1,32 @@
+import { Options } from 'prettier';
+export { Options as PrettierOptions } from 'prettier';
+
+/**
+ * Transform TypeScript code into vanilla JavaScript without affecting the formatting
+ * @param code            Source coude
+ * @param fileName        File name for the source
+ * @param prettierOptions Options to pass to prettier
+ */
+declare function transform(code: string, fileName: string, prettierOptions?: Options | null): Promise<string>;
+/**
+ * Removes magic comments without performing the TS to JS transform
+ * @param code            Source coude
+ * @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;
+
+/**
+ * Transform the input file and write the output to another file
+ * @param inputFileName
+ * @param outputFileName
+ */
+declare function transformFile(inputFileName: string, outputFileName: string): Promise<void>;
+/**
+ * Remove magic comments from the input file and write the output to another file
+ * @param inputFileName
+ * @param outputFileName
+ */
+declare function removeMagicCommentsFromFile(inputFileName: string, outputFileName: string): Promise<void>;
+
+export { removeMagicComments, removeMagicCommentsFromFile, transform, transformFile };

package/index.d.ts

@@ -1,47 +1 @@
-import { Options as PrettierOptions } from "prettier";
-
-export { PrettierOptions };
-
-/**
- * Transform TypeScript code into vanilla JavaScript without affecting the formatting
- * @param code            Source coude
- * @param fileName        File name for the source
- * @param prettierOptions Options to pass to prettier
- */
-export function transform(
-	code: string,
-	fileName: string,
-	prettierOptions?: PrettierOptions | null | undefined,
-): Promise<string>;
-
-/**
- * Transform the input file and write the output to another file
- * @param inputFileName
- * @param outputFileName
- */
-export function transformFile(
-	inputFileName: string,
-	outputFileName: string,
-): Promise<void>;
-
-/**
- * Removes magic comments without performing the TS to JS transform
- * @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 removeMagicCommentsFromFile(
-	inputFileName: string,
-	outputFileName: string,
-): Promise<void>;
+export * from "./dist";

package/package.json

@@ -1,45 +1,38 @@
 {
   "name": "detype",
-  "version": "0.4.2",
+  "version": "0.5.0",
   "description": "Removes TypeScript type annotations but keeps the formatting",
   "main": "dist/index.js",
   "bin": "detype.js",
   "engines": {
-    "node": ">=12.22.7"
+    "node": ">=14.19.3"
   },
   "files": [
     "dist/**/*",
     "index.d.ts"
   ],
   "dependencies": {
-    "@babel/core": "^7.17.8",
-    "@babel/preset-typescript": "^7.16.7",
+    "@babel/core": "^7.18.2",
+    "@babel/preset-typescript": "^7.17.12",
     "@vuedx/compiler-sfc": "^0.7.1",
-    "@vuedx/template-ast-types": "^0.7.2",
+    "@vuedx/template-ast-types": "^0.7.3",
     "fast-glob": "^3.2.11",
     "prettier": "^2.6.2",
     "string.prototype.replaceall": "^1.0.6"
   },
   "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",
+    "@babel/traverse": "^7.18.2",
+    "@cyco130/eslint-config": "^1.1.0",
+    "@types/babel__core": "^7.1.19",
+    "@types/babel__traverse": "^7.17.1",
+    "@types/node": "17.0.36",
+    "@types/prettier": "^2.6.3",
+    "eslint": "^8.16.0",
     "npm-run-all": "^4.1.5",
     "rimraf": "^3.0.2",
-    "typescript": "^4.6.3"
+    "tsup": "^6.0.1",
+    "typescript": "^4.7.2",
+    "vitest": "^0.13.0"
   },
   "repository": {
     "type": "git",
@@ -58,13 +51,14 @@
   },
   "homepage": "https://github.com/cyco130/detype#readme",
   "scripts": {
-    "build": "node build.mjs",
-    "watch": "node build.mjs --watch",
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "cq": "pnpm run test:typecheck && pnpm run test:lint && pnpm run test:prettier",
     "test": "run-p 'test:*'",
-    "test:unit": "jest",
+    "test:unit": "vitest run",
     "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"
+    "test:prettier": "prettier --check --ignore-path .gitignore --ignore-unknown . '!pnpm-lock.yaml'",
+    "format": "prettier . --write --ignore-path .gitignore --ignore-unknown . '!pnpm-lock.yaml'"
+  }
 }