Clean up project structure.

When we used to publish to deno.land/x/, the entire source code structure was exposed, so keeping embed.ts and mod.ts at the root made sense. Now that we publish to JSR, only things explicitly listed as exports in deno.json[c] are public, and we can give them short paths there, regardless of where they're located in our project directories. So, let's move our source into src/.
NfNitLoop · Jul 1, 2024 · 015e219 · 015e219
1 parent a9d8b18
commit 015e219
Show file tree

Hide file tree

Showing 41 changed files with 38 additions and 44 deletions.
diff --git a/deno.jsonc b/deno.jsonc
@@ -2,11 +2,11 @@
     "name": "@nfnitloop/deno-embedder",
     "version": "1.4.7",
     "exports": {
-        ".": "./mod.ts",
-        "./plugins/plugins": "./plugins/plugins.ts",
-        "./plugins/esbuild": "./plugins/esbuild.ts",
-        "./helpers/oak": "./helpers/oak.ts",
-        "./helpers/hono": "./helpers/hono.ts",
+        ".": "./src/mod.ts",
+        "./plugins/plugins": "./src/plugins/plugins.ts",
+        "./plugins/esbuild": "./src/plugins/esbuild.ts",
+        "./helpers/oak": "./src/helpers/oak.ts",
+        "./helpers/hono": "./src/helpers/hono.ts",
 
         // Allows easily running the example server:
         "./examples/with-embedder": "./examples/with-embedder/server.ts",
@@ -18,20 +18,12 @@
         "./examples/hono": "./examples/hono/server.ts",
 
         // Needs to be exposed so that embedded files can import w/ JSR syntax. You shouldn't use this directly.
-        "./embed.ts": "./embed.ts"
+        "./embed.ts": "./src/embed.ts"
     },
     "publish": {
         "include": [
             "README.md",
-
-            "mod.ts",
-            "embed.ts",
-
-            // TODO: Move stuff into a src/ dir now that we have JSR exports. (<3)
-            "_src/**/*.ts",
-            "deps/**/*.ts",
-            "plugins/**/*.ts",
-            "helpers/**/*.ts",
+            "src/**/*.ts",
             "examples/with-embedder/**/*.ts",
             "examples/hono/**/*.ts"
         ]
@@ -41,7 +33,7 @@
         "test": "deno task check && deno test --doc -A && deno task examples:test && deno task lints",
 
         "check": "deno task check:main && deno task check:without-embedder && deno task examples:build && deno task examples:check && deno task check:publish",
-        "check:main": "deno check mod.ts embed.ts helpers/oak.ts helpers/hono.ts plugins/esbuild.ts",
+        "check:main": "deno check src/mod.ts src/embed.ts src/helpers/oak.ts src/helpers/hono.ts src/plugins/esbuild.ts",
         "check:publish": "deno publish --dry-run --allow-dirty",
         "check:without-embedder": "cd examples/without-embedder; deno task check",
 
@@ -79,7 +71,7 @@
             // Has example code that references theoretical modules:
             "README.md",
             // Pseudocode doc block example:
-            "helpers/hono.ts"
+            "src/helpers/hono.ts"
         ]
     }
 }
diff --git a/deno.lock b/deno.lock
diff --git a/examples/hono/deno.lock b/examples/hono/deno.lock
diff --git a/examples/hono/embed/code/_app.js.ts b/examples/hono/embed/code/_app.js.ts
diff --git a/examples/hono/embed/code/dir.ts b/examples/hono/embed/code/dir.ts
diff --git a/examples/hono/embed/static/_Smiley.svg.ts b/examples/hono/embed/static/_Smiley.svg.ts
diff --git a/examples/hono/embed/static/_index.html.ts b/examples/hono/embed/static/_index.html.ts
diff --git a/examples/hono/embed/static/dir.ts b/examples/hono/embed/static/dir.ts
diff --git a/examples/hono/embedder.ts b/examples/hono/embedder.ts
@@ -2,8 +2,8 @@
 // lives in the same repository as this example. You should import these from
 // `jsr:@nfnitloop/deno-embedder@version`
 //
-import * as embedder from "../../mod.ts"
-import { ESBuild } from "../../plugins/esbuild.ts"
+import * as embedder from "../../src/mod.ts"
+import { ESBuild } from "../../src/plugins/esbuild.ts"
 
 
 export const options = {

diff --git a/examples/hono/server.ts b/examples/hono/server.ts
@@ -1,5 +1,5 @@
-import { Hono } from "../../deps/hono.ts";
-import { serveDir, serveStatic } from "../../helpers/hono.ts";
+import { Hono } from "../../src/deps/hono.ts";
+import { serveDir, serveStatic } from "../../src/helpers/hono.ts";
 import staticFiles from "./embed/static/dir.ts";
 import bundledJs from "./embed/code/dir.ts";
 

diff --git a/examples/with-embedder/embed/code/_app.js.ts b/examples/with-embedder/embed/code/_app.js.ts
diff --git a/examples/with-embedder/embed/code/dir.ts b/examples/with-embedder/embed/code/dir.ts
diff --git a/examples/with-embedder/embed/static/_Smiley.svg.ts b/examples/with-embedder/embed/static/_Smiley.svg.ts
diff --git a/examples/with-embedder/embed/static/_index.html.ts b/examples/with-embedder/embed/static/_index.html.ts
diff --git a/examples/with-embedder/embed/static/dir.ts b/examples/with-embedder/embed/static/dir.ts
diff --git a/examples/with-embedder/embedder.ts b/examples/with-embedder/embedder.ts
@@ -2,8 +2,8 @@
 // lives in the same repository as this example. You should import these from
 // `jsr:@nfnitloop/deno-embedder@version`
 //
-import * as embedder from "../../mod.ts"
-import { ESBuild } from "../../plugins/esbuild.ts"
+import * as embedder from "../../src/mod.ts"
+import { ESBuild } from "../../src/plugins/esbuild.ts"
 
 
 export const options = {

diff --git a/examples/with-embedder/server.ts b/examples/with-embedder/server.ts
@@ -1,4 +1,4 @@
-import { serveDir, oak } from "../../helpers/oak.ts"
+import { serveDir, oak } from "../../src/helpers/oak.ts"
 import staticFiles from "./embed/static/dir.ts"
 import bundledJs from "./embed/code/dir.ts"
 import sarcasm from "./browserCode/sarcasm.ts";

diff --git a/examples/without-embedder/server.ts b/examples/without-embedder/server.ts
@@ -1,4 +1,4 @@
-import { Application } from "../../deps/oak.ts";
+import { Application } from "../../src/deps/oak.ts";
 
 const app = new Application();
 

diff --git a/deps/cliffy/command.ts → src/deps/cliffy/command.ts b/deps/cliffy/command.ts → src/deps/cliffy/command.ts
diff --git a/deps/hono.ts → src/deps/hono.ts b/deps/hono.ts → src/deps/hono.ts
diff --git a/deps/oak.ts → src/deps/oak.ts b/deps/oak.ts → src/deps/oak.ts
diff --git a/deps/std/async.ts → src/deps/std/async.ts b/deps/std/async.ts → src/deps/std/async.ts
diff --git a/deps/std/encoding/base64.ts → src/deps/std/encoding/base64.ts b/deps/std/encoding/base64.ts → src/deps/std/encoding/base64.ts
diff --git a/deps/std/fs.ts → src/deps/std/fs.ts b/deps/std/fs.ts → src/deps/std/fs.ts
diff --git a/deps/std/media_types.ts → src/deps/std/media_types.ts b/deps/std/media_types.ts → src/deps/std/media_types.ts
diff --git a/deps/std/path.ts → src/deps/std/path.ts b/deps/std/path.ts → src/deps/std/path.ts
diff --git a/embed.ts → src/embed.ts b/embed.ts → src/embed.ts
diff --git a/helpers/hono.ts → src/helpers/hono.ts b/helpers/hono.ts → src/helpers/hono.ts
diff --git a/helpers/oak.ts → src/helpers/oak.ts b/helpers/oak.ts → src/helpers/oak.ts
diff --git a/_src/jsr_fix.ts → src/jsr_fix.ts b/_src/jsr_fix.ts → src/jsr_fix.ts
diff --git a/_src/jsr_fix_test.ts → src/jsr_fix_test.ts b/_src/jsr_fix_test.ts → src/jsr_fix_test.ts
diff --git a/mod.ts → src/mod.ts b/mod.ts → src/mod.ts
@@ -22,8 +22,8 @@ import { Command } from "./deps/cliffy/command.ts";
 
 import * as embed from "./embed.ts"
 import type { FileEmitter, Plugin } from "./plugins/plugins.ts"
-import { recursiveReadDir } from "./_src/util.ts";
-import { toJsr } from "./_src/jsr_fix.ts";
+import { recursiveReadDir } from "./util.ts";
+import { toJsr } from "./jsr_fix.ts";
 
 const VERSION = "1.0.0"
 const DIR_FILENAME = "dir.ts"

diff --git a/plugins/esbuild.ts → src/plugins/esbuild.ts b/plugins/esbuild.ts → src/plugins/esbuild.ts
diff --git a/plugins/plugins.ts → src/plugins/plugins.ts b/plugins/plugins.ts → src/plugins/plugins.ts
diff --git a/_src/util.ts → src/util.ts b/_src/util.ts → src/util.ts
@@ -3,7 +3,7 @@
  * @module
  */
 
-import { join as pathJoin } from "../deps/std/path.ts";
+import { join as pathJoin } from "./deps/std/path.ts";
 
 /** Read all files from a directory tree, recursively.  */
 export async function * recursiveReadDir(dir: string): AsyncGenerator<Deno.DirEntry> {

diff --git a/tests/jsr_paths/sample/embedder.ts b/tests/jsr_paths/sample/embedder.ts
@@ -1,4 +1,4 @@
-import * as embedder from "../../../mod.ts"
+import * as embedder from "../../../src/mod.ts"
 
 export const options = {
     importMeta: import.meta,

diff --git a/tests/jsr_paths/sample/src/embedded/_foo_bar.ts.ts b/tests/jsr_paths/sample/src/embedded/_foo_bar.ts.ts
diff --git a/tests/jsr_paths/sample/src/embedded/_foobar_.d_ts_.ts.ts b/tests/jsr_paths/sample/src/embedded/_foobar_.d_ts_.ts.ts
diff --git a/tests/jsr_paths/sample/src/embedded/dir.ts b/tests/jsr_paths/sample/src/embedded/dir.ts
diff --git a/tests/jsr_paths/sample/src/embedded/foo_bar/_baz.txt.ts b/tests/jsr_paths/sample/src/embedded/foo_bar/_baz.txt.ts
diff --git a/tests/jsr_paths/sample/src/embedded/foo_bar/_baz_etc.md.ts b/tests/jsr_paths/sample/src/embedded/foo_bar/_baz_etc.md.ts