esm.dev 1.5.3 → 1.6.0

package/README.md

@@ -6,48 +6,23 @@ It expects you to have a local version of ESM.sh and verdaccio running. It will
 
 ## Usage
 
-The simplest solution is to use docker-compose. Using the configuration below:
+### Prerequisites
 
-`docker compose up`
+- You have [docker](https://www.docker.com/) installed
+- You have [docker compose](https://docs.docker.com/compose/) installed
+- You have a JavaScript runtime installed ([Node.js](https://nodejs.org/), [Deno](https://deno.com/), [Bun](https://bun.sh/) etc)
 
-```yaml
-services:
-  esm.dev:
-    image: ghcr.io/johngeorgewright/esm.dev:latest
-    depends_on:
-      - esm.sh
-      - npm
-    environment:
-      - NPM_REGISTRY=http://npm:4873
-      - ESM_ORIGIN=http://esm.sh:8080
-      - ESM_STORAGE_PATH=/esmd
-      - PORT=3000
-    command:
-      - start
-      - /watch/*
-    ports:
-      - '3000:3000'
-    volumes:
-      - ./docker-storage/esm/esmd:/esmd
-      # The following are paths to all the packages you wish to auto publish
-      - ./packages/package-1:/watch/package-1:ro
-      - ./packages/package-2:/watch/package-2:ro
+### Installation
 
-  esm.sh:
-    image: ghcr.io/esm-dev/esm.sh:latest
-    environment:
-      - NPM_REGISTRY=http://npm:4873
-      - NPM_TOKEN=fake
-      - LOG_LEVEL=debug
-    ports:
-      - '8080:8080'
-    volumes:
-      - ./docker-storage/esm/esmd:/esmd
+```bash
+# Node.js
+npx esm.dev init ./packages/my-local-package-1 ./packages/my-local-package-2 ...
+```
+
+This will create a docker-compose file in your cwd. Now run it:
 
-  npm:
-    image: verdaccio/verdaccio:latest
-    ports:
-      - '4873:4873'
+```bash
+docker compose up
 ```
 
 Once the above is running point your ESM modules to `localhost:3000`:

package/dist/cli.js

@@ -7,12 +7,14 @@ import { TokenCommand } from './commands/TokenCommand.js';
 import { WaitForRegistryCommand } from './commands/WaitForRegistryCommand.js';
 import { StartCommand } from './commands/StartCommand.js';
 import { InitCommand } from './commands/InitCommand.js';
+import { VersionCommand } from './commands/VersionCommand.js';
 runExit([
     InitCommand,
     LoginCommand,
     TokenCommand,
     RepublishCommand,
     StartCommand,
+    VersionCommand,
     WaitForRegistryCommand,
     WatchCommand,
 ]);

package/dist/commands/InitCommand.js

@@ -35,6 +35,7 @@ export class InitCommand extends PackagePathSpecific(MustacheGeneratorCommand) {
             path: packagePath,
             basename: path.basename(packagePath),
         }));
+        await this.removeDestinationFile('docker-compose.yaml', 'docker-compose.yml.mustache');
         await super.execute();
     }
 }

package/dist/commands/VersionCommand.js

@@ -0,0 +1,12 @@
+import { Command } from 'clipanion';
+export class VersionCommand extends Command {
+    static paths = [['version']];
+    static usage = Command.Usage({
+        description: 'Display the version of esm.dev',
+    });
+    async execute() {
+        const path = await import('node:path');
+        const pckg = await Bun.file(path.resolve(import.meta.dirname, '..', '..', 'package.json')).json();
+        this.context.stdout.write(`${pckg.version}\n`);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "esm.dev",
-  "version": "1.5.3",
+  "version": "1.6.0",
   "description": "TypeScript library template",
   "type": "module",
   "sideEffects": false,
@@ -11,7 +11,8 @@
     "esm.dev": "./dist/cli.js"
   },
   "scripts": {
-    "build": "tsc",
+    "build": "bun run clean && tsc",
+    "clean": "rimraf dist",
     "esm.dev": "bun ./src/cli.ts",
     "prepare": "husky",
     "start": "docker compose up --detach --remove-orphans",
@@ -41,7 +42,7 @@
     "lint-staged": "16.0.0",
     "prettier": "3.5.3",
     "rimraf": "6.0.1",
-    "semantic-release": "^24.2.3",
+    "semantic-release": "^24.2.4",
     "typescript": "5.8.3"
   },
   "lint-staged": {
@@ -51,16 +52,16 @@
   },
   "dependencies": {
     "clipanion": "^4.0.0-rc.4",
-    "clipanion-generator-command": "^1.2.0",
+    "clipanion-generator-command": "^1.3.0",
     "escape-string-regexp": "^5.0.0",
     "glob": "^11.0.2",
     "http-proxy": "^1.18.1",
     "lodash.debounce": "^4.0.8",
     "mustache": "^4.2.0",
-    "npm": "^11.3.0",
+    "npm": "^11.4.0",
     "ramda": "^0.30.1",
     "throat": "^6.0.2",
     "tslib": "^2.8.1",
-    "zod": "^3.24.4"
+    "zod": "^3.25.13"
   }
 }

package/src/cli.ts

@@ -7,6 +7,7 @@ import { TokenCommand } from './commands/TokenCommand.js'
 import { WaitForRegistryCommand } from './commands/WaitForRegistryCommand.js'
 import { StartCommand } from './commands/StartCommand.js'
 import { InitCommand } from './commands/InitCommand.js'
+import { VersionCommand } from './commands/VersionCommand.js'
 
 runExit([
   InitCommand,
@@ -14,6 +15,7 @@ runExit([
   TokenCommand,
   RepublishCommand,
   StartCommand,
+  VersionCommand,
   WaitForRegistryCommand,
   WatchCommand,
 ])

package/src/commands/InitCommand.ts

@@ -58,6 +58,10 @@ export class InitCommand extends PackagePathSpecific(MustacheGeneratorCommand) {
       path: packagePath,
       basename: path.basename(packagePath),
     }))
+    await this.removeDestinationFile(
+      'docker-compose.yaml',
+      'docker-compose.yml.mustache',
+    )
     await super.execute()
   }
 }

package/src/commands/VersionCommand.ts

@@ -0,0 +1,17 @@
+import { Command } from 'clipanion'
+
+export class VersionCommand extends Command {
+  static override paths = [['version']]
+
+  static override usage = Command.Usage({
+    description: 'Display the version of esm.dev',
+  })
+
+  override async execute(): Promise<number | void> {
+    const path = await import('node:path')
+    const pckg = await Bun.file(
+      path.resolve(import.meta.dirname, '..', '..', 'package.json'),
+    ).json()
+    this.context.stdout.write(`${pckg.version}\n`)
+  }
+}

package/templates/init/docker-compose.yml.mustache

@@ -22,7 +22,7 @@ services:
       {{/packages}}
 
   esm:
-    image: ghcr.io/esm-dev/esm:latest
+    image: ghcr.io/esm-dev/esm.sh:latest
     environment:
       - NPM_REGISTRY=http://npm:{{npmRegistryURL.port}}
       - NPM_TOKEN=fake