Update to yarn 3 (#536)

* Install yarn 3

* Switch to yarn 3

* Bump typescript-eslint to support TS4.9

* Fix some dependencies

* Fix buildutils

* Fix API documentation

* Fix verdaccio setup

* Escape quote

.eslintignore

@@ -13,6 +13,7 @@ coverage
 *.bundle.js
 *.config.js
 .eslintrc.js
+docs/source/api
 
 # jetbrains IDE stuff
 .idea/

.github/workflows/tests.yml

@@ -78,6 +78,7 @@ jobs:
         run: |
           set -eux
           yarn clean
+          yarn build:src
           yarn docs
 
       - name: Publish with Verdaccio
@@ -86,12 +87,15 @@ jobs:
           npm install -g verdaccio
           verdaccio --config .github/scripts/verdaccio.yml &
           npm set registry http://localhost:4873/
-          yarn config set registry http://localhost:4873/
+          yarn config set npmRegistryServer http://localhost:4873/
+          yarn config set unsafeHttpWhitelist --json '["localhost"]'
           git config --global user.email "[email protected]"
           git config --global user.name "Your Name"
           yarn run update:versions patch --yes
           git commit -a -m "Update versions"
           yarn run publish
+          yarn config unset npmRegistryServer
+          yarn config unset unsafeHttpWhitelist
 
   check_links:
     runs-on: ubuntu-latest

.gitignore

@@ -30,3 +30,12 @@ docs/source/examples
 .jupyter_releaser_checkout
 .eslintcache
 .ipynb_checkpoints
+
+# yarn v2+
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions

.yarnrc.yml

@@ -0,0 +1,2 @@
+yarnPath: .yarn/releases/yarn-3.4.1.cjs
+nodeLinker: "node-modules"

buildutils/package.json

@@ -10,10 +10,13 @@
   "repository": "https://github.com/jupyterlab/lumino",
   "author": "Project Jupyter",
   "license": "BSD-3-Clause",
-  "private": true,
   "dependencies": {
+    "@rollup/plugin-commonjs": "^24.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",
+    "postcss": "^8.4.14",
+    "rollup": "^3.9.1",
     "rollup-plugin-postcss": "^4.0.2",
-    "rollup-plugin-sourcemaps": "^0.6.3"
+    "rollup-plugin-sourcemaps": "^0.6.3",
+    "rollup-plugin-styles": "^4.0.0"
   }
 }

docs/source/conf.py

@@ -114,6 +114,7 @@ def build_api_docs(out_dir):
     check_call(npm + ['install', '-g', 'yarn'], cwd=root)
     yarn = [shutil.which('yarn')]
     check_call(yarn, cwd=root)
+    check_call(yarn + ["build:src"], cwd=root)
     check_call(yarn + ["docs"], cwd=root)
 
     dest_dir = osp.join(out_dir, "api")

package.json

@@ -45,8 +45,8 @@
   },
   "devDependencies": {
     "@jupyterlab/buildutils": "^3.0.0",
-    "@typescript-eslint/eslint-plugin": "^5.32.0",
-    "@typescript-eslint/parser": "^5.32.0",
+    "@typescript-eslint/eslint-plugin": "^5.45.0",
+    "@typescript-eslint/parser": "^5.45.0",
     "eslint": "^8.21.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-prettier": "^4.2.0",
@@ -55,7 +55,8 @@
     "lint-staged": "^13.1.0",
     "prettier": "^2.7.1",
     "shell-quote": "^1.7.2",
-    "typedoc": "~0.23.9",
+    "typedoc": "^0.23.25",
+    "typedoc-plugin-resolve-crossmodule-references": "^0.3.3",
     "typescript": "~4.9.4"
   },
   "jupyter-releaser": {
@@ -74,5 +75,6 @@
       ],
       "before-draft-release": "node scripts/tag-versions.js"
     }
-  }
+  },
+  "packageManager": "[email protected]"
 }

packages/algorithm/package.json

@@ -34,7 +34,7 @@
     "test:chrome": "cd tests && karma start --browsers=Chrome",
     "test:chrome-headless": "cd tests && karma start --browsers=ChromeHeadless",
     "test:firefox": "cd tests && karma start --browsers=Firefox",
-    "test:firefox-headless": "cd tests && karma start --browsers=FirefoxHeadless",
+    "test:firefox-headless": "cd tests && yarn karma start --browsers=FirefoxHeadless",
     "test:webkit": "cd tests && karma start --browsers=Webkit",
     "test:webkit-headless": "cd tests && karma start --browsers=WebkitHeadless",
     "watch": "tsc --build --watch"
@@ -44,9 +44,11 @@
     "displayName": "algorithm"
   },
   "devDependencies": {
+    "@lumino/buildutils": "^2.0.0-beta.0",
     "@microsoft/api-extractor": "^7.6.0",
     "@rollup/plugin-commonjs": "^24.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",
+    "@types/chai": "^4.3.4",
     "@types/mocha": "^2.2.39",
     "chai": "^4.3.4",
     "karma": "^6.3.4",
@@ -64,7 +66,7 @@
     "rollup-plugin-sourcemaps": "^0.6.3",
     "terser": "^5.7.1",
     "tslib": "^2.4.0",
-    "typedoc": "~0.23.9",
+    "typedoc": "^0.23.25",
     "typescript": "~4.9.4"
   },
   "publishConfig": {

packages/application/package.json

@@ -49,6 +49,7 @@
     "@lumino/widgets": "^2.0.0-beta.1"
   },
   "devDependencies": {
+    "@lumino/buildutils": "^2.0.0-beta.0",
     "@microsoft/api-extractor": "^7.6.0",
     "@rollup/plugin-commonjs": "^24.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",
@@ -70,7 +71,7 @@
     "rollup-plugin-sourcemaps": "^0.6.3",
     "terser": "^5.7.1",
     "tslib": "^2.4.0",
-    "typedoc": "~0.23.9",
+    "typedoc": "^0.23.25",
     "typescript": "~4.9.4"
   },
   "publishConfig": {

packages/collections/package.json

@@ -47,6 +47,7 @@
     "@lumino/algorithm": "^2.0.0-beta.0"
   },
   "devDependencies": {
+    "@lumino/buildutils": "^2.0.0-beta.0",
     "@microsoft/api-extractor": "^7.6.0",
     "@rollup/plugin-commonjs": "^24.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",
@@ -68,7 +69,7 @@
     "rollup-plugin-sourcemaps": "^0.6.3",
     "terser": "^5.7.1",
     "tslib": "^2.4.0",
-    "typedoc": "~0.23.9",
+    "typedoc": "^0.23.25",
     "typescript": "~4.9.4"
   },
   "publishConfig": {

packages/commands/package.json

@@ -60,6 +60,7 @@
     "@lumino/virtualdom": "^2.0.0-beta.0"
   },
   "devDependencies": {
+    "@lumino/buildutils": "^2.0.0-beta.0",
     "@microsoft/api-extractor": "^7.6.0",
     "@rollup/plugin-commonjs": "^24.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",
@@ -81,7 +82,7 @@
     "rollup-plugin-sourcemaps": "^0.6.3",
     "terser": "^5.7.1",
     "tslib": "^2.4.0",
-    "typedoc": "~0.23.9",
+    "typedoc": "^0.23.25",
     "typescript": "~4.9.4"
   },
   "publishConfig": {

packages/coreutils/package.json

@@ -46,6 +46,7 @@
     "displayName": "coreutils"
   },
   "devDependencies": {
+    "@lumino/buildutils": "^2.0.0-beta.0",
     "@microsoft/api-extractor": "^7.6.0",
     "@rollup/plugin-commonjs": "^24.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",
@@ -67,7 +68,7 @@
     "rollup-plugin-sourcemaps": "^0.6.3",
     "terser": "^5.7.1",
     "tslib": "^2.4.0",
-    "typedoc": "~0.23.9",
+    "typedoc": "^0.23.25",
     "typescript": "~4.9.4"
   },
   "publishConfig": {

packages/datagrid/package.json

@@ -46,6 +46,8 @@
     "@lumino/widgets": "^2.0.0-beta.1"
   },
   "devDependencies": {
+    "@lumino/buildutils": "^2.0.0-beta.0",
+    "@microsoft/api-extractor": "^7.6.0",
     "@rollup/plugin-commonjs": "^24.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",
     "postcss": "^8.4.14",
@@ -55,7 +57,7 @@
     "rollup-plugin-sourcemaps": "^0.6.3",
     "terser": "^5.7.1",
     "tslib": "^2.4.0",
-    "typedoc": "~0.23.9",
+    "typedoc": "^0.23.25",
     "typescript": "~4.9.4"
   },
   "publishConfig": {

packages/disposable/package.json

@@ -47,6 +47,7 @@
     "@lumino/signaling": "^2.0.0-beta.1"
   },
   "devDependencies": {
+    "@lumino/buildutils": "^2.0.0-beta.0",
     "@microsoft/api-extractor": "^7.6.0",
     "@rollup/plugin-commonjs": "^24.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",
@@ -68,7 +69,7 @@
     "rollup-plugin-sourcemaps": "^0.6.3",
     "terser": "^5.7.1",
     "tslib": "^2.4.0",
-    "typedoc": "~0.23.9",
+    "typedoc": "^0.23.25",
     "typescript": "~4.9.4"
   },
   "publishConfig": {

packages/domutils/package.json

@@ -44,6 +44,7 @@
     "displayName": "domutils"
   },
   "devDependencies": {
+    "@lumino/buildutils": "^2.0.0-beta.0",
     "@microsoft/api-extractor": "^7.6.0",
     "@rollup/plugin-commonjs": "^24.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",
@@ -65,7 +66,7 @@
     "rollup-plugin-sourcemaps": "^0.6.3",
     "terser": "^5.7.1",
     "tslib": "^2.4.0",
-    "typedoc": "~0.23.9",
+    "typedoc": "^0.23.25",
     "typescript": "~4.9.4"
   },
   "publishConfig": {

packages/dragdrop/package.json

@@ -51,6 +51,7 @@
     "@lumino/disposable": "^2.0.0-beta.1"
   },
   "devDependencies": {
+    "@lumino/buildutils": "^2.0.0-beta.0",
     "@microsoft/api-extractor": "^7.6.0",
     "@rollup/plugin-commonjs": "^24.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",
@@ -74,7 +75,7 @@
     "rollup-plugin-styles": "^4.0.0",
     "terser": "^5.7.1",
     "tslib": "^2.4.0",
-    "typedoc": "~0.23.9",
+    "typedoc": "^0.23.25",
     "typescript": "~4.9.4"
   },
   "publishConfig": {

packages/keyboard/package.json

@@ -44,6 +44,7 @@
     "displayName": "keyboard"
   },
   "devDependencies": {
+    "@lumino/buildutils": "^2.0.0-beta.0",
     "@microsoft/api-extractor": "^7.6.0",
     "@rollup/plugin-commonjs": "^24.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",
@@ -65,7 +66,7 @@
     "rollup-plugin-sourcemaps": "^0.6.3",
     "terser": "^5.7.1",
     "tslib": "^2.4.0",
-    "typedoc": "~0.23.9",
+    "typedoc": "^0.23.25",
     "typescript": "~4.9.4"
   },
   "publishConfig": {

packages/keyboard/src/index.ts

@@ -92,7 +92,7 @@ export function setKeyboardLayout(layout: IKeyboardLayout): void {
 }
 
 /**
- * A concrete implementation of [[IKeyboardLayout]] based on keycodes.
+ * A concrete implementation of {@link IKeyboardLayout} based on keycodes.
  *
  * The `keyCode` property of a `'keydown'` event is a browser and OS
  * specific representation of the physical key (not character) which

packages/messaging/package.json

@@ -48,6 +48,7 @@
     "@lumino/collections": "^2.0.0-beta.0"
   },
   "devDependencies": {
+    "@lumino/buildutils": "^2.0.0-beta.0",
     "@microsoft/api-extractor": "^7.6.0",
     "@rollup/plugin-commonjs": "^24.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",
@@ -70,7 +71,7 @@
     "rollup-plugin-sourcemaps": "^0.6.3",
     "terser": "^5.7.1",
     "tslib": "^2.4.0",
-    "typedoc": "~0.23.9",
+    "typedoc": "^0.23.25",
     "typescript": "~4.9.4"
   },
   "publishConfig": {

packages/messaging/src/index.ts

@@ -164,7 +164,7 @@ export interface IMessageHandler {
  * If all installed message hooks return `true`, the message will
  * be delivered to the handler for processing.
  *
- * **See also:** [[installMessageHook]] and [[removeMessageHook]]
+ * **See also:** {@link MessageLoop.installMessageHook} and {@link MessageLoop.removeMessageHook}
  */
 export interface IMessageHook {
   /**
@@ -185,7 +185,7 @@ export interface IMessageHook {
  *
  * #### Notes
  * The signature and semantics of a message hook function are the same
- * as the `messageHook` method of [[IMessageHook]].
+ * as the `messageHook` method of {@link IMessageHook}.
  */
 export type MessageHook =
   | IMessageHook

packages/polling/package.json

@@ -49,6 +49,7 @@
     "@lumino/signaling": "^2.0.0-beta.1"
   },
   "devDependencies": {
+    "@lumino/buildutils": "^2.0.0-beta.0",
     "@microsoft/api-extractor": "^7.6.0",
     "@rollup/plugin-commonjs": "^24.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",

packages/properties/package.json

@@ -44,6 +44,7 @@
     "displayName": "properties"
   },
   "devDependencies": {
+    "@lumino/buildutils": "^2.0.0-beta.0",
     "@microsoft/api-extractor": "^7.6.0",
     "@rollup/plugin-commonjs": "^24.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",
@@ -65,7 +66,7 @@
     "rollup-plugin-sourcemaps": "^0.6.3",
     "terser": "^5.7.1",
     "tslib": "^2.4.0",
-    "typedoc": "~0.23.9",
+    "typedoc": "^0.23.25",
     "typescript": "~4.9.4"
   },
   "publishConfig": {

packages/signaling/package.json

@@ -48,6 +48,7 @@
     "@lumino/coreutils": "^2.0.0-beta.0"
   },
   "devDependencies": {
+    "@lumino/buildutils": "^2.0.0-beta.0",
     "@microsoft/api-extractor": "^7.6.0",
     "@rollup/plugin-commonjs": "^24.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",
@@ -70,7 +71,7 @@
     "rollup-plugin-sourcemaps": "^0.6.3",
     "terser": "^5.7.1",
     "tslib": "^2.4.0",
-    "typedoc": "~0.23.9",
+    "typedoc": "^0.23.25",
     "typescript": "~4.9.4"
   },
   "publishConfig": {

packages/virtualdom/package.json

@@ -54,6 +54,7 @@
     "@lumino/algorithm": "^2.0.0-beta.0"
   },
   "devDependencies": {
+    "@lumino/buildutils": "^2.0.0-beta.0",
     "@microsoft/api-extractor": "^7.6.0",
     "@rollup/plugin-commonjs": "^24.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",
@@ -75,7 +76,7 @@
     "rollup-plugin-sourcemaps": "^0.6.3",
     "terser": "^5.7.1",
     "tslib": "^2.4.0",
-    "typedoc": "~0.23.9",
+    "typedoc": "^0.23.25",
     "typescript": "~4.9.4"
   },
   "publishConfig": {