excaliburjs / Excalibur

🎮 Your friendly TypeScript 2D game engine for the web 🗡️
https://excaliburjs.com
BSD 2-Clause "Simplified" License
1.82k stars 189 forks source link

chore: Upgrade docusaurus to 3.4.0 + new patch #3129

Closed eonarheim closed 3 months ago

eonarheim commented 4 months ago

===:clipboard: PR Checklist :clipboard:===

==================

Closes #

Changes:

cloudflare-workers-and-pages[bot] commented 4 months ago

Deploying excaliburjs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 9d974c8
Status: ✅  Deploy successful!
Preview URL: https://eca83f34.excaliburjs.pages.dev
Branch Preview URL: https://chore-upgrade-docusaurus-doc.excaliburjs.pages.dev

View logs

kamranayub commented 4 months ago

Getting a webpack config error when I pull this down and run npm install and npm start 🤔

kamranayub commented 4 months ago

Looks like invalid configuration being passed:

[ERROR] ValidationError: Invalid configuration object. Webpack has been 
initialized using a configuration object that does not match the API 
schema.
 - configuration[1] should be an object:
   object { amd?, bail?, cache?, context?, dependencies?, devServer?, 
devtool?, entry?, experiments?, extends?, externals?, externalsPresets?, 
externalsType?, ignoreWarnings?, infrastructureLogging?, loader?, mode?, 
module?, name?, node?, optimization?, output?, parallelism?, 
performance?, plugins?, profile?, recordsInputPath?, recordsOutputPath?, 
recordsPath?, resolve?, resolveLoader?, snapshot?, stats?, target?, 
watch?, watchOptions? }
   -> Options object as provided by the user.
    at validate (E:\Development\Contrib\excaliburjs\Excalibur\site\node_mo
dules\webpack\node_modules\schema-utils\dist\validate.js:191:11)
    at validateSchema (E:\Development\Contrib\excaliburjs\Excalibur\site\n
ode_modules\webpack\lib\validateSchema.js:78:2)
    at create (E:\Development\Contrib\excaliburjs\Excalibur\site\node_modu
les\webpack\lib\webpack.js:119:24)
    at webpack (E:\Development\Contrib\excaliburjs\Excalibur\site\node_mod
ules\webpack\lib\webpack.js:167:32)
    at f (E:\Development\Contrib\excaliburjs\Excalibur\site\node_modules\w
ebpack\lib\index.js:72:16)
    at createWebpackDevServer (E:\Development\Contrib\excaliburjs\Excalibu
r\site\node_modules\@docusaurus\core\lib\commands\start\webpack.js:121:44)
    at async Command.start (E:\Development\Contrib\excaliburjs\Excalibur\s
ite\node_modules\@docusaurus\core\lib\commands\start\start.js:31:23) {
  errors: [
    {
      keyword: 'type',
      dataPath: '[1]',
      schemaPath: '#/type',
      params: { type: 'object' },
      message: 'should be object',
      schema: 'object',
kamranayub commented 4 months ago

One thing I noticed which in the future would be nice is to hot reload API docs when ex src files change. It does re-compile ex but that's for code samples.

kamranayub commented 4 months ago

I added a test @apilink to show that we can link between API pages. Note that I originally tried the "official" TypeDoc @link way but that isn't quite supported the same way:

https://github.com/milesj/docusaurus-plugin-typedoc-api/issues/66#issuecomment-2239524493