dist shuffle (#972)

mbostock · web-flow · commit 254ee50b3448 · 2024-03-04T17:32:47.000Z
diff --git a/.eslintignore b/.eslintignore
@@ -1,2 +1,3 @@
+test/build
 test/input
 test/output
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -71,17 +71,11 @@ jobs:
         working-directory: examples/plot
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - run: mkdir dist/examples && for i in examples/*; do if [ -d $i/dist ]; then mv -v $i/dist dist/examples/$(basename $i); fi; done
+      - run: mkdir docs/.observablehq/dist/examples && for i in examples/*; do if [ -d $i/dist ]; then mv -v $i/dist docs/.observablehq/dist/examples/$(basename $i); fi; done
       - uses: cloudflare/pages-action@1
         with:
           apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
           accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
           projectName: framework
-          directory: dist
+          directory: docs/.observablehq/dist
           gitHubToken: ${{ secrets.GITHUB_TOKEN }}
-      # TODO: This doesn't include the examples. How can we fix that?
-      # TODO: Re-enable deploy to Observable
-      # - name: Deploy to Observable
-      #   run: yarn deploy -m "$(git log -1 --pretty=%s)"
-      #   env:
-      #     OBSERVABLE_TOKEN: ${{ secrets.OBSERVABLE_API_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -1,12 +1,12 @@
 **/.observablehq/cache/
 .DS_Store
 .env
-/build.test/
-/build/
 /coverage/
 /dist/
+/docs/.observablehq/dist/
 /docs/theme/*.md
 /docs/themes.md
+/test/build/
 /test/output/**/*-changed.*
 /test/output/build/**/*-changed/
 node_modules/
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -11,7 +11,7 @@ yarn
 Next start the local preview server:
 
 ```sh
-yarn docs:dev
+yarn dev
 ```
 
 Lastly visit <http://127.0.0.1:3000>.
@@ -24,10 +24,10 @@ To generate the static site:
 yarn docs:build
 ```
 
-This creates the `dist` folder. View the site using your preferred web server, such as:
+This creates the `docs/.observablehq/dist` folder. View the site using your preferred web server, such as:
 
 ```sh
-http-server dist
+http-server docs/.observablehq/dist
 ```
 
 This documentation site is built on GitHub using Observable Framework; see the [deploy workflow](https://github.com/observablehq/framework/blob/main/.github/workflows/deploy.yml). Please open a pull request if you’d like to contribute. Contributors are expected to follow our [code of conduct](https://github.com/observablehq/.github/blob/master/CODE_OF_CONDUCT.md). 🙏
diff --git a/examples/api/package.json b/examples/api/package.json
@@ -3,7 +3,7 @@
   "scripts": {
     "dev": "observable preview",
     "build": "rm -rf dist && observable build",
-    "postinstall": "ln -sf ../../../../build/bin/observable.js node_modules/.bin/observable"
+    "postinstall": "ln -sf ../../../../dist/bin/observable.js node_modules/.bin/observable"
   },
   "dependencies": {
     "@observablehq/framework": "link:../.."
diff --git a/examples/chess/package.json b/examples/chess/package.json
@@ -3,7 +3,7 @@
   "scripts": {
     "dev": "observable preview",
     "build": "rm -rf dist && observable build",
-    "postinstall": "ln -sf ../../../../build/bin/observable.js node_modules/.bin/observable"
+    "postinstall": "ln -sf ../../../../dist/bin/observable.js node_modules/.bin/observable"
   },
   "dependencies": {
     "@observablehq/framework": "link:../..",
diff --git a/examples/eia/package.json b/examples/eia/package.json
@@ -3,7 +3,7 @@
   "scripts": {
     "dev": "observable preview",
     "build": "rm -rf dist && observable build",
-    "postinstall": "ln -sf ../../../../build/bin/observable.js node_modules/.bin/observable"
+    "postinstall": "ln -sf ../../../../dist/bin/observable.js node_modules/.bin/observable"
   },
   "dependencies": {
     "@observablehq/framework": "link:../..",
diff --git a/examples/google-analytics/package.json b/examples/google-analytics/package.json
@@ -3,7 +3,7 @@
   "scripts": {
     "dev": "observable preview",
     "build": "rm -rf dist && observable build",
-    "postinstall": "ln -sf ../../../../build/bin/observable.js node_modules/.bin/observable"
+    "postinstall": "ln -sf ../../../../dist/bin/observable.js node_modules/.bin/observable"
   },
   "dependencies": {
     "@google-analytics/data": "^4.3.0",
diff --git a/examples/hello-world/package.json b/examples/hello-world/package.json
@@ -3,7 +3,7 @@
   "scripts": {
     "dev": "observable preview",
     "build": "rm -rf dist && observable build",
-    "postinstall": "ln -sf ../../../../build/bin/observable.js node_modules/.bin/observable"
+    "postinstall": "ln -sf ../../../../dist/bin/observable.js node_modules/.bin/observable"
   },
   "dependencies": {
     "@observablehq/framework": "link:../.."
diff --git a/examples/mortgage-rates/package.json b/examples/mortgage-rates/package.json
@@ -3,7 +3,7 @@
   "scripts": {
     "dev": "observable preview",
     "build": "rm -rf dist && observable build",
-    "postinstall": "ln -sf ../../../../build/bin/observable.js node_modules/.bin/observable"
+    "postinstall": "ln -sf ../../../../dist/bin/observable.js node_modules/.bin/observable"
   },
   "dependencies": {
     "@observablehq/framework": "link:../..",
diff --git a/examples/penguin-classification/package.json b/examples/penguin-classification/package.json
@@ -3,7 +3,7 @@
   "scripts": {
     "dev": "observable preview",
     "build": "rm -rf dist && observable build",
-    "postinstall": "ln -sf ../../../../build/bin/observable.js node_modules/.bin/observable"
+    "postinstall": "ln -sf ../../../../dist/bin/observable.js node_modules/.bin/observable"
   },
   "dependencies": {
     "@observablehq/framework": "link:../.."
diff --git a/examples/plot/package.json b/examples/plot/package.json
@@ -3,7 +3,7 @@
   "scripts": {
     "dev": "observable preview",
     "build": "rm -rf dist && observable build",
-    "postinstall": "ln -sf ../../../../build/bin/observable.js node_modules/.bin/observable"
+    "postinstall": "ln -sf ../../../../dist/bin/observable.js node_modules/.bin/observable"
   },
   "dependencies": {
     "@observablehq/framework": "link:../..",
diff --git a/observablehq.config.ts b/observablehq.config.ts
@@ -1,4 +1,5 @@
 export default {
+  output: "docs/.observablehq/dist",
   title: "Observable Framework",
   pages: [
     {name: "Getting started", path: "/getting-started"},
diff --git a/package.json b/package.json
@@ -11,24 +11,24 @@
     "url": "https://github.com/observablehq/framework.git"
   },
   "files": [
-    "build/**/*.js",
-    "build/**/*.css",
+    "dist/**/*.js",
+    "dist/**/*.css",
     "templates"
   ],
   "bin": {
-    "observable": "build/bin/observable.js"
+    "observable": "dist/bin/observable.js"
   },
   "scripts": {
     "dev": "rimraf --glob docs/themes.md docs/theme/*.md && (tsx watch docs/theme/generate-themes.ts & tsx watch --no-warnings=ExperimentalWarning ./src/bin/observable.ts preview --no-open)",
     "docs:themes": "rimraf --glob docs/themes.md docs/theme/*.md && tsx docs/theme/generate-themes.ts",
-    "docs:build": "yarn docs:themes && rimraf dist && tsx --no-warnings=ExperimentalWarning ./src/bin/observable.ts build",
+    "docs:build": "yarn docs:themes && rimraf docs/.observablehq/dist && tsx --no-warnings=ExperimentalWarning ./src/bin/observable.ts build",
     "docs:deploy": "yarn docs:themes && tsx --no-warnings=ExperimentalWarning ./src/bin/observable.ts deploy",
-    "build": "rimraf build && node build.js --outdir=build --outbase=src \"src/**/*.{ts,js,css}\" --ignore \"**/*.d.ts\"",
+    "build": "rimraf dist && node build.js --outdir=dist --outbase=src \"src/**/*.{ts,js,css}\" --ignore \"**/*.d.ts\"",
     "test": "concurrently npm:test:mocha npm:test:tsc npm:test:lint npm:test:prettier",
     "test:coverage": "c8 --check-coverage --lines 80 --per-file yarn test:mocha",
-    "test:build": "rimraf build.test && node build.js --sourcemap --outdir=build.test \"{src,test}/**/*.{ts,js,css}\" --ignore \"test/input/**\" --ignore \"test/output/**\" --ignore \"test/preview/dashboard/**\" --ignore \"**/*.d.ts\" && cp -r templates build.test",
-    "test:mocha": "yarn test:build && rimraf --glob test/.observablehq/cache test/input/build/*/.observablehq/cache && cross-env OBSERVABLE_TELEMETRY_DISABLE=1 TZ=America/Los_Angeles mocha -p \"build.test/test/**/*-test.js\"",
-    "test:mocha:serial": "yarn test:build && rimraf --glob test/.observablehq/cache test/input/build/*/.observablehq/cache && cross-env OBSERVABLE_TELEMETRY_DISABLE=1 TZ=America/Los_Angeles mocha \"build.test/test/**/*-test.js\"",
+    "test:build": "rimraf test/build && node build.js --sourcemap --outdir=test/build \"{src,test}/**/*.{ts,js,css}\" --ignore \"test/input/**\" --ignore \"test/output/**\" --ignore \"test/preview/dashboard/**\" --ignore \"**/*.d.ts\" && cp -r templates test/build",
+    "test:mocha": "yarn test:build && rimraf --glob test/.observablehq/cache test/input/build/*/.observablehq/cache && cross-env OBSERVABLE_TELEMETRY_DISABLE=1 TZ=America/Los_Angeles mocha -p \"test/build/test/**/*-test.js\"",
+    "test:mocha:serial": "yarn test:build && rimraf --glob test/.observablehq/cache test/input/build/*/.observablehq/cache && cross-env OBSERVABLE_TELEMETRY_DISABLE=1 TZ=America/Los_Angeles mocha \"test/build/test/**/*-test.js\"",
     "test:lint": "eslint src test --max-warnings=0",
     "test:prettier": "prettier --check src test",
     "test:tsc": "tsc --noEmit",
@@ -38,14 +38,14 @@
   "c8": {
     "all": true,
     "include": [
-      "build.test/src/**/*.js"
+      "test/build/src/**/*.js"
     ],
     "exclude": [
-      "build.test/src/bin/",
-      "build.test/src/client/",
-      "build.test/src/convert.js",
-      "build.test/src/observableApiConfig.js",
-      "build.test/src/preview.js"
+      "test/build/src/bin/",
+      "test/build/src/client/",
+      "test/build/src/convert.js",
+      "test/build/src/observableApiConfig.js",
+      "test/build/src/preview.js"
     ],
     "reporter": [
       "text",
diff --git a/test/files-test.ts b/test/files-test.ts
@@ -5,16 +5,16 @@ import {getClientPath, getStylePath, maybeStat, prepareOutput, visitFiles, visit
 
 describe("getClientPath(entry)", () => {
   it("returns the relative path to the specified source", () => {
-    assert.strictEqual(getClientPath("main.js"), "build.test/src/client/main.js");
-    assert.strictEqual(getClientPath("./main.js"), "build.test/src/client/main.js");
-    assert.strictEqual(getClientPath("stdlib/resize.js"), "build.test/src/client/stdlib/resize.js");
-    assert.strictEqual(getClientPath("./stdlib/resize.js"), "build.test/src/client/stdlib/resize.js");
+    assert.strictEqual(getClientPath("main.js"), "test/build/src/client/main.js");
+    assert.strictEqual(getClientPath("./main.js"), "test/build/src/client/main.js");
+    assert.strictEqual(getClientPath("stdlib/resize.js"), "test/build/src/client/stdlib/resize.js");
+    assert.strictEqual(getClientPath("./stdlib/resize.js"), "test/build/src/client/stdlib/resize.js");
   });
 });
 
 describe("geStylePath(entry)", () => {
   it("returns the relative path to the specified style", () => {
-    assert.strictEqual(getStylePath("default.css"), "build.test/src/style/default.css");
+    assert.strictEqual(getStylePath("default.css"), "test/build/src/style/default.css");
   });
 });
 
diff --git a/tsconfig.json b/tsconfig.json
@@ -12,5 +12,6 @@
       "observablehq:search": ["./src/client/search.js"]
     }
   },
-  "include": ["src/**/*", "docs/**/*", "test/**/*"]
+  "include": ["src/**/*", "docs/**/*", "test/**/*"],
+  "exclude": ["test/build/**/*"]
 }

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
	`1`	`+test/build`
`1`	`2`	`test/input`
`2`	`3`	`test/output`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`export default {`
	`2`	`+ output: "docs/.observablehq/dist",`
`2`	`3`	`title: "Observable Framework",`
`3`	`4`	`pages: [`
`4`	`5`	`{name: "Getting started", path: "/getting-started"},`
Original file line number	Diff line number	Diff line change
`@@ -12,5 +12,6 @@`
`12`	`12`	`"observablehq:search": ["./src/client/search.js"]`
`13`	`13`	`}`
`14`	`14`	`},`
`15`		`- "include": ["src/*/", "docs/*/", "test/*/"]`
	`15`	`+ "include": ["src/*/", "docs/*/", "test/*/"],`
	`16`	`+ "exclude": ["test/build/*/"]`
`16`	`17`	`}`