chore(specs): publish docs specs (#2255)

package.json

@@ -27,9 +27,8 @@
     "scripts:test": "yarn workspace scripts test",
     "specs:fix": "eslint --ext=yml specs/$0 --fix",
     "specs:lint": "eslint --ext=yml specs/$0",
-    "website": "yarn website:build-specs && cd website && yarn start",
-    "website:build": "bash scripts/website/build.sh",
-    "website:build-specs": "BUNDLE_WITH_DOC=true DOCKER=true yarn cli build specs all -s"
+    "website": "DOCKER=true yarn cli build specs all -s && cd website && yarn start",
+    "website:build": "bash scripts/website/build.sh"
   },
   "devDependencies": {
     "@babel/eslint-parser": "7.22.15",

scripts/buildSpecs.ts

@@ -2,7 +2,7 @@ import fsp from 'fs/promises';
 
 import yaml from 'js-yaml';
 
-import { BUNDLE_WITH_DOC, checkForCache, exists, run, toAbsolutePath } from './common.js';
+import { checkForCache, exists, run, toAbsolutePath } from './common.js';
 import { createSpinner } from './spinners.js';
 import type { Spec } from './types.js';
 
@@ -87,18 +87,9 @@ async function transformBundle({
   );
 
   if (withDoc) {
-    const docFolderPath = toAbsolutePath('website/specs');
-    if (!(await exists(docFolderPath))) {
-      fsp.mkdir(docFolderPath, { recursive: true });
-    }
+    const pathToDocFile = toAbsolutePath(`specs/bundled/${clientName}.doc.yml`);
 
-    const pathToSpecDoc = `${docFolderPath}/${clientName}.doc.yml`;
-    await fsp.writeFile(
-      pathToSpecDoc,
-      yaml.dump(bundledDocSpec, {
-        noRefs: true,
-      })
-    );
+    await fsp.writeFile(pathToDocFile, yaml.dump(bundledDocSpec, { noRefs: true }));
   }
 }
 
@@ -219,7 +210,7 @@ async function buildSpec(spec: string, outputFormat: string, useCache: boolean):
     await transformBundle({
       bundledPath: toAbsolutePath(bundledPath),
       clientName: spec,
-      withDoc: BUNDLE_WITH_DOC,
+      withDoc: true,
     });
   } else {
     await buildLiteSpec({

scripts/common.ts

@@ -28,7 +28,6 @@ export const TODAY = new Date().toISOString().split('T')[0];
 
 export const CI = Boolean(process.env.CI);
 export const DOCKER = Boolean(process.env.DOCKER);
-export const BUNDLE_WITH_DOC = process.env.BUNDLE_WITH_DOC === 'true';
 
 // This script is run by `yarn workspace ...`, which means the current working directory is `./script`
 const ROOT_DIR = path.resolve(process.cwd(), '..');

scripts/website/build.sh

@@ -3,8 +3,7 @@
 # treat website as independant yarn project
 touch website/yarn.lock
 
-# build doc specs
-yarn website:build-specs
+DOCKER=true yarn cli build specs all -s 
 
 # install website deps and build
 cd website && yarn install && yarn build

website/docusaurus.config.js

@@ -5,7 +5,7 @@ const fs = require('fs');
 const path = require('path');
 
 function getSpecFiles() {
-  const bundledSpecsPath = path.resolve(process.cwd(), 'specs');
+  const bundledSpecsPath = path.resolve(process.cwd(), '../specs/bundled');
   const specs = [];
 
   fs.readdirSync(bundledSpecsPath).forEach((file) => {