Added Sync docs script as a sb task

docs/sync.js

@@ -1,74 +0,0 @@
-/**
- * Util script for synchronizing docs with frontpage repository.
- * For running it:
- * - cd /storybook/docs
- * - node sync.js 
- */
-const fs = require('fs');
-const readline = require('readline');
-const path = require('path');
-
-const askQuestion = (query) => {
-  const rl = readline.createInterface({
-      input: process.stdin,
-      output: process.stdout,
-  });
-
-  return new Promise(resolve => rl.question(`${query}\n`, ans => {
-      rl.close();
-      resolve(ans);
-  }))
-}
-
-const run = async () => {
-  let frontpageDocsPath = '/src/content/docs'
-
-  const frontpageAbsPath = await askQuestion('Provide the frontpage project absolute path:')
-  frontpageDocsPath = `${frontpageAbsPath}${frontpageDocsPath}`;
-  
-  if (!fs.existsSync(frontpageDocsPath)) {
-    console.error(`The directory ${frontpageDocsPath} doesn't exists`);
-    process.exit(1)
-  }
-
-  console.log(`Synchronizing files from: \n${__dirname} \nto: \n${frontpageDocsPath}`)
-  
-  fs.watch(__dirname , {recursive: true}, (_, filename) => {
-    const srcFilePath = path.join(__dirname, filename);
-    const targetFilePath = path.join(frontpageDocsPath, filename);
-    const targetDir = targetFilePath.split('/').slice(0, -1).join('/');
-
-    if (filename === 'sync.js') return;
-
-    //Syncs create file
-    if (!fs.existsSync(targetFilePath)) {
-      fs.mkdirSync(targetDir, {recursive: true})
-
-      try {
-        fs.closeSync(fs.openSync(targetFilePath, 'w'));
-        console.log(`Created ${filename}.`);
-      } catch (error) {
-        throw error;
-      }
-    }
-    
-    //Syncs remove file
-    if (!fs.existsSync(srcFilePath)) {
-      try {
-        fs.unlinkSync(targetFilePath);
-        console.log(`Removed ${filename}.`);
-      } catch (error) {
-        throw error;
-      }
-      return;
-    }
-
-    //Syncs update file
-    fs.copyFile(srcFilePath, targetFilePath, (err) => {
-      console.log(`Updated ${filename}.`);
-      if (err) throw err;
-    });
-  })
-}
-
-run();

scripts/task.ts

@@ -15,6 +15,7 @@ import { publish } from './tasks/publish';
 import { runRegistryTask } from './tasks/run-registry';
 import { generate } from './tasks/generate';
 import { sandbox } from './tasks/sandbox';
+import { syncDocs } from './tasks/sync-docs';
 import { dev } from './tasks/dev';
 import { smokeTest } from './tasks/smoke-test';
 import { build } from './tasks/build';
@@ -90,6 +91,7 @@ export const tasks = {
   compile,
   check,
   publish,
+  'sync-docs': syncDocs,
   'run-registry': runRegistryTask,
   // These tasks pertain to a single sandbox in the ../sandboxes dir
   generate,
@@ -105,7 +107,7 @@ export const tasks = {
 type TaskKey = keyof typeof tasks;
 
 function isSandboxTask(taskKey: TaskKey) {
-  return !['install', 'compile', 'publish', 'run-registry', 'check'].includes(taskKey);
+  return !['install', 'compile', 'publish', 'run-registry', 'check', 'sync-docs'].includes(taskKey);
 }
 
 export const options = createOptions({

scripts/tasks/sync-docs.ts

@@ -0,0 +1,55 @@
+import fs from 'fs';
+import path from 'path';
+import type { Task } from '../task';
+import { ask } from '../utils/ask';
+
+const logger = console;
+
+export const syncDocs: Task = {
+  description: 'Synchronize documentation',
+  service: true,
+  async ready() {
+    return false;
+  },
+  async run() {
+    const rootDir = path.join(__dirname, '..', '..');
+    const docsDir = path.join(rootDir, 'docs');
+    let frontpageDocsPath = '/src/content/docs';
+
+    const frontpagePath = await ask('Provide the frontpage project path:');
+    frontpageDocsPath = path.join(rootDir, frontpagePath, frontpageDocsPath);
+
+    if (!fs.existsSync(frontpageDocsPath)) {
+      logger.info(`The directory ${frontpageDocsPath} doesn't exists`);
+      process.exit(1);
+    }
+
+    logger.info(`Synchronizing files from: \n${docsDir} \nto: \n${frontpageDocsPath}`);
+
+    fs.watch(docsDir, { recursive: true }, (_, filename) => {
+      const srcFilePath = path.join(docsDir, filename);
+      const targetFilePath = path.join(frontpageDocsPath, filename);
+      const targetDir = targetFilePath.split('/').slice(0, -1).join('/');
+
+      // Syncs create file
+      if (!fs.existsSync(targetFilePath)) {
+        fs.mkdirSync(targetDir, { recursive: true });
+        fs.closeSync(fs.openSync(targetFilePath, 'w'));
+        logger.info(`Created ${filename}.`);
+      }
+
+      // Syncs remove file
+      if (!fs.existsSync(srcFilePath)) {
+        fs.unlinkSync(targetFilePath);
+        logger.info(`Removed ${filename}.`);
+        return;
+      }
+
+      // Syncs update file
+      fs.copyFile(srcFilePath, targetFilePath, (err) => {
+        logger.info(`Updated ${filename}.`);
+        if (err) throw err;
+      });
+    });
+  },
+};

scripts/utils/ask.ts

@@ -0,0 +1,15 @@
+import readline from 'readline';
+
+export const ask = (query: string) => {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  });
+
+  return new Promise<string>((resolve) =>
+    rl.question(`${query}\n`, (ans) => {
+      rl.close();
+      resolve(ans);
+    })
+  );
+};