v2.0 - removes cpy and rimraf

Author: a7ul

README.md

@@ -18,7 +18,10 @@ You could try these too. They solve the same problem but using require hooks ins
 
 ## How does it work?
 
-esbuild-node-tsc reads the tsconfig.json and builds the typescript project using esbuild. esbuild is the fastest typescript builder around. It also copies the non ts files such as json, graphql files, images,etc to the dist folder. If the assets are not copied correctly check the configuration guide below.
+esbuild-node-tsc reads the tsconfig.json and builds the typescript project using esbuild. esbuild is the fastest typescript builder around.
+The purpose of this library is to read tsconfig and translate the options to esbuild.
+
+You can also perform custom postbuild and prebuild operations like copying non ts files such as json, graphql files, images,etc to the dist folder or cleaning up build folder.
 
 ## Installation
 
@@ -63,7 +66,7 @@ Since esbuild can build large typescript projects in subsecond speeds you can us
 To achieve live reloading:
 
 ```
-npm install --save-dev nodemon esbuild-node-tsc
+npm install --save-dev nodemon esbuild-node-tsc esbuild
 ```
 
 Then add the following script to package.json
@@ -100,50 +103,43 @@ npm run dev
 
 <img src="https://user-images.githubusercontent.com/4029423/94347242-c6497600-0032-11eb-8a66-4311adf04554.gif" width="638" height="750">
 
+## v2.0 Migration and Breaking changes 🌱
+
+In v2.0, esbuild-node-tsc no longer has cpy and rimraf preinstalled and doesnt perform any non source file copying automatically.
+Instead it exposes prebuild and postbuild hooks which can be used to perform custom operations. See the example below for more details.
+
 ## Optional configuration
 
 By default esbuild-node-tsc should work out of the box for your project since it reads the necessary configuration from your tsconfig.json
 
 But if things are not working as expected you can configure esbuild-node-tsc by adding `etsc.config.js` along side tsconfig.json.
 
-> You might need to install `esbuild-plugin-tsc` package too to use the esbuild tsc plugin
-
 Example `etsc.config.js`
 
 ```js
-const esbuildPluginTsc = require("esbuild-plugin-tsc");
-
 module.exports = {
-  outDir: "./dist",
+  // Supports all esbuild.build options
   esbuild: {
     minify: false,
     target: "es2015",
-    plugins: [esbuildPluginTsc()],
-  },
-  assets: {
-    baseDir: "src",
-    outDir: "./dist",
-    filePatterns: ["**/*.json"],
   },
-};
-```
-
-or if you use ESM in your project then use
-
-```js
-import esbuildPluginTsc from "esbuild-plugin-tsc";
-
-export default {
-  outDir: "./dist",
-  esbuild: {
-    minify: false,
-    target: "es2015",
-    plugins: [esbuildPluginTsc()],
+  // Prebuild hook
+  prebuild: async () => {
+    console.log("prebuild");
+    const rimraf = (await import("rimraf")).default;
+    rimraf.sync("./dist"); // clean up dist folder
   },
-  assets: {
-    baseDir: "src",
-    outDir: "./dist",
-    filePatterns: ["**/*.json"],
+  // Postbuild hook
+  postbuild: async () => {
+    console.log("postbuild");
+    const cpy = (await import("cpy")).default;
+    await cpy(
+      [
+        "src/**/*.graphql", // Copy all .graphql files
+        "!src/**/*.{tsx,ts,js,jsx}", // Ignore already built files
+      ],
+      "dist"
+    );
   },
 };
 ```

package.json

@@ -1,7 +1,7 @@
 {
   "name": "esbuild-node-tsc",
   "description": "Build your Typescript Node.js projects using blazing fast esbuild",
-  "version": "1.8.9",
+  "version": "2.0.0",
   "main": "./dist/index.js",
   "bin": {
     "esbuild-node-tsc": "dist/index.js",
@@ -24,14 +24,11 @@
   ],
   "devDependencies": {
     "@types/node": "^18.7.3",
-    "@types/rimraf": "^3.0.2",
     "@types/yargs": "^17.0.11",
     "esbuild": "^0.15.2",
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "cpy": "^9.0.1",
-    "rimraf": "^3.0.2",
     "yargs": "^17.5.1"
   },
   "peerDependencies": {

src/config.ts

@@ -1,22 +1,22 @@
 import fs from "fs";
-import type { BuildOptions as EsBuildOptions, Plugin } from "esbuild";
+import type { BuildOptions as EsBuildOptions } from "esbuild";
 
 export type Config = Partial<{
-  outDir: string;
-  clean?: boolean;
   tsConfigFile?: string;
   esbuild: EsBuildOptions;
-  assets: {
-    baseDir?: string;
-    outDir?: string;
-    filePatterns?: string[];
-  };
+  prebuild: () => Promise<void>;
+  postbuild: () => Promise<void>;
 }>;
 
 export async function readUserConfig(configPath: string): Promise<Config> {
   if (fs.existsSync(configPath)) {
     try {
       const { default: config } = await import(configPath);
+      if (config.outDir) {
+        console.warn(
+          "Your etsc config file is using the old v1.0 format. Please update to the new v2.0 format. Check https://github.com/a7ul/esbuild-node-tsc for details."
+        );
+      }
       return config;
     } catch (e) {
       console.log("Config file has some errors:");

src/index.ts

@@ -1,10 +1,8 @@
 #!/usr/bin/env node
 
 import ts from "typescript";
-import { build, BuildOptions as EsBuildOptions } from "esbuild";
-import cpy from "cpy";
+import { build } from "esbuild";
 import path from "path";
-import rimraf from "rimraf";
 import yargs from "yargs/yargs";
 import { hideBin } from "yargs/helpers";
 import { Config, readUserConfig } from "./config.js";
@@ -56,82 +54,52 @@ function esBuildSourceMapOptions(tsConfig: TSConfig) {
   return sourceMap;
 }
 
-function getBuildMetadata(userConfig: Config) {
+function getEsbuildMetadata(userConfig: Config) {
   const { tsConfig, tsConfigFile } = getTSConfig(userConfig.tsConfigFile);
   const esbuildConfig = userConfig.esbuild || {};
 
-  const outDir =
-    userConfig.outDir ||
-    tsConfig.options.outDir ||
-    esbuildConfig.outdir ||
-    "dist";
-
+  const outdir = tsConfig.options.outDir || esbuildConfig.outdir || "dist";
   const srcFiles = [
     ...tsConfig.fileNames,
     ...((esbuildConfig.entryPoints as string[]) ?? []),
   ];
   const sourcemap =
     esBuildSourceMapOptions(tsConfig) || userConfig.esbuild?.sourcemap;
-  const target =
+  const target: string =
     tsConfig?.raw?.compilerOptions?.target || esbuildConfig?.target || "es2015";
-  const format = esbuildConfig?.format || "cjs";
 
-  const esbuildOptions: EsBuildOptions = {
+  const esbuildOptions = {
     ...userConfig.esbuild,
-    outdir: outDir,
+    outdir,
     entryPoints: srcFiles,
     sourcemap,
-    target,
+    target: target.toLowerCase(),
     tsconfig: tsConfigFile,
-    format,
   };
 
-  const assetPatterns = userConfig.assets?.filePatterns || ["**"];
+  return { esbuildOptions };
+}
 
-  const assetsOptions = {
-    baseDir: userConfig.assets?.baseDir || "src",
-    outDir: userConfig.assets?.outDir || outDir,
-    patterns: [...assetPatterns, "!**/*.{ts,js,tsx,jsx}"],
-  };
+async function main() {
+  const configFilename = <string>(await argv)?.config || "etsc.config.js";
+  const config = await readUserConfig(path.resolve(cwd, configFilename));
 
-  return { outDir, esbuildOptions, assetsOptions };
-}
+  const { esbuildOptions } = getEsbuildMetadata(config);
 
-async function buildSourceFiles(esbuildOptions: EsBuildOptions) {
-  return await build({
+  if (config.prebuild) {
+    await config.prebuild();
+  }
+
+  await build({
     bundle: false,
     format: "cjs",
     platform: "node",
     ...esbuildOptions,
   });
-}
 
-type AssetsOptions = { baseDir: string; outDir: string; patterns: string[] };
-
-async function copyNonSourceFiles({
-  baseDir,
-  outDir,
-  patterns,
-}: AssetsOptions) {
-  const relativeOutDir = path.relative(baseDir, outDir);
-  return await cpy(patterns, relativeOutDir, { cwd: baseDir });
-}
-
-async function main() {
-  const configFilename = <string>(await argv)?.config || "etsc.config.js";
-  const clean = (await argv)?.clean;
-  const config = await readUserConfig(path.resolve(cwd, configFilename));
-
-  const { outDir, esbuildOptions, assetsOptions } = getBuildMetadata(config);
-
-  if (clean) {
-    rimraf.sync(outDir);
+  if (config.postbuild) {
+    await config.postbuild();
   }
-
-  await Promise.all([
-    buildSourceFiles(esbuildOptions),
-    copyNonSourceFiles(assetsOptions),
-  ]);
 }
 
 console.time("Built in");