@tochii/build 1.0.0 → 1.0.3

package/README.md

@@ -0,0 +1,88 @@
+# @tochi/build
+
+This package provides a CLI for bundling your projects optionally with **no config** in Node.js with extended features like **configuration file** generation.
+
+## Why make this?
+
+I once permanently deleted my entire project when attempting to build a single file with the output directory as my project directory, and I hadn't pushed my progress to github for more than 1 week (no need to tell me...) which almost resulted in despair. I forgot to uncheck the `clean` option that cleans the entire output directory before the build process begins.
+
+How did I forgot to uncheck that critical option? Well my project had multiple config files for different purposes, so I just copied an existing config file instead of manually creating a new one.
+
+Luckily I was able to get my files back by building a script [@tochii/vscode-file-recovery](https://www.npmjs.com/package/@tochii/vscode-file-recovery) to restore the entire project while maintaining the folder structure.
+
+I wished that there were a safer way to define the options in a bundler config file, so I created some utilities with typesafety that requires the developer to be more aware of critical options such as the `clean` option.
+
+Other than that, the utilities eliminates redundant actions such as:
+- Manually creating a config file for each project/package/file to be built.
+- Removes the need to copy/paste an existing config file and will automatically disable critical options that could lead to unwanted results.
+
+## Utilities
+
+#### NodeBundlerUtils
+
+This class provides several utilities when using the `node` bundler such as:
+- Only bundle entry files (eg. index.js|ts)
+- Automatically bundle common files (eg. any files ending with .js or .ts)
+- Ignore commonly ignored files and folders (eg. node_modules, .d.ts definition files)
+- And more...
+
+## CLI Usage
+
+You can use the CLI by running the following command:
+
+```bash
+tochibuild <command>
+```
+
+### Commands
+
+#### node
+
+```bash
+tochibuild node [...args]
+```
+
+- Uses `tsup` under the hood which is powered by `esbuild`.
+- the passed **...args** are compatible with `tsup` (https://tsup.egoist.dev/#usage)
+
+#### config
+
+```bash
+tochibuild config [options] <bundler>
+```
+
+Quickly generate a configuration file for the specified bundler
+
+#### config options
+
+`--ext <string>`
+
+the file extension to use (defaults to the common one for the bundler)
+
+```bash
+tochibuild config --ext .ts node
+```
+
+`-f <string> or --file <string>`
+
+the file name to use excluding the file extension (defaults to the common one for the bundler)
+
+```bash
+tochibuild config -f tsup.config node
+```
+
+`-o or --overwrite`
+
+whether to overwrite the config file if it already exists (defaults to false)
+
+```bash
+tochibuild config -o node
+```
+
+### Bundlers
+
+These are the only available bundlers for now.
+
+**node**
+- Uses tsup under the hood (https://tsup.egoist.dev) which is powered by esbuild
+- Supports both javascript and typescript eg. `.js`, `.json`, `.mjs`, `.ts` and `tsx`. CSS support is experimental.

package/dist/chunk-LTYPVCKJ.mjs

@@ -0,0 +1 @@
+import{b as t}from"./chunk-QFYOHOZF.mjs";import{defineConfig as n}from"tsup";var p={Utils:t,defineConfigTsup:n,defineConfig:o,defineConfigIndexEntries:i,defineConfigCommonEntrie:r};function o(...e){return n(t.defaultOptions(...e))}function i(...e){return n(t.defaultOptionsIndexEntries(...e))}function r(...e){return n(t.defaultOptionsCommonEntries(...e))}export{n as a,p as b,o as c,i as d,r as e};

package/dist/chunk-QFYOHOZF.mjs

@@ -0,0 +1 @@
+var t=class t{};t.ignoredEntries=["!node_modules","!**/*/node_modules","!*.d.ts","!**/*/*.d.ts","!tsup.config*","!**/*/tsup.config*"],t.entriesCommon=["*.js","*.ts","**/*/*.js","**/*/*.ts"],t.entriesIndex=["index.js","index.ts","**/*/index.js","**/*/index.ts"],t.defaultEntriesIndex=[...t.entriesIndex,...t.ignoredEntries],t.defaultEntriesCommon=[...t.entriesCommon,...t.ignoredEntries],t.defaultOptions=n=>({tsconfig:"tsconfig.json",dts:!0,format:["esm"],minify:!0,...n,entry:r(n.entry,"ignoredEntries")}),t.defaultOptionsIndexEntries=n=>({entry:r(n.entry,"defaultEntriesIndex"),tsconfig:"tsconfig.json",dts:!0,format:["esm"],minify:!0,...n}),t.defaultOptionsCommonEntries=n=>({entry:r(n.entry,"defaultEntriesCommon"),tsconfig:"tsconfig.json",dts:!0,format:["esm"],minify:!0,...n});var e=t,a=e;function r(i,n){if(Array.isArray(i))return[...i,...e[n]];let o={};return e[n].forEach(s=>o[s]=s),{...i,...o}}export{e as a,a as b};

package/dist/cli.mjs

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
-import s from"chalk";import f from"fs";import m from"path";import{Command as h}from"commander";import{spawn as b}from"child_process";var a={name:"@tochii/build",version:"1.0.0",description:"Tools for bundling your projects in Node.js",repository:"https://github.com/tochiResources/project/packages/build.git",license:"MIT",bin:{tochibuild:"./dist/cli.mjs"},scripts:{build:"tsup-node",dev:"tsx cli.ts"},dependencies:{chalk:"^5.4.1",commander:"^13.1.0"},devDependencies:{"@types/node":"^22.15.17",tsup:"^8.4.0",tsx:"^4.19.4",typescript:"^5.8.3"},engines:{node:">=18.17.0"},files:["dist"]};var u={node:"tsup-node"},d=s.cyan("tochibuild"),p=new h("tochibuild").name("tochibuild <command>").description("Tools for bundling your projects in Node.js").allowUnknownOption(!0).version(a.version);p.command("node").description("bundle a Node.js project using tsup (https://tsup.egoist.dev)").allowUnknownOption(!0).argument("[...args]","arguments to pass to tsup").action(async e=>y("node",e));p.command("config").description("generate config files for the selected bundler").argument("<bundler>","bundler to generate config for").option("--ext <string>","the file extension to use (defaults to the common one for the bundler)","").option("-f, --file <string>","the file name to use (defaults to the common one for the bundler)","").option("-o, --overwrite","whether to overwrite the config file if it already exists (defaults to false)",!1).action((e,n)=>w(e,n));p.parseAsync(process.argv);async function y(e,n){return new Promise((r,i)=>{try{console.log(d,`running ${s.magenta(e)}...`),setTimeout(()=>{let o=b(u[e],n,{stdio:"inherit",shell:!0,cwd:process.cwd(),env:process.env});o.on("exit",c=>{process.exit(c??1)}),process.on("SIGINT",()=>{i(),o.kill("SIGINT")}),process.on("SIGTERM",()=>{i(),o.kill("SIGTERM")}),r()},3e3)}catch(o){i(o)}})}function w(e,n){switch(u[e]){case"tsup-node":x(n);break}}function x(e){let n=process.cwd(),r=e.ext||".ts",i=e.file||"tsup.config",o=m.join(n,`${i}${r}`),c=f.existsSync(o);!e?.overwrite&&c&&(console.warn(d,s.yellow("the tsup config file already exists for this project.")),process.exit(1));let l="  ",t="";t+=`import build from '@tochii/build/node';
+import s from"chalk";import u from"fs";import m from"path";import{Command as h}from"commander";import{spawn as b}from"child_process";var a={name:"@tochii/build",version:"1.0.3",description:"Tools for bundling your projects in Node.js",repository:"https://github.com/tochiResources/project/packages/build.git",license:"MIT",bin:{tochibuild:"./dist/cli.mjs"},scripts:{build:"tsup-node",dev:"tsx cli.ts"},dependencies:{chalk:"^5.4.1",commander:"^13.1.0",tsup:"^8.4.0"},devDependencies:{"@tochii/build":"^1.0.1","@types/node":"^22.15.17",tsx:"^4.19.4",typescript:"^5.8.3"},engines:{node:">=18.17.0"},files:["dist"]};var f={node:"tsup-node"},d=s.cyan("tochibuild"),p=new h("tochibuild").name("tochibuild <command>").description("Tools for bundling your projects in Node.js").allowUnknownOption(!0).version(a.version);p.command("node").description("bundle a Node.js project using tsup (https://tsup.egoist.dev)").allowUnknownOption(!0).argument("[...args]","arguments to pass to tsup").action(async e=>y("node",e));p.command("config").description("generate config files for the selected bundler").argument("<bundler>","bundler to generate config for").option("--ext <string>","the file extension to use excluding the file extension (defaults to the common one for the bundler)","").option("-f, --file <string>","the file name to use (defaults to the common one for the bundler)","").option("-o, --overwrite","whether to overwrite the config file if it already exists (defaults to false)",!1).action((e,n)=>w(e,n));p.parseAsync(process.argv);async function y(e,n){return new Promise((r,i)=>{try{console.log(d,`running ${s.magenta(e)}...`),setTimeout(()=>{let o=b(`${f[e]}`,n,{stdio:"inherit",shell:!0,cwd:process.cwd(),env:process.env});o.on("exit",c=>{process.exit(c??1)}),process.on("SIGINT",()=>{i(),o.kill("SIGINT")}),process.on("SIGTERM",()=>{i(),o.kill("SIGTERM")}),r()},3e3)}catch(o){i(o)}})}function w(e,n){switch(f[e]){case"tsup-node":x(n);break}}function x(e){let n=process.cwd(),r=e.ext||".ts",i=e.file||"tsup.config",o=m.join(n,`${i}${r}`),c=u.existsSync(o);!e?.overwrite&&c&&(console.warn(d,s.yellow("the tsup config file already exists for this project.")),process.exit(1));let l="  ",t="";t+=`import build from '@tochii/build';
 
-`,t+=`export default build.defineConfig({
+`,t+=`export default build.node.defineConfig({
 `,t+=`${l}entry: ['index.ts'],
 `,t+=`${l}clean: false,
 `,t+=`${l}splitting: false,
 `,t+=`});
-`,f.writeFileSync(o,t),console.log(s.green(d,"the tsup config file has been created at:"),s.gray(o))}
+`,u.writeFileSync(o,t),console.log(s.green(d,"the tsup config file has been created at:"),s.gray(o))}

package/dist/index.d.mts

@@ -0,0 +1,16 @@
+import * as tsup from 'tsup';
+import { defineConfig, defineConfigIndexEntries, defineConfigCommonEntrie } from './node/index.mjs';
+export { default as node } from './node/index.mjs';
+import NodeBundlerUtils from './node/utils.mjs';
+
+declare const _default: {
+    node: {
+        Utils: typeof NodeBundlerUtils;
+        defineConfigTsup: (options: tsup.Options | tsup.Options[] | ((overrideOptions: tsup.Options) => tsup.Options | tsup.Options[] | Promise<tsup.Options | tsup.Options[]>)) => tsup.Options | tsup.Options[] | ((overrideOptions: tsup.Options) => tsup.Options | tsup.Options[] | Promise<tsup.Options | tsup.Options[]>);
+        defineConfig: typeof defineConfig;
+        defineConfigIndexEntries: typeof defineConfigIndexEntries;
+        defineConfigCommonEntrie: typeof defineConfigCommonEntrie;
+    };
+};
+
+export { _default as default };

package/dist/index.mjs

@@ -0,0 +1 @@
+import{b as o}from"./chunk-LTYPVCKJ.mjs";import"./chunk-QFYOHOZF.mjs";var r={node:o};export{r as default,o as node};

package/dist/node/index.d.mts

@@ -0,0 +1,38 @@
+import * as tsup from 'tsup';
+export { defineConfig as defineConfigTsup } from 'tsup';
+import NodeBundlerUtils from './utils.mjs';
+
+declare const _default: {
+    Utils: typeof NodeBundlerUtils;
+    defineConfigTsup: (options: tsup.Options | tsup.Options[] | ((overrideOptions: tsup.Options) => tsup.Options | tsup.Options[] | Promise<tsup.Options | tsup.Options[]>)) => tsup.Options | tsup.Options[] | ((overrideOptions: tsup.Options) => tsup.Options | tsup.Options[] | Promise<tsup.Options | tsup.Options[]>);
+    defineConfig: typeof defineConfig;
+    defineConfigIndexEntries: typeof defineConfigIndexEntries;
+    defineConfigCommonEntrie: typeof defineConfigCommonEntrie;
+};
+
+/**
+ * Define tsup configuration
+ *
+ * @default '{ tsconfig: "tsconfig.json", dts: true, format: ["esm"], minify: true, ...options }'
+ * @param options configuration for tsup with clean and splitting as required to avoid unintended behaviour
+ * @returns tsup configuration
+ */
+declare function defineConfig(...options: Parameters<(typeof NodeBundlerUtils)['defaultOptions']>): tsup.Options | tsup.Options[] | ((overrideOptions: tsup.Options) => tsup.Options | tsup.Options[] | Promise<tsup.Options | tsup.Options[]>);
+/**
+ * Define tsup configuration with index files as entry
+ *
+ * @default '{ entry: Utils.defaultEntriesCommon, tsconfig: "tsconfig.json", dts: true, format: ["esm"], minify: true, ...options }'
+ * @param options configuration for tsup with clean and splitting as required to avoid unintended behaviour
+ * @returns tsup configuration
+ */
+declare function defineConfigIndexEntries(...options: Parameters<(typeof NodeBundlerUtils)['defaultOptionsIndexEntries']>): tsup.Options | tsup.Options[] | ((overrideOptions: tsup.Options) => tsup.Options | tsup.Options[] | Promise<tsup.Options | tsup.Options[]>);
+/**
+ * Define tsup configuration with common files as entry
+ *
+ * @default '{ entry: Utils.defaultEntriesCommon, tsconfig: "tsconfig.json", dts: true, format: ["esm"], minify: true, ...options }'
+ * @param options configuration for tsup with clean and splitting as required to avoid unintended behaviour
+ * @returns tsup `Options`
+ */
+declare function defineConfigCommonEntrie(...options: Parameters<(typeof NodeBundlerUtils)['defaultOptionsCommonEntries']>): tsup.Options | tsup.Options[] | ((overrideOptions: tsup.Options) => tsup.Options | tsup.Options[] | Promise<tsup.Options | tsup.Options[]>);
+
+export { NodeBundlerUtils as Utils, _default as default, defineConfig, defineConfigCommonEntrie, defineConfigIndexEntries };

package/dist/node/index.mjs

@@ -0,0 +1 @@
+import{a as b,b as c,c as d,d as e,e as f}from"../chunk-LTYPVCKJ.mjs";import{b as a}from"../chunk-QFYOHOZF.mjs";export{a as Utils,c as default,d as defineConfig,f as defineConfigCommonEntrie,e as defineConfigIndexEntries,b as defineConfigTsup};

package/dist/node/utils.mjs

@@ -1 +1 @@
-var t=class t{};t.ignoredEntries=["!node_modules","!**/*/node_modules","!*.d.ts","!**/*/*.d.ts","!tsup.config*","!**/*/tsup.config*"],t.entriesCommon=["*.ts","**/*/*.ts"],t.entriesIndex=["index.ts","**/*/index.ts"],t.defaultEntriesIndex=[...t.entriesIndex,...t.ignoredEntries],t.defaultEntriesCommon=[...t.entriesCommon,...t.ignoredEntries],t.defaultOptions=n=>({tsconfig:"tsconfig.json",dts:!0,format:["esm"],minify:!0,...n,entry:s(n.entry,"ignoredEntries")}),t.defaultOptionsIndexEntries=n=>({entry:s(n.entry,"defaultEntriesIndex"),tsconfig:"tsconfig.json",dts:!0,format:["esm"],minify:!0,...n}),t.defaultOptionsCommonEntries=n=>({entry:s(n.entry,"defaultEntriesCommon"),tsconfig:"tsconfig.json",dts:!0,format:["esm"],minify:!0,...n});var e=t,a=e;function s(i,n){if(Array.isArray(i))return[...i,...e[n]];let r={};return e[n].forEach(o=>r[o]=o),{...i,...r}}export{e as NodeBundlerUtils,a as default};
+import{a,b}from"../chunk-QFYOHOZF.mjs";export{a as NodeBundlerUtils,b as default};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tochii/build",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "description": "Tools for bundling your projects in Node.js",
   "repository": "https://github.com/tochiResources/project/packages/build.git",
   "license": "MIT",
@@ -13,11 +13,12 @@
   },
   "dependencies": {
     "chalk": "^5.4.1",
-    "commander": "^13.1.0"
+    "commander": "^13.1.0",
+    "tsup": "^8.4.0"
   },
   "devDependencies": {
+    "@tochii/build": "^1.0.1",
     "@types/node": "^22.15.17",
-    "tsup": "^8.4.0",
     "tsx": "^4.19.4",
     "typescript": "^5.8.3"
   },