Merge pull request #87 from tldraw/fix-docs

Fix docs
2021-09-12 14:08:35 +01:00 · 2021-09-12 14:08:35 +01:00 · fe3bcbfe37
commit fe3bcbfe37
parent a3da5e1937 7808d6b75e
21 changed files with 115 additions and 81 deletions
--- a/package.json
+++ b/package.json
@ -26,8 +26,8 @@
    "build": "yarn build:packages && cd packages/www && yarn build",
    "build:packages": "cd packages/vec && yarn build && cd ../intersect && yarn build && cd ../core && yarn build && cd ../tldraw && yarn build",
    "publish:patch": "yarn build:packages && lerna publish patch",
-    "docs": "lerna run docs --stream",
-    "docs:watch": "lerna run docs:watch --stream"
+    "docs": "lerna run docs",
+    "docs:watch": "lerna run docs:watch"
  },
  "devDependencies": {
    "@babel/core": "^7.15.0",
@ -54,7 +54,7 @@
    "resize-observer-polyfill": "^1.5.1",
    "ts-jest": "^27.0.5",
    "tslib": "^2.3.0",
-    "typedoc": "^0.21.9",
+    "typedoc": "^0.22.3",
    "typescript": "^4.4.2"
  },
  "dependencies": {},
--- a/packages/core/package.json
+++ b/packages/core/package.json
@ -47,7 +47,7 @@
    "react-dom": "^17.0.2",
    "ts-node": "^10.2.1",
    "tslib": "^2.3.1",
-    "typedoc": "^0.21.9",
+    "typedoc": "^0.22.3",
    "typescript": "^4.4.2"
  },
  "peerDependencies": {
@ -59,5 +59,5 @@
    "@tldraw/vec": "^0.0.87",
    "@use-gesture/react": "^10.0.0-beta.24"
  },
-  "gitHead": "55da8880eb3d8ab5fb62b5eb7853065922c95dcf"
-}
+  "gitHead": "a3da5e193714091f092c328de4c2178b54d3d270"
+}
--- a/packages/core/tsconfig.build.json
+++ b/packages/core/tsconfig.build.json
@ -14,6 +14,7 @@
    "composite": false,
    "incremental": false,
    "declarationMap": false,
-    "sourceMap": false
+    "sourceMap": false,
+    "emitDeclarationOnly": true
  }
 }
--- a/packages/core/tsconfig.json
+++ b/packages/core/tsconfig.json
@ -6,14 +6,13 @@
    "outDir": "./dist/types",
    "rootDir": "src",
    "baseUrl": "src",
+    "emitDeclarationOnly": false,
    "paths": {
      "+*": ["./*"]
    }
  },
-  "references": [
-    {
-      "path": "../../packages/intersect"
-    },
-    { "path": "../../packages/vec" }
-  ]
+  "typedocOptions": {
+    "entryPoints": ["src/index.ts"],
+    "out": "docs"
+  }
 }
--- a/packages/dev/README.md
+++ b/packages/dev/README.md
@ -1,3 +1,6 @@
-# Dev Server
+# @tldraw/dev

-Dev server with fast refresh.
+A very fast dev server.
+
+You probably do not need to start the server here: it is started as
+part of `yarn start` in the root directory.
--- a/packages/dev/tsconfig.json
+++ b/packages/dev/tsconfig.json
@ -1,15 +1,18 @@
 {
  "extends": "../../tsconfig.base.json",
  "include": ["src"],
-  "exclude": ["node_modules", "**/*.test.ts", "**/*.spec.ts", "dist"],
+  "exclude": ["node_modules", "dist", "docs"],
  "compilerOptions": {
-    "composite": true,
-    "rootDir": "."
+    "outDir": "./dist/types",
+    "rootDir": "src",
+    "baseUrl": "src",
+    "emitDeclarationOnly": false,
+    "paths": {
+      "+*": ["./*"]
+    }
  },
-  "references": [
-    {
-      "path": "../../packages/tldraw"
-    },
-    { "path": "../../packages/core" }
-  ]
+  "typedocOptions": {
+    "entryPoints": ["src/index.ts"],
+    "out": "docs"
+  }
 }
--- a/packages/intersect/README.md
+++ b/packages/intersect/README.md
@ -1,3 +1,3 @@
-# Dev Server
+# @tldraw/intersect

-Dev server with fast refresh.
+Intersection utilities.
--- a/packages/intersect/package.json
+++ b/packages/intersect/package.json
@ -46,11 +46,11 @@
    "react-dom": "^17.0.2",
    "ts-node": "^10.2.1",
    "tslib": "^2.3.1",
-    "typedoc": "^0.21.9",
+    "typedoc": "^0.22.3",
    "typescript": "^4.4.2"
  },
  "dependencies": {
    "@tldraw/vec": "^0.0.87"
  },
-  "gitHead": "55da8880eb3d8ab5fb62b5eb7853065922c95dcf"
-}
+  "gitHead": "a3da5e193714091f092c328de4c2178b54d3d270"
+}
--- a/packages/intersect/scripts/build.js
+++ b/packages/intersect/scripts/build.js
@ -1,6 +1,7 @@
 /* eslint-disable */
 const fs = require('fs')
 const esbuild = require('esbuild')
+const { gzip } = require('zlib')

 const name = process.env.npm_package_name || ''

@ -27,7 +28,7 @@ async function main() {
      external: ['react', 'react-dom'],
    })

-    esbuild.buildSync({
+    const esmResult = esbuild.buildSync({
      entryPoints: ['./src/index.ts'],
      outdir: 'dist/esm',
      minify: true,
@ -38,9 +39,23 @@ async function main() {
      jsxFactory: 'React.createElement',
      jsxFragment: 'React.Fragment',
      external: ['react', 'react-dom'],
+      metafile: true,
    })

-    console.log(`✔ ${name}: Built package.`)
+    let esmSize = 0
+    Object.values(esmResult.metafile.outputs).forEach((output) => {
+      esmSize += output.bytes
+    })
+
+    fs.readFile('./dist/esm/index.js', (_err, data) => {
+      gzip(data, (_err, result) => {
+        console.log(
+          `✔ ${name}: Built package. ${(esmSize / 1000).toFixed(2)}kb (${(
+            result.length / 1000
+          ).toFixed(2)}kb minified)`
+        )
+      })
+    })
  } catch (e) {
    console.log(`× ${name}: Build failed due to an error.`)
    console.log(e)
--- a/packages/intersect/tsconfig.build.json
+++ b/packages/intersect/tsconfig.build.json
@ -14,6 +14,7 @@
    "composite": false,
    "incremental": false,
    "declarationMap": false,
-    "sourceMap": false
+    "sourceMap": false,
+    "emitDeclarationOnly": true
  }
 }
--- a/packages/intersect/tsconfig.json
+++ b/packages/intersect/tsconfig.json
@ -5,7 +5,11 @@
  "compilerOptions": {
    "outDir": "./dist/types",
    "rootDir": "src",
-    "baseUrl": "src"
+    "baseUrl": "src",
+    "emitDeclarationOnly": false
  },
-  "references": [{ "path": "../../packages/vec" }]
+  "typedocOptions": {
+    "entryPoints": ["src/index.ts"],
+    "out": "docs"
+  }
 }
--- a/packages/tldraw/package.json
+++ b/packages/tldraw/package.json
@ -47,7 +47,7 @@
    "react-dom": "^17.0.2",
    "ts-node": "^10.2.1",
    "tslib": "^2.3.1",
-    "typedoc": "^0.21.9",
+    "typedoc": "^0.22.3",
    "typescript": "^4.4.2"
  },
  "peerDependencies": {
@ -71,5 +71,5 @@
    "react-hotkeys-hook": "^3.4.0",
    "rko": "^0.5.25"
  },
-  "gitHead": "55da8880eb3d8ab5fb62b5eb7853065922c95dcf"
-}
+  "gitHead": "a3da5e193714091f092c328de4c2178b54d3d270"
+}
--- a/packages/tldraw/scripts/build.js
+++ b/packages/tldraw/scripts/build.js
@ -57,8 +57,6 @@ async function main() {
        )
      })
    })
-
-    console.log(`✔ ${name}: Built package.`)
  } catch (e) {
    console.log(`× ${name}: Build failed due to an error.`)
    console.log(e)
--- a/packages/tldraw/tsconfig.build.json
+++ b/packages/tldraw/tsconfig.build.json
@ -14,6 +14,7 @@
    "composite": false,
    "incremental": false,
    "declarationMap": false,
-    "sourceMap": false
+    "sourceMap": false,
+    "emitDeclarationOnly": true
  }
 }
--- a/packages/tldraw/tsconfig.json
+++ b/packages/tldraw/tsconfig.json
@ -3,19 +3,16 @@
  "include": ["src"],
  "exclude": ["node_modules", "dist", "docs"],
  "compilerOptions": {
-    "strict": true,
-    "composite": true,
-    "emitDeclarationOnly": true,
-    "rootDir": ".",
    "outDir": "./dist/types",
+    "rootDir": "src",
    "baseUrl": "src",
+    "emitDeclarationOnly": false,
    "paths": {
      "~*": ["./*"]
    }
  },
-  "references": [
-    { "path": "../../packages/intersect" },
-    { "path": "../../packages/vec" },
-    { "path": "../../packages/core" }
-  ]
+  "typedocOptions": {
+    "entryPoints": ["src/index.ts"],
+    "out": "docs"
+  }
 }
--- a/packages/vec/README.md
+++ b/packages/vec/README.md
@ -1,3 +1,3 @@
-# Dev Server
+# @tldraw/vec

-Dev server with fast refresh.
+Vector utilities.
--- a/packages/vec/package.json
+++ b/packages/vec/package.json
@ -46,8 +46,8 @@
    "react-dom": "^17.0.2",
    "ts-node": "^10.2.1",
    "tslib": "^2.3.1",
-    "typedoc": "^0.21.9",
+    "typedoc": "^0.22.3",
    "typescript": "^4.4.2"
  },
-  "gitHead": "55da8880eb3d8ab5fb62b5eb7853065922c95dcf"
-}
+  "gitHead": "a3da5e193714091f092c328de4c2178b54d3d270"
+}
--- a/packages/vec/scripts/build.js
+++ b/packages/vec/scripts/build.js
@ -1,6 +1,7 @@
 /* eslint-disable */
 const fs = require('fs')
 const esbuild = require('esbuild')
+const { gzip } = require('zlib')

 const name = process.env.npm_package_name || ''

@ -28,7 +29,7 @@ async function main() {
      external: ['react', 'react-dom'],
    })

-    esbuild.buildSync({
+    const esmResult = esbuild.buildSync({
      entryPoints: ['./src/index.ts'],
      outdir: 'dist/esm',
      minify: true,
@ -40,9 +41,23 @@ async function main() {
      jsxFactory: 'React.createElement',
      jsxFragment: 'React.Fragment',
      external: ['react', 'react-dom'],
+      metafile: true,
    })

-    console.log(`✔ ${name}: Built package.`)
+    let esmSize = 0
+    Object.values(esmResult.metafile.outputs).forEach((output) => {
+      esmSize += output.bytes
+    })
+
+    fs.readFile('./dist/esm/index.js', (_err, data) => {
+      gzip(data, (_err, result) => {
+        console.log(
+          `✔ ${name}: Built package. ${(esmSize / 1000).toFixed(2)}kb (${(
+            result.length / 1000
+          ).toFixed(2)}kb minified)`
+        )
+      })
+    })
  } catch (e) {
    console.log(`× ${name}: Build failed due to an error.`)
    console.log(e)
--- a/packages/vec/tsconfig.json
+++ b/packages/vec/tsconfig.json
@ -5,6 +5,11 @@
  "compilerOptions": {
    "outDir": "./dist/types",
    "rootDir": "src",
-    "baseUrl": "src"
+    "baseUrl": "src",
+    "emitDeclarationOnly": false
+  },
+  "typedocOptions": {
+    "entryPoints": ["src/index.ts"],
+    "out": "docs"
  }
 }
--- a/tsconfig.json
+++ b/tsconfig.json
@ -4,10 +4,10 @@
  "exclude": ["node_modules", "**/*.test.ts", "**/*.spec.ts"],
  "files": [],
  "references": [
-    { "path": "./packages/vec" },
-    { "path": "./packages/intersect" },
-    { "path": "./packages/tldraw" },
-    { "path": "./packages/core" }
+    { "path": "./packages/vec/src" },
+    { "path": "./packages/intersect/src" },
+    { "path": "./packages/tldraw/src" },
+    { "path": "./packages/core/src" }
  ],
  "compilerOptions": {
    "baseUrl": ".",
--- a/yarn.lock
+++ b/yarn.lock
@ -7240,7 +7240,7 @@ graceful-fs@^4.1.11, graceful-fs@^4.1.15, graceful-fs@^4.1.2, graceful-fs@^4.1.6
  resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.2.8.tgz#e412b8d33f5e006593cbd3cee6df9f2cebbe802a"
  integrity sha512-qkIilPUYcNhJpd33n0GBXTB1MMPp14TxEsEs0pTrsSVucApsYzW5V+Q8Qxhik6KU3evy+qkAAowTByymK0avdg==

-handlebars@^4.7.6, handlebars@^4.7.7:
+handlebars@^4.7.6:
  version "4.7.7"
  resolved "https://registry.yarnpkg.com/handlebars/-/handlebars-4.7.7.tgz#9ce33416aad02dbd6c8fafa8240d5d98004945a1"
  integrity sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==
@ -9318,7 +9318,7 @@ map-visit@^1.0.0:
  dependencies:
    object-visit "^1.0.0"

-marked@^3.0.2:
+marked@^3.0.3:
  version "3.0.3"
  resolved "https://registry.yarnpkg.com/marked/-/marked-3.0.3.tgz#d81ff0f9e29cef0a177327fe009b460f31aa5862"
  integrity sha512-4oIDhVSQ2s+xNCfek9OnZgCQR/WykGCom02JzIIvi4Pme+MIwPYqvGVW8CQWOXeoZu0TtVB6pTxIuoLm+dKqDA==
@ -9470,7 +9470,7 @@ minimalistic-crypto-utils@^1.0.1:
  resolved "https://registry.yarnpkg.com/minimalistic-crypto-utils/-/minimalistic-crypto-utils-1.0.1.tgz#f6c00c1c0b082246e5c4d99dfb8c7c083b2b582a"
  integrity sha1-9sAMHAsIIkblxNmd+4x8CDsrWCo=

-minimatch@^3.0.0, minimatch@^3.0.4:
+minimatch@^3.0.4:
  version "3.0.4"
  resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.0.4.tgz#5166e286457f03306064be5497e8dbb0c3d32083"
  integrity sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==
@ -10887,7 +10887,7 @@ process@0.11.10, process@^0.11.10:
  resolved "https://registry.yarnpkg.com/process/-/process-0.11.10.tgz#7332300e840161bda3e69a1d1d91a7d4bc16f182"
  integrity sha1-czIwDoQBYb2j5podHZGn1LwW8YI=

-progress@^2.0.0, progress@^2.0.3:
+progress@^2.0.0:
  version "2.0.3"
  resolved "https://registry.yarnpkg.com/progress/-/progress-2.0.3.tgz#7e8cf8d8f5b8f239c1bc68beb4eb78567d572ef8"
  integrity sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==
@ -11877,7 +11877,7 @@ shell-quote@1.7.2:
  resolved "https://registry.yarnpkg.com/shell-quote/-/shell-quote-1.7.2.tgz#67a7d02c76c9da24f99d20808fcaded0e0e04be2"
  integrity sha512-mRz/m/JVscCrkMyPqHc/bczi3OQHkLTqXHEFu0zDhK/qfv3UcOA4SVmRCLmos4bhjr9ekVQubj/R7waKapmiQg==

-shiki@^0.9.8:
+shiki@^0.9.10:
  version "0.9.10"
  resolved "https://registry.yarnpkg.com/shiki/-/shiki-0.9.10.tgz#feb8d4938b5dd71c5c8b1c1c7cd28fbbd37da087"
  integrity sha512-xeM7Oc6hY+6iW5O/T5hor8ul7mEprzyl5y4r5zthEHToQNw7MIhREMgU3r2gKDB0NaMLNrkcEQagudCdzE13Lg==
@ -13002,24 +13002,16 @@ typedarray@^0.0.6:
  resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777"
  integrity sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c=

-typedoc-default-themes@^0.12.10:
-  version "0.12.10"
-  resolved "https://registry.yarnpkg.com/typedoc-default-themes/-/typedoc-default-themes-0.12.10.tgz#614c4222fe642657f37693ea62cad4dafeddf843"
-  integrity sha512-fIS001cAYHkyQPidWXmHuhs8usjP5XVJjWB8oZGqkTowZaz3v7g3KDZeeqE82FBrmkAnIBOY3jgy7lnPnqATbA==
-
-typedoc@^0.21.9:
-  version "0.21.9"
-  resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.21.9.tgz#6fbdc7152024a00f03af53a0ca40f44e91f0f129"
-  integrity sha512-VRo7aII4bnYaBBM1lhw4bQFmUcDQV8m8tqgjtc7oXl87jc1Slbhfw2X5MccfcR2YnEClHDWgsiQGgNB8KJXocA==
+typedoc@^0.22.3:
+  version "0.22.3"
+  resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.22.3.tgz#c67aaeef22702d84267bda12dc13f192dbf9d89e"
+  integrity sha512-EOWf9Vf3Vfb/jzBzr87uoLybQw9fx3iyXLUcpQn9F2Ks1/ZJN9iGeBbYRU+VNqrWvV4T+aS7Ife7GFEJUf0ohQ==
  dependencies:
    glob "^7.1.7"
-    handlebars "^4.7.7"
    lunr "^2.3.9"
-    marked "^3.0.2"
-    minimatch "^3.0.0"
-    progress "^2.0.3"
-    shiki "^0.9.8"
-    typedoc-default-themes "^0.12.10"
+    marked "^3.0.3"
+    minimatch "^3.0.4"
+    shiki "^0.9.10"

 typeorm@^0.2.30:
  version "0.2.37"