@techdocs/cli 1.8.20-next.1 → 1.8.20

package/dist/commands/serve/serve.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serve.cjs.js","sources":["../../../src/commands/serve/serve.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { OptionValues } from 'commander';\nimport path from 'path';\nimport openBrowser from 'react-dev-utils/openBrowser';\nimport { findPaths } from '@backstage/cli-common';\nimport HTTPServer from '../../lib/httpServer';\nimport { runMkdocsServer } from '../../lib/mkdocsServer';\nimport { LogFunc, waitForSignal } from '../../lib/run';\nimport { createLogger } from '../../lib/utility';\nimport { getMkdocsYml } from '@backstage/plugin-techdocs-node';\nimport fs from 'fs-extra';\nimport { checkIfDockerIsOperational } from './utils';\n\nfunction findPreviewBundlePath(): string {\n  try {\n    return path.join(\n      path.dirname(require.resolve('techdocs-cli-embedded-app/package.json')),\n      'dist',\n    );\n  } catch {\n    // If the techdocs-cli-embedded-app package is not available it means we're\n    // running a published package. For published packages the preview bundle is\n    // copied to dist/embedded-app be the prepack script.\n    //\n    // This can be tested by running `yarn pack` and extracting the resulting tarball into a directory.\n    // Within the extracted directory, run `npm install --only=prod`.\n    // Once that's done you can test the CLI in any directory using `node <tmp-dir>/package <command>`.\n    // eslint-disable-next-line no-restricted-syntax\n    return findPaths(__dirname).resolveOwn('dist/embedded-app');\n  }\n}\n\nfunction getPreviewAppPath(opts: OptionValues): string {\n  return opts.previewAppBundlePath ?? findPreviewBundlePath();\n}\n\nexport default async function serve(opts: OptionValues) {\n  const logger = createLogger({ verbose: opts.verbose });\n\n  // Determine if we want to run in local dev mode or not\n  // This will run the backstage http server on a different port and only used\n  // for proxying mkdocs to the backstage app running locally (e.g. with webpack-dev-server)\n  const isDevMode = Object.keys(process.env).includes('TECHDOCS_CLI_DEV_MODE')\n    ? true\n    : false;\n\n  const backstageBackendPort = 7007;\n\n  const mkdocsDockerAddr = `http://0.0.0.0:${opts.mkdocsPort}`;\n  const mkdocsLocalAddr = `http://127.0.0.1:${opts.mkdocsPort}`;\n  const mkdocsExpectedDevAddr = opts.docker\n    ? mkdocsDockerAddr\n    : mkdocsLocalAddr;\n  const mkdocsConfigFileName = opts.mkdocsConfigFileName;\n  const siteName = opts.siteName;\n\n  const { path: mkdocsYmlPath, configIsTemporary } = await getMkdocsYml('./', {\n    name: siteName,\n    mkdocsConfigFileName,\n  });\n\n  // Validate that Docker is up and running\n  if (opts.docker) {\n    const isDockerOperational = await checkIfDockerIsOperational(logger);\n    if (!isDockerOperational) {\n      return;\n    }\n  }\n\n  let mkdocsServerHasStarted = false;\n  const mkdocsLogFunc: LogFunc = data => {\n    // Sometimes the lines contain an unnecessary extra new line\n    const logLines = data.toString().split('\\n');\n    const logPrefix = opts.docker ? '[docker/mkdocs]' : '[mkdocs]';\n    logLines.forEach(line => {\n      if (line === '') {\n        return;\n      }\n\n      logger.verbose(`${logPrefix} ${line}`);\n\n      // When the server has started, open a new browser tab for the user.\n      if (\n        !mkdocsServerHasStarted &&\n        line.includes(`Serving on ${mkdocsExpectedDevAddr}`)\n      ) {\n        mkdocsServerHasStarted = true;\n      }\n    });\n  };\n  // mkdocs writes all of its logs to stderr by default, and not stdout.\n  // https://github.com/mkdocs/mkdocs/issues/879#issuecomment-203536006\n  // Had me questioning this whole implementation for half an hour.\n  logger.info('Starting mkdocs server.');\n  const mkdocsChildProcess = await runMkdocsServer({\n    port: opts.mkdocsPort,\n    dockerImage: opts.dockerImage,\n    dockerEntrypoint: opts.dockerEntrypoint,\n    dockerOptions: opts.dockerOption,\n    useDocker: opts.docker,\n    stdoutLogFunc: mkdocsLogFunc,\n    stderrLogFunc: mkdocsLogFunc,\n    mkdocsConfigFileName: mkdocsYmlPath,\n    mkdocsParameterClean: opts.mkdocsParameterClean,\n    mkdocsParameterDirtyReload: opts.mkdocsParameterDirtyreload,\n    mkdocsParameterStrict: opts.mkdocsParameterStrict,\n  });\n\n  // Wait until mkdocs server has started so that Backstage starts with docs loaded\n  // Takes 1-5 seconds\n  for (let attempt = 0; attempt < 30; attempt++) {\n    await new Promise(r => setTimeout(r, 3000));\n    if (mkdocsServerHasStarted) {\n      break;\n    }\n    logger.info('Waiting for mkdocs server to start...');\n  }\n\n  if (!mkdocsServerHasStarted) {\n    logger.error(\n      'mkdocs server did not start. Exiting. Try re-running command with -v option for more details.',\n    );\n  }\n\n  const port = isDevMode ? backstageBackendPort : opts.previewAppPort;\n  const previewAppPath = getPreviewAppPath(opts);\n  const httpServer = new HTTPServer(\n    previewAppPath,\n    port,\n    mkdocsExpectedDevAddr,\n    opts.verbose,\n  );\n\n  httpServer\n    .serve()\n    .catch(err => {\n      logger.error('Failed to start HTTP server', err);\n      mkdocsChildProcess.kill();\n      process.exit(1);\n    })\n    .then(() => {\n      // The last three things default/component/local/ don't matter. They can be anything.\n      openBrowser(`http://localhost:${port}/docs/default/component/local/`);\n      logger.info(\n        `Serving docs in Backstage at http://localhost:${port}/docs/default/component/local/\\nOpening browser.`,\n      );\n    });\n\n  await waitForSignal([mkdocsChildProcess]);\n\n  if (configIsTemporary) {\n    process.on('exit', async () => {\n      fs.rmSync(mkdocsYmlPath, {});\n    });\n  }\n}\n"],"names":["path","findPaths","createLogger","getMkdocsYml","checkIfDockerIsOperational","runMkdocsServer","httpServer","HTTPServer","openBrowser","waitForSignal","fs"],"mappings":";;;;;;;;;;;;;;;;;;;;;AA4BA,SAAS,qBAAgC,GAAA;AACvC,EAAI,IAAA;AACF,IAAA,OAAOA,qBAAK,CAAA,IAAA;AAAA,MACVA,qBAAK,CAAA,OAAA,CAAQ,OAAQ,CAAA,OAAA,CAAQ,wCAAwC,CAAC,CAAA;AAAA,MACtE,MAAA;AAAA,KACF,CAAA;AAAA,GACM,CAAA,MAAA;AASN,IAAA,OAAOC,mBAAU,CAAA,SAAS,CAAE,CAAA,UAAA,CAAW,mBAAmB,CAAA,CAAA;AAAA,GAC5D;AACF,CAAA;AAEA,SAAS,kBAAkB,IAA4B,EAAA;AACrD,EAAO,OAAA,IAAA,CAAK,wBAAwB,qBAAsB,EAAA,CAAA;AAC5D,CAAA;AAEA,eAA8B,MAAM,IAAoB,EAAA;AACtD,EAAA,MAAM,SAASC,oBAAa,CAAA,EAAE,OAAS,EAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AAKrD,EAAM,MAAA,SAAA,GAAY,OAAO,IAAK,CAAA,OAAA,CAAQ,GAAG,CAAE,CAAA,QAAA,CAAS,uBAAuB,CAAA,GACvE,IACA,GAAA,KAAA,CAAA;AAEJ,EAAA,MAAM,oBAAuB,GAAA,IAAA,CAAA;AAE7B,EAAM,MAAA,gBAAA,GAAmB,CAAkB,eAAA,EAAA,IAAA,CAAK,UAAU,CAAA,CAAA,CAAA;AAC1D,EAAM,MAAA,eAAA,GAAkB,CAAoB,iBAAA,EAAA,IAAA,CAAK,UAAU,CAAA,CAAA,CAAA;AAC3D,EAAM,MAAA,qBAAA,GAAwB,IAAK,CAAA,MAAA,GAC/B,gBACA,GAAA,eAAA,CAAA;AACJ,EAAA,MAAM,uBAAuB,IAAK,CAAA,oBAAA,CAAA;AAClC,EAAA,MAAM,WAAW,IAAK,CAAA,QAAA,CAAA;AAEtB,EAAA,MAAM,EAAE,IAAM,EAAA,aAAA,EAAe,mBAAsB,GAAA,MAAMC,gCAAa,IAAM,EAAA;AAAA,IAC1E,IAAM,EAAA,QAAA;AAAA,IACN,oBAAA;AAAA,GACD,CAAA,CAAA;AAGD,EAAA,IAAI,KAAK,MAAQ,EAAA;AACf,IAAM,MAAA,mBAAA,GAAsB,MAAMC,gCAAA,CAA2B,MAAM,CAAA,CAAA;AACnE,IAAA,IAAI,CAAC,mBAAqB,EAAA;AACxB,MAAA,OAAA;AAAA,KACF;AAAA,GACF;AAEA,EAAA,IAAI,sBAAyB,GAAA,KAAA,CAAA;AAC7B,EAAA,MAAM,gBAAyB,CAAQ,IAAA,KAAA;AAErC,IAAA,MAAM,QAAW,GAAA,IAAA,CAAK,QAAS,EAAA,CAAE,MAAM,IAAI,CAAA,CAAA;AAC3C,IAAM,MAAA,SAAA,GAAY,IAAK,CAAA,MAAA,GAAS,iBAAoB,GAAA,UAAA,CAAA;AACpD,IAAA,QAAA,CAAS,QAAQ,CAAQ,IAAA,KAAA;AACvB,MAAA,IAAI,SAAS,EAAI,EAAA;AACf,QAAA,OAAA;AAAA,OACF;AAEA,MAAA,MAAA,CAAO,OAAQ,CAAA,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,IAAI,CAAE,CAAA,CAAA,CAAA;AAGrC,MAAA,IACE,CAAC,sBACD,IAAA,IAAA,CAAK,SAAS,CAAc,WAAA,EAAA,qBAAqB,EAAE,CACnD,EAAA;AACA,QAAyB,sBAAA,GAAA,IAAA,CAAA;AAAA,OAC3B;AAAA,KACD,CAAA,CAAA;AAAA,GACH,CAAA;AAIA,EAAA,MAAA,CAAO,KAAK,yBAAyB,CAAA,CAAA;AACrC,EAAM,MAAA,kBAAA,GAAqB,MAAMC,4BAAgB,CAAA;AAAA,IAC/C,MAAM,IAAK,CAAA,UAAA;AAAA,IACX,aAAa,IAAK,CAAA,WAAA;AAAA,IAClB,kBAAkB,IAAK,CAAA,gBAAA;AAAA,IACvB,eAAe,IAAK,CAAA,YAAA;AAAA,IACpB,WAAW,IAAK,CAAA,MAAA;AAAA,IAChB,aAAe,EAAA,aAAA;AAAA,IACf,aAAe,EAAA,aAAA;AAAA,IACf,oBAAsB,EAAA,aAAA;AAAA,IACtB,sBAAsB,IAAK,CAAA,oBAAA;AAAA,IAC3B,4BAA4B,IAAK,CAAA,0BAAA;AAAA,IACjC,uBAAuB,IAAK,CAAA,qBAAA;AAAA,GAC7B,CAAA,CAAA;AAID,EAAA,KAAA,IAAS,OAAU,GAAA,CAAA,EAAG,OAAU,GAAA,EAAA,EAAI,OAAW,EAAA,EAAA;AAC7C,IAAA,MAAM,IAAI,OAAQ,CAAA,CAAA,CAAA,KAAK,UAAW,CAAA,CAAA,EAAG,GAAI,CAAC,CAAA,CAAA;AAC1C,IAAA,IAAI,sBAAwB,EAAA;AAC1B,MAAA,MAAA;AAAA,KACF;AACA,IAAA,MAAA,CAAO,KAAK,uCAAuC,CAAA,CAAA;AAAA,GACrD;AAEA,EAAA,IAAI,CAAC,sBAAwB,EAAA;AAC3B,IAAO,MAAA,CAAA,KAAA;AAAA,MACL,+FAAA;AAAA,KACF,CAAA;AAAA,GACF;AAEA,EAAM,MAAA,IAAA,GAAO,SAAY,GAAA,oBAAA,GAAuB,IAAK,CAAA,cAAA,CAAA;AACrD,EAAM,MAAA,cAAA,GAAiB,kBAAkB,IAAI,CAAA,CAAA;AAC7C,EAAA,MAAMC,eAAa,IAAIC,kBAAA;AAAA,IACrB,cAAA;AAAA,IACA,IAAA;AAAA,IACA,qBAAA;AAAA,IACA,IAAK,CAAA,OAAA;AAAA,GACP,CAAA;AAEA,EACGD,YAAA,CAAA,KAAA,EACA,CAAA,KAAA,CAAM,CAAO,GAAA,KAAA;AACZ,IAAO,MAAA,CAAA,KAAA,CAAM,+BAA+B,GAAG,CAAA,CAAA;AAC/C,IAAA,kBAAA,CAAmB,IAAK,EAAA,CAAA;AACxB,IAAA,OAAA,CAAQ,KAAK,CAAC,CAAA,CAAA;AAAA,GACf,CACA,CAAA,IAAA,CAAK,MAAM;AAEV,IAAYE,4BAAA,CAAA,CAAA,iBAAA,EAAoB,IAAI,CAAgC,8BAAA,CAAA,CAAA,CAAA;AACpE,IAAO,MAAA,CAAA,IAAA;AAAA,MACL,iDAAiD,IAAI,CAAA;AAAA,gBAAA,CAAA;AAAA,KACvD,CAAA;AAAA,GACD,CAAA,CAAA;AAEH,EAAM,MAAAC,iBAAA,CAAc,CAAC,kBAAkB,CAAC,CAAA,CAAA;AAExC,EAAA,IAAI,iBAAmB,EAAA;AACrB,IAAQ,OAAA,CAAA,EAAA,CAAG,QAAQ,YAAY;AAC7B,MAAGC,mBAAA,CAAA,MAAA,CAAO,aAAe,EAAA,EAAE,CAAA,CAAA;AAAA,KAC5B,CAAA,CAAA;AAAA,GACH;AACF;;;;"}

package/dist/commands/serve/utils.cjs.js

@@ -0,0 +1,24 @@
+'use strict';
+
+var util = require('util');
+var child_process = require('child_process');
+
+async function checkIfDockerIsOperational(logger) {
+  logger.info("Checking Docker status...");
+  try {
+    const runCheck = util.promisify(child_process.execFile);
+    await runCheck("docker", ["info"], { shell: true });
+    logger.info(
+      "Docker is up and running. Proceed to starting up mkdocs server"
+    );
+    return true;
+  } catch {
+    logger.error(
+      "Docker is not running. Exiting. Please check status of Docker daemon with `docker info` before re-running"
+    );
+    return false;
+  }
+}
+
+exports.checkIfDockerIsOperational = checkIfDockerIsOperational;
+//# sourceMappingURL=utils.cjs.js.map

package/dist/commands/serve/utils.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.cjs.js","sources":["../../../src/commands/serve/utils.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { promisify } from 'util';\nimport * as winston from 'winston';\nimport { execFile } from 'child_process';\n\nexport async function checkIfDockerIsOperational(\n  logger: winston.Logger,\n): Promise<boolean> {\n  logger.info('Checking Docker status...');\n  try {\n    const runCheck = promisify(execFile);\n    await runCheck('docker', ['info'], { shell: true });\n    logger.info(\n      'Docker is up and running. Proceed to starting up mkdocs server',\n    );\n    return true;\n  } catch {\n    logger.error(\n      'Docker is not running. Exiting. Please check status of Docker daemon with `docker info` before re-running',\n    );\n    return false;\n  }\n}\n"],"names":["promisify","execFile"],"mappings":";;;;;AAoBA,eAAsB,2BACpB,MACkB,EAAA;AAClB,EAAA,MAAA,CAAO,KAAK,2BAA2B,CAAA,CAAA;AACvC,EAAI,IAAA;AACF,IAAM,MAAA,QAAA,GAAWA,eAAUC,sBAAQ,CAAA,CAAA;AACnC,IAAM,MAAA,QAAA,CAAS,UAAU,CAAC,MAAM,GAAG,EAAE,KAAA,EAAO,MAAM,CAAA,CAAA;AAClD,IAAO,MAAA,CAAA,IAAA;AAAA,MACL,gEAAA;AAAA,KACF,CAAA;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACD,CAAA,MAAA;AACN,IAAO,MAAA,CAAA,KAAA;AAAA,MACL,2GAAA;AAAA,KACF,CAAA;AACA,IAAO,OAAA,KAAA,CAAA;AAAA,GACT;AACF;;;;"}