Refactor project structure (#1087)

Author: ije

.github/workflows/test.yml

@@ -8,9 +8,13 @@ on:
 
 jobs:
   test:
-    name: Test All
+    name: Deno
     runs-on: ubuntu-latest
 
+    strategy:
+      matrix:
+        deno-version: [1.x, 2.x]
+
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -23,7 +27,7 @@ jobs:
       - name: Setup Deno
         uses: denoland/setup-deno@main
         with:
-          deno-version: v1.x
+          deno-version: ${{ matrix.deno-version }}
 
       - name: Run Unit Tests
         run: go test ./server ./server/storage -v

CONTRIBUTING.md

@@ -24,7 +24,7 @@ Create a `config.json` file in the project root directory following the example
   "port": 8080,
   "workDir": ".esmd",
   "npmRegistry": "https://registry.npmjs.org/", // change to your own registry if needed
-  "npmToken": "xxxxxx", // remove this line if you don't have one
+  "npmToken": "xxxxxx" // remove this line if you don't have one
 }
 ```
 
@@ -33,29 +33,30 @@ More server options please check [config.exmaple.jsonc](./config.example.jsonc).
 ## Running the Server from Source Code
 
 ```bash
-go run -tags debug main.go
-# or
-make dev
+make dev/server
 ```
 
 Then you can import `React` from "http://localhost:8080/react"
 
-## Running Integration Tests
+## Running Server Integration Tests
 
 We use [Deno](https://deno.land) to run all the integration testing cases. Make sure you have Deno installed on your computer.
 
 ```bash
 # Run all tests
-make test
+make test/server
 
 # Run a specific test
-make test dir=react-18
+make test/server dir=react-18
 ```
 
-To add a new integration test case, copy the [test/_template](./test/_template) directory and rename it to your case name.
+To add a new integration test case, copy the [test/.template](./test/.template) directory and rename it to your case name.
 
 ```bash
-cp -r test/_template test/new_test
-nvim test/new_test/test.ts
-make dir=new_test
+# copy the testing template
+cp -r test/.template test/test-case-name
+# edit the test code
+vi test/test-case-name/test.ts
+# run the test
+make test/server dir=test-case-name
 ```

HOSTING.md

@@ -30,7 +30,7 @@ You can find all the server options in [config.example.jsonc](./config.example.j
 You will need [Go](https://golang.org/dl) 1.22+ to compile and run the server.
 
 ```bash
-go run main.go --config=config.json
+go run server/cmd/main.go --config=config.json
 ```
 
 Then you can import `React` from <http://localhost:8080/react>.
@@ -40,15 +40,15 @@ Then you can import `React` from <http://localhost:8080/react>.
 You can deploy the server to a single machine with the [deploy.sh](./scripts/deploy.sh) script.
 
 ```bash
-# first time deploy
+# first time to deploy
 ./scripts/deploy.sh --init
 # update the server
 ./scripts/deploy.sh
 ```
 
 Recommended hosting requirements:
 
-- Linux system (Debian/Ubuntu)
+- Linux system with systemd installed
 - 4x CPU cores or more
 - 8GB RAM or more
 - 100GB disk space or more
@@ -164,3 +164,6 @@ To deploy the server with CloudFlare CDN, you need to create following cache rul
 ```ruby
 (not starts_with(http.user_agent, "Deno/") and not starts_with(http.user_agent, "Bun/") and not starts_with(http.user_agent, "Node/") and not starts_with(http.user_agent, "Node.js/") and http.user_agent ne "undici")
 ```
+
+> [!NOTE]
+> Since Cloudflare does not respect the `Vary` header, we need to bypass the cache for `Deno`/`Bun`/`Node` clients.

Makefile

@@ -1,12 +1,23 @@
-dev/cli:
-	@go run -tags debug cli/cmd/main.go serve cli/cmd/demo/${app}
+dev/cli/serve:
+	@go run -tags debug main.go serve cli/demo/${app}
 
-dev: config.json
+dev/cli/init:
+	@go run -tags debug main.go init
+
+dev/cli/i:
+	@go run -tags debug main.go i ${package}
+
+dev/cli/im/add:
+	@go run -tags debug main.go im add ${package}
+
+dev/cli/im/update:
+	@go run -tags debug main.go im update ${package}
+
+dev/server: config.json
 	@rm -rf .esmd/log
 	@rm -rf .esmd/storage
 	@rm -rf .esmd/esm.db
-	@go run -tags debug main.go --config=config.json
+	@go run -tags debug server/cmd/main.go --config=config.json
 
-.PHONY: test
-test:
+test/server:
 	@./test/bootstrap.ts ${dir}

README.md

@@ -57,7 +57,8 @@ With [import maps](https://github.com/WICG/import-maps), you can even use bare i
   ```js
   // Examples
   import tslib from "https://esm.sh/gh/microsoft/tslib"; // latest
-  import tslib from "https://esm.sh/gh/microsoft/tslib@2.6.0"; // the version '2.6.0' is a git tag
+  import tslib from "https://esm.sh/gh/microsoft/tslib@d72d6f7"; // with commit hash
+  import tslib from "https://esm.sh/gh/microsoft/tslib@v2.8.0"; // with tag
   ```
 - **[pkg.pr.new](https://pkg.pr.new)** (starts with `/pr/` or `/pkg.pr.new/`):
   ```js
@@ -66,9 +67,9 @@ With [import maps](https://github.com/WICG/import-maps), you can even use bare i
   import { Bench } from "https://esm.sh/pr/tinybench@a832a55"; // --compact
   ```
 
-### Transforming `.tsx`/`.vue`/`.svelte` on the Fly
+### Transforming `.ts(x)`/`.vue`/`.svelte` on the Fly
 
-esm.sh allows you to import `.tsx`, `.vue`, and `.svelte` files directly in the browser without any build steps.
+esm.sh allows you to import `.ts(x)`, `.vue`, and `.svelte` files directly in the browser without any build steps.
 
 ```js
 import { Airplay } from "https://esm.sh/gh/phosphor-icons/react@v2.1.5/src/csr/Airplay.tsx?deps=react@18.2.0";

cli/README.md

@@ -0,0 +1,37 @@
+# A CLI tool for no-build web apps with esm.sh CDN.
+
+A CLI tool for no-build web apps with esm.sh CDN, written in Go.
+
+## Installation
+
+You can install esm.sh CLI from source code:
+
+```bash
+go install github.com/esm-dev/esm.sh
+```
+
+You can also install esm.sh CLI via `npm`:
+
+```bash
+npm install -g esm.sh
+```
+
+Or use `npx` without installation:
+
+```bash
+npx esm.sh [command]
+```
+
+### Usage
+
+```
+$ esm.sh --help
+Usage: esm.sh [command] <options>
+
+Commands:
+  i, add [...pakcage]   Alias to 'esm.sh im add'.
+  im, importmap         Manage "importmap" script.
+  init                  Create a new no-build web app with esm.sh CDN.
+  serve                 Serve a no-build web app with esm.sh CDN, HMR, transforming TS/Vue/Svelte on the fly.
+  build                 Build a no-build web app with esm.sh CDN.
+```

cli/add.go

@@ -0,0 +1,41 @@
+package cli
+
+import (
+	"fmt"
+	"os"
+)
+
+const helpMessage = "\033[30mImport Map Management CLI with esm.sh CDN.\033[0m" + `
+
+Usage: esm.sh im [sub-command] <options>
+
+Sub Commands:
+  add    [...packages]   Add packages to "importmap" script
+  update [...packages]   Update packages in "importmap" script
+`
+
+// Manage `importmap` script
+func ManageImportMap(subCommand string) {
+	if len(os.Args) < 3 {
+		fmt.Print(helpMessage)
+		return
+	}
+	var packages []string
+	if subCommand == "" {
+		subCommand = os.Args[2]
+		packages = os.Args[3:]
+	} else {
+		packages = os.Args[2:]
+	}
+	switch subCommand {
+	case "add":
+		if len(packages) == 0 {
+			return
+		}
+		fmt.Println(packages)
+	case "update":
+		fmt.Println(packages)
+	default:
+		fmt.Printf("Unknown sub command \"%s\"\n", subCommand)
+	}
+}