feat: 🌟 typegen utils (incomplete)

- add detail to build output
- add watch mode to rebuild
- add test package with linked deps

Author: timkinnane

.gitignore

@@ -2,3 +2,5 @@ node_modules
 yarn.lock
 yarn-error.log
 coverage
+dist
+!test/package/node_modules

README.md

@@ -1,23 +1,47 @@
-Centralised config of dev tooling for Nested Code packages.
+Centralised tooling config for Nested Code packages.
 
 ---
 
-The goal for this project is to support simple and consistent package config across a variety of
-platforms and interfaces (CLIs, Node/Deno, browser).
+The goal of this project is to support modern, minimal and consistent project scaffolding and
+configuration for a variety of environments and targets (CLIs, Node/Deno, browser).
 
-One choice I've made to achieve that is to publish exclusively as ES modules (mostly using
-Typescript, for Node 14). Narrowing support to ESM (not publishing Common JS) supports not just
-simplicity but a forward looking JS ecosystem.
+### Entry Points
+
+Distinct bundles can be imported from sub-paths, to be implemented as either:
+- **Providers**: where the consumer will have a tool as a dependency and Cogs provides its config.
+- **Runners**: where the dependency is not required, Cogs both configures and execute the tool.
 
-[Start here if you're wondering why or how to support ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
+Current bundles:
+- Jest Provider: `@nested-code/cogs/jest`
+- ESBuild Runner: `@nested-code/cogs/esbuild`
+- Utils: `@nested-code/cogs/utils` supports interfaces of other bundles.
 
-### Configs
+### Features
 
-- [ ] ESBuild script to:
+- [ ] ESBuild
   - [ ] Lint
   - [ ] Build and bundle
   - [ ] Write type definitions
   - [ ] Update package exports
 - [ ] TSConfig
 - [ ] ESLint config
 - [ ] Jest config
+
+# ES Modules
+
+One choice I've made to achieve that is to publish exclusively as ES modules (mostly using
+Typescript, for Node 14). Narrowing support to ESM (not publishing Common JS) supports not just
+simplicity but a forward looking JS ecosystem.
+
+[Start here if you're wondering why or how to support
+ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
+
+# Learnings
+
+Typescript ES Modules require imports to specify `.js` extensions. Some compilers will handle a
+missing extension and infer the path to a matching TS file (tsc) while others use plugins to rewrite
+paths (esbuild), but executing directly (ts-node) will still fail.
+
+To overcome this, imports in TS files can use `.js` extension (which is a bit off for my liking)
+but there's also an experimental flag `--experimental-specifier-resolution node` that allows no
+extension to be given in TS files for importing other TS files.

bin/build.ts

@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+
+import { resolve } from 'path'
+import esbuild from '../src/esbuild'
+import utils from '../src/utils'
+
+console.log(`\n🔨 Building Cogs...`)
+
+const config = esbuild.config({
+  external: utils.readDependencies(resolve()),
+  entryPoints: [
+    'src/esbuild/index.ts',
+    'src/jest/index.ts',
+    'src/utils/index.ts'
+  ],
+  
+})
+
+utils.clearPath(config.outdir)
+esbuild.build(config).then(() => {
+  utils.typegen(config.entryPoints)
+})

esbuild-runner.config.mjs

@@ -1,14 +1,16 @@
 {
   "name": "@nested-code/cogs",
   "version": "0.0.1",
-  "description": "Centralised config of dev tooling for Nested Code packages.",
+  "description": "Centralised tooling config for Nested Code packages.",
   "repository": "https://github.com/nested-code/cogs",
   "author": "Tim Kinnane <[email protected]>",
   "license": "MIT",
   "private": "false",
   "type": "module",
   "scripts": {
-    "test": "jest --collectCoverage"
+    "test": "jest --collectCoverage",
+    "test:dist": "cd test/package && yarn test",
+    "build": "node --no-warnings --experimental-specifier-resolution node --loader ts-node/esm bin/build.ts"
   },
   "dependencies": {
     "@types/node": "14",
@@ -26,9 +28,12 @@
     "ts-node": "^10.4.0",
     "typescript": "^4.5.4"
   },
+  "files": [
+    "dist"
+  ],
   "exports": {
-    "import": "./esm/index.mjs",
-    "types": "./dist/index.d.ts",
-    "utils": "./dist/utils/index.mjs"
+    "./jest": {
+      "import": "./dist/jest/index.js"
+    }
   }
 }

package.json

@@ -0,0 +1,21 @@
+import { build as _build, analyzeMetafile, BuildOptions } from 'esbuild'
+
+const watch = process.argv.includes('--watch') || process.argv.includes('-w')
+
+/** Build project with Esbuild. */
+export const build = async (opts: BuildOptions = {}) =>
+  _build({
+    watch: watch
+      ? {
+        onRebuild: (error, result) => error
+          ? console.error('👀❎ Watch build failed:', error)
+          : analyzeMetafile(result!.metafile!).then(
+            (meta) => console.log('👀✅ Watch build succeeded', meta)
+          )
+        }
+      : false,
+     ...opts
+    })
+    .then(({ metafile }) => analyzeMetafile(metafile!))
+    .then(console.log)
+    .catch(_ => process.exit(1))

src/esbuild/build.ts

@@ -0,0 +1,18 @@
+import { BuildOptions } from 'esbuild'
+
+export type EntryBuildOptions = BuildOptions & Pick<Required<BuildOptions>, 'entryPoints'>
+
+export const defaults: Partial<BuildOptions> = {
+  minify: false,
+  sourcemap: true,
+  format: 'esm',
+  platform: 'node',
+  target: 'node14',
+  outdir: 'dist',
+  bundle: true,
+  metafile: true
+}
+
+/** Generate ESbuild config, finding dependencies from package. */
+export const config = (opts: EntryBuildOptions) =>
+  ({ ...defaults, ...opts })

src/esbuild/config.ts

@@ -0,0 +1,9 @@
+import * as config from './config'
+import * as build from './build'
+
+export const esbuild = {
+  ...config,
+  ...build
+}
+
+export default esbuild

src/esbuild/index.ts

@@ -1,7 +1,7 @@
-import * as config from './config'
+import * as cfg from './config'
 
 export const jest = {
-  ...config
+  ...cfg
 }
 
 export default jest

src/jest/index.ts

@@ -0,0 +1,7 @@
+import { rmdirSync, mkdirSync } from 'fs'
+
+export const clearPath = (path?: string) => {
+  if (!path) return
+  rmdirSync(path, { recursive: true })
+  mkdirSync(path)
+}