Adds readme and package json

Author: a7ul

README.md

@@ -0,0 +1,115 @@
+# ⚡️ esbuild-node-tsc
+
+Build your Typescript Node.js projects using blazing fast **[esbuild](https://github.com/evanw/esbuild)**.
+
+Since esbuild can build large typescript node projects in subsecond speeds, this is quite useful for development builds too if you want to stick with `tsc` for production builds.
+
+**_Please not this library doesnt do typechecking. For typechecking please continue to use tsc._**
+
+## 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.
+
+## Installation
+
+```
+npm install --save-dev esbuild-node-tsc
+```
+
+## Usage
+
+```
+npx esbuild-node-tsc
+```
+
+or use the short form.
+
+```
+npx etsc
+```
+
+Additionally, you can add it to your build scripts
+
+```json
+{
+  "name": "myproject",
+  "version": "0.1.0",
+  "scripts": {
+    "dev": "etsc" <------ Add etsc or esbuild-node-tsc
+  }
+}
+```
+
+Then just run
+
+```
+npm run dev
+```
+
+## Live reloading (nodemon ❤️ esbuild-node-tsc)
+
+Since esbuild can build large typescript projects in subsecond speeds you can use this library instead of ts-node-dev or ts-node which usually slow down when project scales.
+
+To achieve live reloading:
+
+```
+npm install --save-dev nodemon esbuild-node-tsc
+```
+
+Then add the following script to package.json
+
+```json
+{
+  "name": "myproject",
+  "version": "0.1.0",
+  "scripts": {
+    "dev": "nodemon"
+  }
+}
+```
+
+And add a `nodemon.json`
+
+```json
+{
+  "watch": ["src"],
+  "ignore": ["src/**/*.test.ts"],
+  "ext": "ts,mjs,js,json,graphql",
+  "exec": "etsc",
+  "legacyWatch": true
+}
+```
+
+Finally run
+
+```
+npm run dev
+```
+
+## 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.
+
+Example `etsc.config.js`
+
+```js
+module.exports = {
+  outDir: "./dist",
+  esbuild: {
+    minify: false,
+    target: "es2015",
+  },
+  assets: {
+    baseDir: "src",
+    filePatterns: ["**/*.json"],
+  },
+};
+```
+
+All of the above fields are optional
+
+## License
+
+MIT

package-lock.json

@@ -1,21 +1,35 @@
 {
-  "name": "esbuild-ts-node",
+  "name": "esbuild-node-tsc",
   "version": "1.0.0",
   "main": "./dist/index.js",
   "bin": {
-    "esbuild-ts-node": "./dist/index.js"
+    "esbuild-node-tsc": "./dist/index.js",
+    "etsc": "./dist/index.js"
   },
   "license": "MIT",
   "scripts": {
     "build": "tsc"
   },
+  "keywords": [
+    "esbuild",
+    "node",
+    "dev",
+    "tsnode",
+    "ts-node",
+    "tsc",
+    "typescript"
+  ],
   "devDependencies": {
     "@types/node": "^14.6.4",
+    "@types/rimraf": "^3.0.0",
     "typescript": "^4.0.2"
   },
   "dependencies": {
     "cpy": "^8.1.1",
     "esbuild": "^0.7.6",
     "rimraf": "^3.0.2"
+  },
+  "peerDependencies": {
+    "typescript": "*"
   }
 }

package.json

@@ -0,0 +1,21 @@
+export type Config = Partial<{
+  outDir: string;
+  esbuild: {
+    entryPoints?: string[];
+    minify?: boolean;
+    target?: string;
+  };
+  assets: {
+    baseDir?: string;
+    filePatterns?: string[];
+  };
+}>;
+
+export async function readUserConfig(configPath: string): Promise<Config> {
+  try {
+    return require(configPath);
+  } catch (err) {
+    // Ignore the read error
+  }
+  return {};
+}

src/config.ts

@@ -1,99 +1,55 @@
 #!/usr/bin/env node
+
 import ts, { BuildOptions } from "typescript";
 import { build } from "esbuild";
 import cpy from "cpy";
 import path from "path";
-//@ts-ignore
 import rimraf from "rimraf";
+import { Config, readUserConfig } from "./config";
 
-const config: Config = {
-  outDir: "dist",
-  esbuild: {
-    entryPoints: [] as string[],
-    minify: false,
-    target: "es2015",
-  },
-  assets: {
-    baseDir: "src",
-    filePatterns: ["**", `!**/*.{ts,js,tsx,jsx}`],
-  },
-};
-
-type Config = {
-  outDir?: string;
-  esbuild?: {
-    entryPoints?: string[];
-    minify?: boolean;
-    target?: string;
-  };
-  assets?: {
-    baseDir?: string;
-    filePatterns?: string[];
-  };
-};
+const cwd = process.cwd();
 
 function getTSConfig() {
   const tsConfigFile = ts.findConfigFile(
-    process.cwd(),
+    cwd,
     ts.sys.fileExists,
     "tsconfig.json"
   );
-  const configFile = ts.readConfigFile(tsConfigFile!, ts.sys.readFile);
+  if (!tsConfigFile) {
+    throw new Error(`tsconfig.json not found in the current directory! ${cwd}`);
+  }
+  const configFile = ts.readConfigFile(tsConfigFile, ts.sys.readFile);
   const tsConfig = ts.parseJsonConfigFileContent(
     configFile.config,
     ts.sys,
-    process.cwd()
+    cwd
   );
   return { tsConfig, tsConfigFile };
 }
 
 type TSConfig = ReturnType<typeof getTSConfig>["tsConfig"];
 
 function esBuildSourceMapOptions(tsConfig: TSConfig) {
-  let sourcemap = tsConfig.options.sourceMap;
-  if (!sourcemap) {
+  if (!tsConfig.options.sourceMap) {
     return false;
   }
-  if (tsConfig.options.inlineSourceMap) {
-    return "inline";
-  }
-  return "external";
-}
-
-async function buildSourceFiles(esbuildOptions: Partial<BuildOptions>) {
-  return await build({
-    ...esbuildOptions,
-    bundle: false,
-    format: "cjs",
-    platform: "node",
-  });
-}
-
-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,
-    parents: true,
-  });
+  return tsConfig.options.inlineSourceMap ? "inline" : "external";
 }
 
 function getBuildMetadata(userConfig: Config) {
   const { tsConfig, tsConfigFile } = getTSConfig();
 
-  const outDir = tsConfig.options.outDir || config.outDir || "dist";
+  const outDir = tsConfig.options.outDir || userConfig.outDir || "dist";
 
   const esbuildEntryPoints = userConfig.esbuild?.entryPoints || [];
   const srcFiles = [...tsConfig.fileNames, ...esbuildEntryPoints];
   const sourcemap = esBuildSourceMapOptions(tsConfig);
   const target =
-    config.esbuild?.target || tsConfig?.raw?.compilerOptions?.target || "es6";
-  const minify = config.esbuild?.minify || false;
+    userConfig.esbuild?.target ||
+    tsConfig?.raw?.compilerOptions?.target ||
+    "es6";
+
+  const minify = userConfig.esbuild?.minify || false;
 
   const esbuildOptions: BuildOptions = {
     outdir: outDir,
@@ -104,20 +60,45 @@ function getBuildMetadata(userConfig: Config) {
     tsconfig: tsConfigFile,
   };
 
+  const assetPatterns = userConfig.assets?.filePatterns || ["**"];
+
   const assetsOptions = {
     baseDir: userConfig.assets?.baseDir || "src",
     outDir: outDir,
-    patterns: userConfig.assets?.filePatterns || [
-      "**",
-      `!**/*.{ts,js,tsx,jsx}`,
-    ],
+    patterns: [...assetPatterns, `!**/*.{ts,js,tsx,jsx}`],
   };
 
   return { outDir, esbuildOptions, assetsOptions };
 }
 
+async function buildSourceFiles(esbuildOptions: Partial<BuildOptions>) {
+  return await build({
+    ...esbuildOptions,
+    bundle: false,
+    format: "cjs",
+    platform: "node",
+  });
+}
+
+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,
+    parents: true,
+  });
+}
+
 async function main() {
+  const config = await readUserConfig(path.resolve(cwd, "etsc.config.js"));
+
   const { outDir, esbuildOptions, assetsOptions } = getBuildMetadata(config);
+
   rimraf.sync(outDir);
 
   await Promise.all([