add autogen of tsconfigdoc.json "references" field as part of integrity

Author: telamonian

buildutils/src/ensure-repo.ts

@@ -397,6 +397,15 @@ export async function ensureIntegrity(): Promise<boolean> {
     messages['top'] = ['Update package.json'];
   }
 
+  // Handle the refs in the top level tsconfigdoc.json
+  const tsConfigdocPath = path.resolve('.', 'tsconfigdoc.json');
+  const tsConfigdocData = utils.readJSONFile(tsConfigdocPath);
+  tsConfigdocData.references = [];
+  utils.getCorePaths().forEach(pth => {
+    tsConfigdocData.references.push({ path: './' + path.relative('.', pth) });
+  });
+  utils.writeJSONFile(tsConfigdocPath, tsConfigdocData);
+
   // Handle the JupyterLab application top package.
   pkgMessages = ensureJupyterlab();
   if (pkgMessages.length > 0) {

tsconfigdoc.json

@@ -4,7 +4,9 @@
   "compilerOptions": {
     "composite": false,
     "baseUrl": ".",
-    "paths": { "@jupyterlab/*": ["packages/*/src"] }
+    "paths": {
+      "@jupyterlab/*": ["packages/*/src"]
+    }
   },
   "references": [
     {
@@ -154,6 +156,12 @@
     {
       "path": "./packages/mathjax2-extension"
     },
+    {
+      "path": "./packages/metapackage"
+    },
+    {
+      "path": "./packages/nbconvert-css"
+    },
     {
       "path": "./packages/nbformat"
     },
@@ -229,6 +237,12 @@
     {
       "path": "./packages/theme-light-extension"
     },
+    {
+      "path": "./packages/toc"
+    },
+    {
+      "path": "./packages/toc-extension"
+    },
     {
       "path": "./packages/tooltip"
     },

typedoc.js

@@ -1,98 +1,6 @@
 // const git = require('git-rev-sync');
 
-const packages = [
-  'application-extension',
-  'application',
-  'apputils-extension',
-  'apputils',
-  'attachments',
-  'cells',
-  'celltags-extension',
-  'celltags',
-  'codeeditor',
-  'codemirror-extension',
-  'codemirror',
-  'completer-extension',
-  'completer',
-  'console-extension',
-  'console',
-  'coreutils',
-  'csvviewer-extension',
-  'csvviewer',
-  'docmanager-extension',
-  'docmanager',
-  'docregistry',
-  'documentsearch-extension',
-  'documentsearch',
-  'extensionmanager-extension',
-  'extensionmanager',
-  'filebrowser-extension',
-  'filebrowser',
-  'fileeditor-extension',
-  'fileeditor',
-  'help-extension',
-  'htmlviewer-extension',
-  'htmlviewer',
-  'hub-extension',
-  'imageviewer-extension',
-  'imageviewer',
-  'inspector-extension',
-  'inspector',
-  'javascript-extension',
-  'json-extension',
-  'launcher-extension',
-  'launcher',
-  'logconsole-extension',
-  'logconsole',
-  'mainmenu-extension',
-  'mainmenu',
-  'markdownviewer-extension',
-  'markdownviewer',
-  'mathjax2-extension',
-  'mathjax2',
-  'metapackage',
-  'nbconvert-css',
-  'nbformat',
-  'notebook-extension',
-  'notebook',
-  'observables',
-  'outputarea',
-  'pdf-extension',
-  'property-inspector',
-  'rendermime-extension',
-  'rendermime-interfaces',
-  'rendermime',
-  'running-extension',
-  'running',
-  'services',
-  'settingeditor-extension',
-  'settingeditor',
-  'settingregistry',
-  'shortcuts-extension',
-  'statedb',
-  'statusbar-extension',
-  'statusbar',
-  'tabmanager-extension',
-  'terminal-extension',
-  'terminal',
-  'theme-dark-extension',
-  'theme-light-extension',
-  'tooltip-extension',
-  'tooltip',
-  'ui-components-extension',
-  'ui-components',
-  'vdom-extension',
-  'vdom',
-  'vega5-extension'
-];
-
-const inputFiles = packages.flatMap(p => [
-  `${__dirname}/packages/${p}/src/index.ts*`,
-  `${__dirname}/packages/${p}/src/*.d.ts`
-]);
-
 module.exports = {
-  // inputFiles,
   exclude: [
     // '^((?!index\.ts).)*$',
     // '^((?!index\.tsx).)*$',
@@ -110,7 +18,9 @@ module.exports = {
     '**/node_modules/**',
     '**/test/**',
     '**/tests/**',
-    '**/testutils/**'
+    '**/testutils/**',
+
+    '**/packages/metapackage/**'
   ],
   excludeNotExported: true,
   ignoreCompilerErrors: false,