Feat: Package watcher

docusaurus.config.ts

@@ -1,8 +1,8 @@
 require('dotenv').config();
+import logger from '@docusaurus/logger';
 import type {
   EditThisPageOption,
   ShowEditThisPage,
-  SiteConfig,
   TdevConfig
 } from '@tdev/siteConfig/siteConfig';
 import { themes as prismThemes } from 'prism-react-renderer';
@@ -24,6 +24,7 @@ import {
   taskStateOverview
 } from './src/siteConfig/navbarItems';
 import { applyTransformers } from './src/siteConfig/transformers';
+import { withSiteConfig } from './src/siteConfig/withSiteConfig';
 import {
   sassPluginConfig,
   dynamicRouterPluginConfig,
@@ -37,24 +38,10 @@ import path from 'path';
 import {
   recommendedBeforeDefaultRemarkPlugins,
   recommendedRehypePlugins,
-  recommendedRemarkPlugins
+  recommendedRemarkPlugins,
 } from './src/siteConfig/markdownPluginConfigs';
 import { remarkPdfPluginConfig } from '@tdev/remark-pdf';
 import { GlobExcludeDefault } from '@docusaurus/utils';
-import extractPackageDocs from './src/siteConfig/extractPackageDocs';
-
-const withSiteConfig = async (): Promise<SiteConfig> => {
-  if (process.env.SITE_CONFIG_PATH) {
-    console.log(`Using site config from ${process.env.SITE_CONFIG_PATH}`);
-    const pathToConfig = path.resolve(process.cwd(), process.env.SITE_CONFIG_PATH);
-    const getConfig = await import(pathToConfig).then((mod) => mod.default);
-    return getConfig();
-  } else {
-    console.log(`Using site config from default './siteConfig'`);
-    const getConfig = await import('./siteConfig').then((mod) => mod.default);
-    return getConfig();
-  }
-};
 
 const BUILD_LOCATION = __dirname;
 const GIT_COMMIT_SHA = process.env.GITHUB_SHA || Math.random().toString(36).substring(7);
@@ -80,6 +67,8 @@ const docusaurusConfig = withSiteConfig().then(async (siteConfig) => {
 
   const DOCS_PATH = useTdevContentPath(siteConfig, 'docs');
   const BLOG_PATH = useTdevContentPath(siteConfig, 'blog');
+  //await packageDocsSync('packages', `${DOCS_PATH}/packages`);
+
 
   const BEFORE_DEFAULT_REMARK_PLUGINS =
     siteConfig.beforeDefaultRemarkPlugins ?? recommendedBeforeDefaultRemarkPlugins;
@@ -242,6 +231,12 @@ const docusaurusConfig = withSiteConfig().then(async (siteConfig) => {
             if (needsRewrite) {
               await fs.writeFile(params.filePath, matter.stringify(params.fileContent, result.frontMatter), {
                 encoding: 'utf-8'
+              }).catch((e) => {
+                if (e.code === 'EACCES') {
+                  const parts = params.filePath.split(path.sep).slice(-3);
+                  logger.warn(`Could not rewrite frontmatter due to insufficient file permissions. Did you create a new file in a subfolder of ./packages/${parts.slice(0, 2).join('/')} ?`);
+                  logger.info(`Make sure to add the following frontmatter manually to the head of "${parts.join(path.sep)}":\n\n${matter.stringify('', result.frontMatter)}`);
+                }
               });
             }
           }
@@ -272,10 +267,6 @@ const docusaurusConfig = withSiteConfig().then(async (siteConfig) => {
                   beforeDefaultRemarkPlugins: BEFORE_DEFAULT_REMARK_PLUGINS,
                   ...DEFAULT_ADMONITION_CONFIG,
                   exclude: [...new Set([...GlobExcludeDefault, '**/node_modules/**'])],
-                  async sidebarItemsGenerator({defaultSidebarItemsGenerator, ...args}) {
-                    const sidebarItems = await defaultSidebarItemsGenerator(args);
-                    return extractPackageDocs(sidebarItems);
-                  },
                   ...(siteConfig.docs || {})
                 }
               : false,

package.json

@@ -8,7 +8,8 @@
     "private": true,
     "scripts": {
         "docusaurus": "docusaurus",
-        "start": "docusaurus start",
+        "start": "concurrently --raw --kill-others 'docusaurus start' 'ts-node updateSync/packageDocsSync/watch.ts --src packages --dest tdev-website/docs/packages'",
+        "prebuild": "ts-node updateSync/packageDocsSync/preBuild.ts --src packages --dest tdev-website/docs/packages",
         "build": "docusaurus build",
         "swizzle": "docusaurus swizzle",
         "deploy": "docusaurus deploy",
@@ -65,6 +66,7 @@
         "mdast-util-math": "^3.0.0",
         "micromark-extension-math": "^3.1.0",
         "micromatch": "^4.0.8",
+        "minimist": "^1.2.8",
         "mobx": "^6.15.0",
         "mobx-react-lite": "^4.1.1",
         "mobx-utils": "^6.1.1",
@@ -97,12 +99,14 @@
         "@types/fs-extra": "^11.0.4",
         "@types/js-yaml": "^4.0.9",
         "@types/micromatch": "^4.0.9",
+        "@types/minimist": "^1.2.5",
         "@types/react-dom": "^19.0.3",
         "@types/react-katex": "^3.0.4",
         "@types/svg-parser": "^2.0.6",
         "@types/uuid": "^10.0.0",
         "@types/wicg-file-system-access": "^2023.10.6",
         "@vitest/coverage-v8": "^2.0.5",
+        "concurrently": "^9.2.1",
         "fs-extra": "^11.2.0",
         "prettier": "^3.3.2",
         "remark": "^15.0.1",
@@ -134,4 +138,4 @@
     "engines": {
         "node": ">=22.15"
     }
-}
+}

src/siteConfig/withSiteConfig.ts

@@ -0,0 +1,16 @@
+import type { SiteConfig } from './siteConfig';
+import path from 'path';
+
+export const withSiteConfig = async (): Promise<SiteConfig> => {
+    if (process.env.SITE_CONFIG_PATH) {
+        console.log(`Using site config from ${process.env.SITE_CONFIG_PATH}`);
+        const pathToConfig = path.resolve(process.cwd(), process.env.SITE_CONFIG_PATH);
+        const getConfig = await import(pathToConfig).then((mod) => mod.default);
+        return getConfig();
+    } else {
+        console.log(`Using site config from default './siteConfig'`);
+        const pathToConfig = path.resolve(process.cwd(), 'siteConfig');
+        const getConfig = await import(pathToConfig).then((mod) => mod.default);
+        return getConfig();
+    }
+};

tdev-website/docs/packages/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore