@techdocs/cli 1.13.0 → 1.14.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @techdocs/cli
 
+## 1.14.0-next.0
+
+### Minor Changes
+
+- a4604d2: Add Zensical support to `serve`, `serve:raw` and `generate` via `--engine zensical` (or the `backstage.io/techdocs-engine` annotation in `catalog-info.yaml`), including live reload in the preview app. The default `--docker-image` is now chosen per engine instead of always being `spotify/techdocs`, and matches the image the TechDocs backend uses for that engine, so MkDocs previews now use `spotify/techdocs:v1.2.8` instead of `latest`. Passing `--docker-image` explicitly behaves as before.
+
+  The `serve` flags `--mkdocs-port`, `--mkdocs-config-file-name` and `--mkdocs-parameter-*` are deprecated in favor of `--engine-port`, `--config-file-name` and `--parameter-*`. If both the old and new flag are given, the new one wins and the warning says the old one is ignored.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-defaults@0.18.2-next.0
+  - @backstage/plugin-techdocs-node@2.2.0-next.0
+  - @backstage/backend-plugin-api@1.11.1-next.0
+
 ## 1.13.0
 
 ### Minor Changes

package/dist/commands/generate/generate.cjs.js

@@ -9,7 +9,7 @@ var pluginTechdocsNode = require('@backstage/plugin-techdocs-node');
 var config = require('@backstage/config');
 var utility = require('../../lib/utility.cjs.js');
 var etag = require('../../lib/etag.cjs.js');
-var engineConfig = require('../../lib/engineConfig.cjs.js');
+var registry = require('../../lib/engines/registry.cjs.js');
 var catalogEntity = require('../../lib/catalogEntity.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
@@ -35,8 +35,8 @@ async function generate(opts) {
     source: engineSource,
     entity: catalogEntity$1
   } = await catalogEntity.resolveEngine(sourceDir, opts.engine, logger);
-  const engineConfig$1 = engineConfig.getEngineConfig(engine, engineSource);
-  logger.info(`Using engine: ${engine} (binary: ${engineConfig$1.binary})`);
+  const engineConfig = registry.getEngineConfig(engine, engineSource);
+  logger.info(`Using engine: ${engine} (binary: ${engineConfig.binary})`);
   const outputDir = path.resolve(opts.outputDir);
   const omitTechdocsCorePlugin = opts.omitTechdocsCoreMkdocsPlugin;
   const dockerImage = opts.dockerImage;
@@ -84,6 +84,12 @@ async function generate(opts) {
   const generators = await pluginTechdocsNode.Generators.fromConfig(config$1, {
     logger
   });
+  if (engineConfig.createGenerator) {
+    generators.register(
+      engine,
+      engineConfig.createGenerator(config$1, { logger })
+    );
+  }
   const baseEntity = catalogEntity$1 ?? {
     apiVersion: "backstage.io/v1alpha1",
     kind: "Component",

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

@@ -1 +1 @@
-{"version":3,"file":"generate.cjs.js","sources":["../../../src/commands/generate/generate.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 { join, resolve } from 'node:path';\nimport { OptionValues } from 'commander';\nimport fs from 'fs-extra';\nimport JSON5 from 'json5';\nimport {\n  Generators,\n  ParsedLocationAnnotation,\n  getMkdocsYml,\n  TECHDOCS_ENGINE_CATALOG_ANNOTATION_KEY,\n} from '@backstage/plugin-techdocs-node';\nimport { ConfigReader } from '@backstage/config';\nimport { Entity } from '@backstage/catalog-model';\nimport {\n  convertTechDocsRefToLocationAnnotation,\n  createLogger,\n  getLogStream,\n} from '../../lib/utility';\nimport { computeDirectoryEtag } from '../../lib/etag';\nimport { getEngineConfig } from '../../lib/engineConfig';\nimport { resolveEngine } from '../../lib/catalogEntity';\n\nconst TECHDOCS_METADATA_FILE = 'techdocs_metadata.json';\nconst GENERATED_SITE_ETAG_EXCLUDED_FILES = [\n  TECHDOCS_METADATA_FILE,\n  // The compressed sitemap can include gzip metadata that changes between\n  // otherwise identical generated sites; sitemap.xml still captures content.\n  'sitemap.xml.gz',\n  // mkdocs writes build-date lastmod entries into sitemap.xml, so the hash\n  // changes daily even when the documentation content is identical.\n  'sitemap.xml',\n];\n\nexport default async function generate(opts: OptionValues) {\n  // Use techdocs-node package to generate docs. Keep consistency between Backstage and CI generating docs.\n  // Docs can be prepared using actions/checkout or git clone, or similar paradigms on CI. The TechDocs CI workflow\n  // will run on the CI pipeline containing the documentation files.\n\n  const logger = createLogger({ verbose: opts.verbose });\n  const sourceDir = resolve(opts.sourceDir);\n\n  const {\n    engine,\n    source: engineSource,\n    entity: catalogEntity,\n  } = await resolveEngine(sourceDir, opts.engine, logger);\n\n  const engineConfig = getEngineConfig(engine, engineSource);\n  logger.info(`Using engine: ${engine} (binary: ${engineConfig.binary})`);\n  const outputDir = resolve(opts.outputDir);\n  const omitTechdocsCorePlugin = opts.omitTechdocsCoreMkdocsPlugin;\n  const dockerImage = opts.dockerImage;\n  const pullImage = opts.pull;\n  const legacyCopyReadmeMdToIndexMd = opts.legacyCopyReadmeMdToIndexMd;\n  const disableExternalFonts = opts.disableExternalFonts;\n  const defaultPlugins = opts.defaultPlugin;\n  const dangerouslyAllowAdditionalKeys = opts.dangerouslyAllowAdditionalKeys;\n\n  logger.info(`Using source dir ${sourceDir}`);\n  logger.info(`Will output generated files in ${outputDir}`);\n\n  logger.verbose('Creating output directory if it does not exist.');\n\n  await fs.ensureDir(outputDir);\n\n  const { path: mkdocsYmlPath, configIsTemporary } = await getMkdocsYml(\n    sourceDir,\n  );\n\n  const config = new ConfigReader({\n    techdocs: {\n      generator: {\n        runIn: opts.docker ? 'docker' : 'local',\n        dockerImage,\n        pullImage,\n        defaultEngine: engine,\n        mkdocs: {\n          legacyCopyReadmeMdToIndexMd,\n          omitTechdocsCorePlugin,\n          disableExternalFonts,\n          defaultPlugins,\n          dangerouslyAllowAdditionalKeys,\n        },\n      },\n    },\n  });\n\n  let parsedLocationAnnotation = {} as ParsedLocationAnnotation;\n  if (opts.techdocsRef) {\n    try {\n      parsedLocationAnnotation = convertTechDocsRefToLocationAnnotation(\n        opts.techdocsRef,\n      );\n    } catch (err) {\n      logger.error(err.message);\n    }\n  }\n\n  const hasExplicitEtag = opts.etag !== undefined;\n  const etag = hasExplicitEtag ? opts.etag : undefined;\n\n  // Generate docs using @backstage/plugin-techdocs-node\n  const generators = await Generators.fromConfig(config, {\n    logger,\n  });\n\n  // Stamp the resolved engine onto the entity so that an explicit --engine\n  // flag takes precedence over the catalog annotation in generators.get().\n  const baseEntity: Entity = catalogEntity ?? {\n    apiVersion: 'backstage.io/v1alpha1',\n    kind: 'Component',\n    metadata: { name: 'local' },\n  };\n  const entity: Entity = {\n    ...baseEntity,\n    metadata: {\n      ...baseEntity.metadata,\n      annotations: {\n        ...baseEntity.metadata.annotations,\n        [TECHDOCS_ENGINE_CATALOG_ANNOTATION_KEY]: engine,\n      },\n    },\n  };\n  const generator = generators.get(entity);\n\n  logger.info('Generating documentation...');\n\n  await generator.run({\n    inputDir: sourceDir,\n    outputDir,\n    ...(opts.techdocsRef\n      ? {\n          parsedLocationAnnotation,\n        }\n      : {}),\n    logger,\n    etag,\n    logStream: getLogStream(logger),\n    siteOptions: { name: opts.siteName },\n    runAsDefaultUser: opts.runAsDefaultUser,\n  });\n\n  if (!hasExplicitEtag) {\n    const generatedSiteEtag = await computeDirectoryEtag(outputDir, {\n      exclude: GENERATED_SITE_ETAG_EXCLUDED_FILES,\n    });\n    const metadataPath = join(outputDir, TECHDOCS_METADATA_FILE);\n    const metadata = JSON5.parse(await fs.readFile(metadataPath, 'utf8'));\n    await fs.writeJson(\n      metadataPath,\n      { ...metadata, etag: generatedSiteEtag },\n      { spaces: 2 },\n    );\n    logger.info(`Computed generated site content hash: ${generatedSiteEtag}`);\n  }\n\n  if (configIsTemporary) {\n    process.on('exit', async () => {\n      fs.rmSync(mkdocsYmlPath, {});\n    });\n  }\n\n  logger.info('Done!');\n}\n"],"names":["createLogger","resolve","catalogEntity","resolveEngine","engineConfig","getEngineConfig","fs","getMkdocsYml","config","ConfigReader","convertTechDocsRefToLocationAnnotation","etag","Generators","TECHDOCS_ENGINE_CATALOG_ANNOTATION_KEY","getLogStream","computeDirectoryEtag","join","JSON5"],"mappings":";;;;;;;;;;;;;;;;;;;AAqCA,MAAM,sBAAA,GAAyB,wBAAA;AAC/B,MAAM,kCAAA,GAAqC;AAAA,EACzC,sBAAA;AAAA;AAAA;AAAA,EAGA,gBAAA;AAAA;AAAA;AAAA,EAGA;AACF,CAAA;AAEA,eAA8B,SAAS,IAAA,EAAoB;AAKzD,EAAA,MAAM,SAASA,oBAAA,CAAa,EAAE,OAAA,EAAS,IAAA,CAAK,SAAS,CAAA;AACrD,EAAA,MAAM,SAAA,GAAYC,YAAA,CAAQ,IAAA,CAAK,SAAS,CAAA;AAExC,EAAA,MAAM;AAAA,IACJ,MAAA;AAAA,IACA,MAAA,EAAQ,YAAA;AAAA,IACR,MAAA,EAAQC;AAAA,MACN,MAAMC,2BAAA,CAAc,SAAA,EAAW,IAAA,CAAK,QAAQ,MAAM,CAAA;AAEtD,EAAA,MAAMC,cAAA,GAAeC,4BAAA,CAAgB,MAAA,EAAQ,YAAY,CAAA;AACzD,EAAA,MAAA,CAAO,KAAK,CAAA,cAAA,EAAiB,MAAM,CAAA,UAAA,EAAaD,cAAA,CAAa,MAAM,CAAA,CAAA,CAAG,CAAA;AACtE,EAAA,MAAM,SAAA,GAAYH,YAAA,CAAQ,IAAA,CAAK,SAAS,CAAA;AACxC,EAAA,MAAM,yBAAyB,IAAA,CAAK,4BAAA;AACpC,EAAA,MAAM,cAAc,IAAA,CAAK,WAAA;AACzB,EAAA,MAAM,YAAY,IAAA,CAAK,IAAA;AACvB,EAAA,MAAM,8BAA8B,IAAA,CAAK,2BAAA;AACzC,EAAA,MAAM,uBAAuB,IAAA,CAAK,oBAAA;AAClC,EAAA,MAAM,iBAAiB,IAAA,CAAK,aAAA;AAC5B,EAAA,MAAM,iCAAiC,IAAA,CAAK,8BAAA;AAE5C,EAAA,MAAA,CAAO,IAAA,CAAK,CAAA,iBAAA,EAAoB,SAAS,CAAA,CAAE,CAAA;AAC3C,EAAA,MAAA,CAAO,IAAA,CAAK,CAAA,+BAAA,EAAkC,SAAS,CAAA,CAAE,CAAA;AAEzD,EAAA,MAAA,CAAO,QAAQ,iDAAiD,CAAA;AAEhE,EAAA,MAAMK,mBAAA,CAAG,UAAU,SAAS,CAAA;AAE5B,EAAA,MAAM,EAAE,IAAA,EAAM,aAAA,EAAe,iBAAA,KAAsB,MAAMC,+BAAA;AAAA,IACvD;AAAA,GACF;AAEA,EAAA,MAAMC,QAAA,GAAS,IAAIC,mBAAA,CAAa;AAAA,IAC9B,QAAA,EAAU;AAAA,MACR,SAAA,EAAW;AAAA,QACT,KAAA,EAAO,IAAA,CAAK,MAAA,GAAS,QAAA,GAAW,OAAA;AAAA,QAChC,WAAA;AAAA,QACA,SAAA;AAAA,QACA,aAAA,EAAe,MAAA;AAAA,QACf,MAAA,EAAQ;AAAA,UACN,2BAAA;AAAA,UACA,sBAAA;AAAA,UACA,oBAAA;AAAA,UACA,cAAA;AAAA,UACA;AAAA;AACF;AACF;AACF,GACD,CAAA;AAED,EAAA,IAAI,2BAA2B,EAAC;AAChC,EAAA,IAAI,KAAK,WAAA,EAAa;AACpB,IAAA,IAAI;AACF,MAAA,wBAAA,GAA2BC,8CAAA;AAAA,QACzB,IAAA,CAAK;AAAA,OACP;AAAA,IACF,SAAS,GAAA,EAAK;AACZ,MAAA,MAAA,CAAO,KAAA,CAAM,IAAI,OAAO,CAAA;AAAA,IAC1B;AAAA,EACF;AAEA,EAAA,MAAM,eAAA,GAAkB,KAAK,IAAA,KAAS,MAAA;AACtC,EAAA,MAAMC,MAAA,GAAO,eAAA,GAAkB,IAAA,CAAK,IAAA,GAAO,MAAA;AAG3C,EAAA,MAAM,UAAA,GAAa,MAAMC,6BAAA,CAAW,UAAA,CAAWJ,QAAA,EAAQ;AAAA,IACrD;AAAA,GACD,CAAA;AAID,EAAA,MAAM,aAAqBN,eAAA,IAAiB;AAAA,IAC1C,UAAA,EAAY,uBAAA;AAAA,IACZ,IAAA,EAAM,WAAA;AAAA,IACN,QAAA,EAAU,EAAE,IAAA,EAAM,OAAA;AAAQ,GAC5B;AACA,EAAA,MAAM,MAAA,GAAiB;AAAA,IACrB,GAAG,UAAA;AAAA,IACH,QAAA,EAAU;AAAA,MACR,GAAG,UAAA,CAAW,QAAA;AAAA,MACd,WAAA,EAAa;AAAA,QACX,GAAG,WAAW,QAAA,CAAS,WAAA;AAAA,QACvB,CAACW,yDAAsC,GAAG;AAAA;AAC5C;AACF,GACF;AACA,EAAA,MAAM,SAAA,GAAY,UAAA,CAAW,GAAA,CAAI,MAAM,CAAA;AAEvC,EAAA,MAAA,CAAO,KAAK,6BAA6B,CAAA;AAEzC,EAAA,MAAM,UAAU,GAAA,CAAI;AAAA,IAClB,QAAA,EAAU,SAAA;AAAA,IACV,SAAA;AAAA,IACA,GAAI,KAAK,WAAA,GACL;AAAA,MACE;AAAA,QAEF,EAAC;AAAA,IACL,MAAA;AAAA,UACAF,MAAA;AAAA,IACA,SAAA,EAAWG,qBAAa,MAAM,CAAA;AAAA,IAC9B,WAAA,EAAa,EAAE,IAAA,EAAM,IAAA,CAAK,QAAA,EAAS;AAAA,IACnC,kBAAkB,IAAA,CAAK;AAAA,GACxB,CAAA;AAED,EAAA,IAAI,CAAC,eAAA,EAAiB;AACpB,IAAA,MAAM,iBAAA,GAAoB,MAAMC,yBAAA,CAAqB,SAAA,EAAW;AAAA,MAC9D,OAAA,EAAS;AAAA,KACV,CAAA;AACD,IAAA,MAAM,YAAA,GAAeC,SAAA,CAAK,SAAA,EAAW,sBAAsB,CAAA;AAC3D,IAAA,MAAM,QAAA,GAAWC,uBAAM,KAAA,CAAM,MAAMX,oBAAG,QAAA,CAAS,YAAA,EAAc,MAAM,CAAC,CAAA;AACpE,IAAA,MAAMA,mBAAA,CAAG,SAAA;AAAA,MACP,YAAA;AAAA,MACA,EAAE,GAAG,QAAA,EAAU,IAAA,EAAM,iBAAA,EAAkB;AAAA,MACvC,EAAE,QAAQ,CAAA;AAAE,KACd;AACA,IAAA,MAAA,CAAO,IAAA,CAAK,CAAA,sCAAA,EAAyC,iBAAiB,CAAA,CAAE,CAAA;AAAA,EAC1E;AAEA,EAAA,IAAI,iBAAA,EAAmB;AACrB,IAAA,OAAA,CAAQ,EAAA,CAAG,QAAQ,YAAY;AAC7B,MAAAA,mBAAA,CAAG,MAAA,CAAO,aAAA,EAAe,EAAE,CAAA;AAAA,IAC7B,CAAC,CAAA;AAAA,EACH;AAEA,EAAA,MAAA,CAAO,KAAK,OAAO,CAAA;AACrB;;"}
+{"version":3,"file":"generate.cjs.js","sources":["../../../src/commands/generate/generate.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 { join, resolve } from 'node:path';\nimport { OptionValues } from 'commander';\nimport fs from 'fs-extra';\nimport JSON5 from 'json5';\nimport {\n  Generators,\n  ParsedLocationAnnotation,\n  getMkdocsYml,\n  TECHDOCS_ENGINE_CATALOG_ANNOTATION_KEY,\n} from '@backstage/plugin-techdocs-node';\nimport { ConfigReader } from '@backstage/config';\nimport { Entity } from '@backstage/catalog-model';\nimport {\n  convertTechDocsRefToLocationAnnotation,\n  createLogger,\n  getLogStream,\n} from '../../lib/utility';\nimport { computeDirectoryEtag } from '../../lib/etag';\nimport { getEngineConfig } from '../../lib/engines';\nimport { resolveEngine } from '../../lib/catalogEntity';\n\nconst TECHDOCS_METADATA_FILE = 'techdocs_metadata.json';\nconst GENERATED_SITE_ETAG_EXCLUDED_FILES = [\n  TECHDOCS_METADATA_FILE,\n  // The compressed sitemap can include gzip metadata that changes between\n  // otherwise identical generated sites; sitemap.xml still captures content.\n  'sitemap.xml.gz',\n  // mkdocs writes build-date lastmod entries into sitemap.xml, so the hash\n  // changes daily even when the documentation content is identical.\n  'sitemap.xml',\n];\n\nexport default async function generate(opts: OptionValues) {\n  // Use techdocs-node package to generate docs. Keep consistency between Backstage and CI generating docs.\n  // Docs can be prepared using actions/checkout or git clone, or similar paradigms on CI. The TechDocs CI workflow\n  // will run on the CI pipeline containing the documentation files.\n\n  const logger = createLogger({ verbose: opts.verbose });\n  const sourceDir = resolve(opts.sourceDir);\n\n  const {\n    engine,\n    source: engineSource,\n    entity: catalogEntity,\n  } = await resolveEngine(sourceDir, opts.engine, logger);\n\n  const engineConfig = getEngineConfig(engine, engineSource);\n  logger.info(`Using engine: ${engine} (binary: ${engineConfig.binary})`);\n  const outputDir = resolve(opts.outputDir);\n  const omitTechdocsCorePlugin = opts.omitTechdocsCoreMkdocsPlugin;\n  const dockerImage = opts.dockerImage;\n  const pullImage = opts.pull;\n  const legacyCopyReadmeMdToIndexMd = opts.legacyCopyReadmeMdToIndexMd;\n  const disableExternalFonts = opts.disableExternalFonts;\n  const defaultPlugins = opts.defaultPlugin;\n  const dangerouslyAllowAdditionalKeys = opts.dangerouslyAllowAdditionalKeys;\n\n  logger.info(`Using source dir ${sourceDir}`);\n  logger.info(`Will output generated files in ${outputDir}`);\n\n  logger.verbose('Creating output directory if it does not exist.');\n\n  await fs.ensureDir(outputDir);\n\n  const { path: mkdocsYmlPath, configIsTemporary } = await getMkdocsYml(\n    sourceDir,\n  );\n\n  const config = new ConfigReader({\n    techdocs: {\n      generator: {\n        runIn: opts.docker ? 'docker' : 'local',\n        dockerImage,\n        pullImage,\n        defaultEngine: engine,\n        mkdocs: {\n          legacyCopyReadmeMdToIndexMd,\n          omitTechdocsCorePlugin,\n          disableExternalFonts,\n          defaultPlugins,\n          dangerouslyAllowAdditionalKeys,\n        },\n      },\n    },\n  });\n\n  let parsedLocationAnnotation = {} as ParsedLocationAnnotation;\n  if (opts.techdocsRef) {\n    try {\n      parsedLocationAnnotation = convertTechDocsRefToLocationAnnotation(\n        opts.techdocsRef,\n      );\n    } catch (err) {\n      logger.error(err.message);\n    }\n  }\n\n  const hasExplicitEtag = opts.etag !== undefined;\n  const etag = hasExplicitEtag ? opts.etag : undefined;\n\n  // Generate docs using @backstage/plugin-techdocs-node\n  const generators = await Generators.fromConfig(config, {\n    logger,\n  });\n  // Engines other than MkDocs ship their own generator; register the one for\n  // the detected engine so generators.get() below can resolve it.\n  if (engineConfig.createGenerator) {\n    generators.register(\n      engine,\n      engineConfig.createGenerator(config, { logger }),\n    );\n  }\n\n  // Stamp the resolved engine onto the entity so that an explicit --engine\n  // flag takes precedence over the catalog annotation in generators.get().\n  const baseEntity: Entity = catalogEntity ?? {\n    apiVersion: 'backstage.io/v1alpha1',\n    kind: 'Component',\n    metadata: { name: 'local' },\n  };\n  const entity: Entity = {\n    ...baseEntity,\n    metadata: {\n      ...baseEntity.metadata,\n      annotations: {\n        ...baseEntity.metadata.annotations,\n        [TECHDOCS_ENGINE_CATALOG_ANNOTATION_KEY]: engine,\n      },\n    },\n  };\n  const generator = generators.get(entity);\n\n  logger.info('Generating documentation...');\n\n  await generator.run({\n    inputDir: sourceDir,\n    outputDir,\n    ...(opts.techdocsRef\n      ? {\n          parsedLocationAnnotation,\n        }\n      : {}),\n    logger,\n    etag,\n    logStream: getLogStream(logger),\n    siteOptions: { name: opts.siteName },\n    runAsDefaultUser: opts.runAsDefaultUser,\n  });\n\n  if (!hasExplicitEtag) {\n    const generatedSiteEtag = await computeDirectoryEtag(outputDir, {\n      exclude: GENERATED_SITE_ETAG_EXCLUDED_FILES,\n    });\n    const metadataPath = join(outputDir, TECHDOCS_METADATA_FILE);\n    const metadata = JSON5.parse(await fs.readFile(metadataPath, 'utf8'));\n    await fs.writeJson(\n      metadataPath,\n      { ...metadata, etag: generatedSiteEtag },\n      { spaces: 2 },\n    );\n    logger.info(`Computed generated site content hash: ${generatedSiteEtag}`);\n  }\n\n  if (configIsTemporary) {\n    process.on('exit', async () => {\n      fs.rmSync(mkdocsYmlPath, {});\n    });\n  }\n\n  logger.info('Done!');\n}\n"],"names":["createLogger","resolve","catalogEntity","resolveEngine","getEngineConfig","fs","getMkdocsYml","config","ConfigReader","convertTechDocsRefToLocationAnnotation","etag","Generators","TECHDOCS_ENGINE_CATALOG_ANNOTATION_KEY","getLogStream","computeDirectoryEtag","join","JSON5"],"mappings":";;;;;;;;;;;;;;;;;;;AAqCA,MAAM,sBAAA,GAAyB,wBAAA;AAC/B,MAAM,kCAAA,GAAqC;AAAA,EACzC,sBAAA;AAAA;AAAA;AAAA,EAGA,gBAAA;AAAA;AAAA;AAAA,EAGA;AACF,CAAA;AAEA,eAA8B,SAAS,IAAA,EAAoB;AAKzD,EAAA,MAAM,SAASA,oBAAA,CAAa,EAAE,OAAA,EAAS,IAAA,CAAK,SAAS,CAAA;AACrD,EAAA,MAAM,SAAA,GAAYC,YAAA,CAAQ,IAAA,CAAK,SAAS,CAAA;AAExC,EAAA,MAAM;AAAA,IACJ,MAAA;AAAA,IACA,MAAA,EAAQ,YAAA;AAAA,IACR,MAAA,EAAQC;AAAA,MACN,MAAMC,2BAAA,CAAc,SAAA,EAAW,IAAA,CAAK,QAAQ,MAAM,CAAA;AAEtD,EAAA,MAAM,YAAA,GAAeC,wBAAA,CAAgB,MAAA,EAAQ,YAAY,CAAA;AACzD,EAAA,MAAA,CAAO,KAAK,CAAA,cAAA,EAAiB,MAAM,CAAA,UAAA,EAAa,YAAA,CAAa,MAAM,CAAA,CAAA,CAAG,CAAA;AACtE,EAAA,MAAM,SAAA,GAAYH,YAAA,CAAQ,IAAA,CAAK,SAAS,CAAA;AACxC,EAAA,MAAM,yBAAyB,IAAA,CAAK,4BAAA;AACpC,EAAA,MAAM,cAAc,IAAA,CAAK,WAAA;AACzB,EAAA,MAAM,YAAY,IAAA,CAAK,IAAA;AACvB,EAAA,MAAM,8BAA8B,IAAA,CAAK,2BAAA;AACzC,EAAA,MAAM,uBAAuB,IAAA,CAAK,oBAAA;AAClC,EAAA,MAAM,iBAAiB,IAAA,CAAK,aAAA;AAC5B,EAAA,MAAM,iCAAiC,IAAA,CAAK,8BAAA;AAE5C,EAAA,MAAA,CAAO,IAAA,CAAK,CAAA,iBAAA,EAAoB,SAAS,CAAA,CAAE,CAAA;AAC3C,EAAA,MAAA,CAAO,IAAA,CAAK,CAAA,+BAAA,EAAkC,SAAS,CAAA,CAAE,CAAA;AAEzD,EAAA,MAAA,CAAO,QAAQ,iDAAiD,CAAA;AAEhE,EAAA,MAAMI,mBAAA,CAAG,UAAU,SAAS,CAAA;AAE5B,EAAA,MAAM,EAAE,IAAA,EAAM,aAAA,EAAe,iBAAA,KAAsB,MAAMC,+BAAA;AAAA,IACvD;AAAA,GACF;AAEA,EAAA,MAAMC,QAAA,GAAS,IAAIC,mBAAA,CAAa;AAAA,IAC9B,QAAA,EAAU;AAAA,MACR,SAAA,EAAW;AAAA,QACT,KAAA,EAAO,IAAA,CAAK,MAAA,GAAS,QAAA,GAAW,OAAA;AAAA,QAChC,WAAA;AAAA,QACA,SAAA;AAAA,QACA,aAAA,EAAe,MAAA;AAAA,QACf,MAAA,EAAQ;AAAA,UACN,2BAAA;AAAA,UACA,sBAAA;AAAA,UACA,oBAAA;AAAA,UACA,cAAA;AAAA,UACA;AAAA;AACF;AACF;AACF,GACD,CAAA;AAED,EAAA,IAAI,2BAA2B,EAAC;AAChC,EAAA,IAAI,KAAK,WAAA,EAAa;AACpB,IAAA,IAAI;AACF,MAAA,wBAAA,GAA2BC,8CAAA;AAAA,QACzB,IAAA,CAAK;AAAA,OACP;AAAA,IACF,SAAS,GAAA,EAAK;AACZ,MAAA,MAAA,CAAO,KAAA,CAAM,IAAI,OAAO,CAAA;AAAA,IAC1B;AAAA,EACF;AAEA,EAAA,MAAM,eAAA,GAAkB,KAAK,IAAA,KAAS,MAAA;AACtC,EAAA,MAAMC,MAAA,GAAO,eAAA,GAAkB,IAAA,CAAK,IAAA,GAAO,MAAA;AAG3C,EAAA,MAAM,UAAA,GAAa,MAAMC,6BAAA,CAAW,UAAA,CAAWJ,QAAA,EAAQ;AAAA,IACrD;AAAA,GACD,CAAA;AAGD,EAAA,IAAI,aAAa,eAAA,EAAiB;AAChC,IAAA,UAAA,CAAW,QAAA;AAAA,MACT,MAAA;AAAA,MACA,YAAA,CAAa,eAAA,CAAgBA,QAAA,EAAQ,EAAE,QAAQ;AAAA,KACjD;AAAA,EACF;AAIA,EAAA,MAAM,aAAqBL,eAAA,IAAiB;AAAA,IAC1C,UAAA,EAAY,uBAAA;AAAA,IACZ,IAAA,EAAM,WAAA;AAAA,IACN,QAAA,EAAU,EAAE,IAAA,EAAM,OAAA;AAAQ,GAC5B;AACA,EAAA,MAAM,MAAA,GAAiB;AAAA,IACrB,GAAG,UAAA;AAAA,IACH,QAAA,EAAU;AAAA,MACR,GAAG,UAAA,CAAW,QAAA;AAAA,MACd,WAAA,EAAa;AAAA,QACX,GAAG,WAAW,QAAA,CAAS,WAAA;AAAA,QACvB,CAACU,yDAAsC,GAAG;AAAA;AAC5C;AACF,GACF;AACA,EAAA,MAAM,SAAA,GAAY,UAAA,CAAW,GAAA,CAAI,MAAM,CAAA;AAEvC,EAAA,MAAA,CAAO,KAAK,6BAA6B,CAAA;AAEzC,EAAA,MAAM,UAAU,GAAA,CAAI;AAAA,IAClB,QAAA,EAAU,SAAA;AAAA,IACV,SAAA;AAAA,IACA,GAAI,KAAK,WAAA,GACL;AAAA,MACE;AAAA,QAEF,EAAC;AAAA,IACL,MAAA;AAAA,UACAF,MAAA;AAAA,IACA,SAAA,EAAWG,qBAAa,MAAM,CAAA;AAAA,IAC9B,WAAA,EAAa,EAAE,IAAA,EAAM,IAAA,CAAK,QAAA,EAAS;AAAA,IACnC,kBAAkB,IAAA,CAAK;AAAA,GACxB,CAAA;AAED,EAAA,IAAI,CAAC,eAAA,EAAiB;AACpB,IAAA,MAAM,iBAAA,GAAoB,MAAMC,yBAAA,CAAqB,SAAA,EAAW;AAAA,MAC9D,OAAA,EAAS;AAAA,KACV,CAAA;AACD,IAAA,MAAM,YAAA,GAAeC,SAAA,CAAK,SAAA,EAAW,sBAAsB,CAAA;AAC3D,IAAA,MAAM,QAAA,GAAWC,uBAAM,KAAA,CAAM,MAAMX,oBAAG,QAAA,CAAS,YAAA,EAAc,MAAM,CAAC,CAAA;AACpE,IAAA,MAAMA,mBAAA,CAAG,SAAA;AAAA,MACP,YAAA;AAAA,MACA,EAAE,GAAG,QAAA,EAAU,IAAA,EAAM,iBAAA,EAAkB;AAAA,MACvC,EAAE,QAAQ,CAAA;AAAE,KACd;AACA,IAAA,MAAA,CAAO,IAAA,CAAK,CAAA,sCAAA,EAAyC,iBAAiB,CAAA,CAAE,CAAA;AAAA,EAC1E;AAEA,EAAA,IAAI,iBAAA,EAAmB;AACrB,IAAA,OAAA,CAAQ,EAAA,CAAG,QAAQ,YAAY;AAC7B,MAAAA,mBAAA,CAAG,MAAA,CAAO,aAAA,EAAe,EAAE,CAAA;AAAA,IAC7B,CAAC,CAAA;AAAA,EACH;AAEA,EAAA,MAAA,CAAO,KAAK,OAAO,CAAA;AACrB;;"}

package/dist/commands/index.cjs.js

@@ -1,11 +1,10 @@
 'use strict';
 
-var pluginTechdocsNode = require('@backstage/plugin-techdocs-node');
-
-const defaultDockerImage = pluginTechdocsNode.TechdocsGenerator.defaultDockerImage;
 const defaultPreviewAppPort = "3000";
 function registerCommands(program) {
-  program.command("generate").description("Generate TechDocs documentation site using MkDocs.").option(
+  program.command("generate").description(
+    "Generate a TechDocs documentation site with the selected engine (MkDocs by default)."
+  ).option(
     "--source-dir <PATH>",
     "Source directory containing mkdocs.yml and docs/ directory.",
     "."
@@ -15,11 +14,10 @@ function registerCommands(program) {
     "./site/"
   ).option(
     "--docker-image <DOCKER_IMAGE>",
-    "The mkdocs docker container to use",
-    defaultDockerImage
+    "Docker image to use. Defaults to the selected engine's image."
   ).option("--no-pull", "Do not pull the latest docker image").option(
     "--no-docker",
-    "Do not use Docker, use MkDocs executable and plugins in current user environment."
+    "Do not use Docker, run the engine and its plugins in the current user environment."
   ).option(
     "--techdocs-ref <HOST_TYPE:URL>",
     "The repository hosting documentation source files e.g. url:https://ghe.mycompany.net.com/org/repo.\nThis value is same as the backstage.io/techdocs-ref annotation of the corresponding Backstage entity.\nIt is completely fine to skip this as it is only being used to set repo_url in mkdocs.yml if not found.\n"
@@ -28,7 +26,7 @@ function registerCommands(program) {
     "A unique identifier for the prepared tree e.g. commit SHA. If provided it will be stored in techdocs_metadata.json. If omitted, a sha256 content hash of the generated site output is computed automatically."
   ).option(
     "--site-name",
-    "Name for site when using default MkDocs config",
+    "Name for site when using the default config",
     "Documentation Site"
   ).option("-v, --verbose", "Enable verbose output.", false).option(
     "--omitTechdocsCoreMkdocsPlugin",
@@ -170,8 +168,7 @@ function registerCommands(program) {
     "Serve a documentation project locally using the configured engine."
   ).option(
     "-i, --docker-image <DOCKER_IMAGE>",
-    "The docker container to use",
-    defaultDockerImage
+    "Docker image to use. Defaults to the selected engine's image."
   ).option(
     "--docker-entrypoint <DOCKER_ENTRYPOINT>",
     "Override the image entrypoint"
@@ -180,10 +177,10 @@ function registerCommands(program) {
     'Extra options to pass to the docker run command, e.g. "--add-host=internal.host:192.168.11.12" (can be added multiple times).'
   ).option(
     "--no-docker",
-    "Do not use Docker, run the engine serve command in current user environment."
+    "Do not use Docker, run the engine serve command in the current user environment."
   ).option(
     "--site-name",
-    "Name for site when using default config",
+    "Name for site when using the default config",
     "Documentation Site"
   ).option("-p, --port <PORT>", "Port to serve documentation locally", "8000").option("-v, --verbose", "Enable verbose output.", false).option(
     "--engine <ENGINE>",
@@ -193,8 +190,7 @@ function registerCommands(program) {
     "[Deprecated: use serve:raw] Serve a documentation project locally."
   ).option(
     "-i, --docker-image <DOCKER_IMAGE>",
-    "The mkdocs docker container to use",
-    defaultDockerImage
+    "Docker image to use. Defaults to the selected engine's image."
   ).option(
     "--docker-entrypoint <DOCKER_ENTRYPOINT>",
     "Override the image entrypoint"
@@ -206,22 +202,19 @@ function registerCommands(program) {
     "Do not use Docker, run `mkdocs serve` in current user environment."
   ).option(
     "--site-name",
-    "Name for site when using default MkDocs config",
+    "Name for site when using the default config",
     "Documentation Site"
   ).option("-p, --port <PORT>", "Port to serve documentation locally", "8000").option("-v, --verbose", "Enable verbose output.", false).option(
     "--engine <ENGINE>",
     "Documentation engine to use. Overrides the backstage.io/techdocs-engine annotation in catalog-info.yaml; defaults to mkdocs."
-  ).hook("preAction", () => {
-    process.stderr.write(
-      "serve:mkdocs is deprecated and will be removed in a future release. Use serve:raw instead.\n"
-    );
+  ).hook("preAction", (command) => {
+    command.setOptionValue("deprecatedCommandAlias", "serve:mkdocs");
   }).action(serveRawAction);
   program.command("serve").description(
     "Serve a documentation project locally in a Backstage app-like environment"
   ).option(
     "-i, --docker-image <DOCKER_IMAGE>",
-    "The mkdocs docker container to use",
-    defaultDockerImage
+    "Docker image to use. Defaults to the selected engine's image."
   ).option(
     "--docker-entrypoint <DOCKER_ENTRYPOINT>",
     "Override the image entrypoint"
@@ -230,15 +223,14 @@ function registerCommands(program) {
     'Extra options to pass to the docker run command, e.g. "--add-host=internal.host:192.168.11.12" (can be added multiple times).'
   ).option(
     "--no-docker",
-    "Do not use Docker, use MkDocs executable in current user environment."
+    "Do not use Docker, run the engine in the current user environment."
   ).option(
     "--site-name",
-    "Name for site when using default MkDocs config",
+    "Name for site when using the default config",
     "Documentation Site"
   ).option(
     "--engine-port <PORT>",
-    "Port for the documentation engine server (MkDocs, Zensical, etc.) to listen on. The Backstage preview app is served on --preview-app-port.",
-    "8000"
+    "Port for the documentation engine server (MkDocs, Zensical, etc.) to listen on. Defaults to 8000. The Backstage preview app is served on --preview-app-port."
   ).option(
     "--mkdocs-port <PORT>",
     "[Deprecated: use --engine-port] Port for MkDocs server to use"

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

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../../src/commands/index.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 { Command } from 'commander';\nimport { TechdocsGenerator } from '@backstage/plugin-techdocs-node';\n\nconst defaultDockerImage = TechdocsGenerator.defaultDockerImage;\nconst defaultPreviewAppPort = '3000';\n\nexport function registerCommands(program: Command) {\n  program\n    .command('generate')\n    .description('Generate TechDocs documentation site using MkDocs.')\n    .option(\n      '--source-dir <PATH>',\n      'Source directory containing mkdocs.yml and docs/ directory.',\n      '.',\n    )\n    .option(\n      '--output-dir <PATH>',\n      'Output directory containing generated TechDocs site.',\n      './site/',\n    )\n    .option(\n      '--docker-image <DOCKER_IMAGE>',\n      'The mkdocs docker container to use',\n      defaultDockerImage,\n    )\n    .option('--no-pull', 'Do not pull the latest docker image')\n    .option(\n      '--no-docker',\n      'Do not use Docker, use MkDocs executable and plugins in current user environment.',\n    )\n    .option(\n      '--techdocs-ref <HOST_TYPE:URL>',\n      'The repository hosting documentation source files e.g. url:https://ghe.mycompany.net.com/org/repo.' +\n        '\\nThis value is same as the backstage.io/techdocs-ref annotation of the corresponding Backstage entity.' +\n        '\\nIt is completely fine to skip this as it is only being used to set repo_url in mkdocs.yml if not found.\\n',\n    )\n    .option(\n      '--etag <ETAG>',\n      'A unique identifier for the prepared tree e.g. commit SHA. If provided it will be stored in techdocs_metadata.json.' +\n        ' If omitted, a sha256 content hash of the generated site output is computed automatically.',\n    )\n    .option(\n      '--site-name',\n      'Name for site when using default MkDocs config',\n      'Documentation Site',\n    )\n    .option('-v, --verbose', 'Enable verbose output.', false)\n    .option(\n      '--omitTechdocsCoreMkdocsPlugin',\n      \"Don't patch MkDocs file automatically with techdocs-core plugin.\",\n      false,\n    )\n    .option(\n      '--legacyCopyReadmeMdToIndexMd',\n      'Attempt to ensure an index.md exists falling back to using <docs-dir>/README.md or README.md in case a default <docs-dir>/index.md is not provided.',\n      false,\n    )\n    .option(\n      '--disableExternalFonts',\n      'Disable external font downloads by default by setting theme.font: false in mkdocs.yml when not already configured. Useful for air-gapped environments where Google fonts cannot be accessed.',\n      false,\n    )\n    .option(\n      '--defaultPlugin [defaultPlugins...]',\n      'Plugins which should be added automatically to the mkdocs.yaml file',\n      [],\n    )\n    .option(\n      '--dangerouslyAllowAdditionalKeys [additionalKeys...]',\n      'Top-level mkdocs.yml keys to allow beyond the built-in supported set, without failing or stripping them. Same as the techdocs.generator.mkdocs.dangerouslyAllowAdditionalKeys backend config option, which techdocs-cli generate does not currently read from a config file.',\n      [],\n    )\n    .option(\n      '--runAsDefaultUser',\n      'Bypass setting the container user as the same user and group id as host for Linux and MacOS',\n      false,\n    )\n    .option(\n      '--engine <ENGINE>',\n      'Documentation engine to use. Overrides the backstage.io/techdocs-engine annotation in catalog-info.yaml; defaults to mkdocs.',\n    )\n    .alias('build')\n    .action(lazy(() => import('./generate/generate'), 'default'));\n\n  program\n    .command('migrate')\n    .description(\n      'Migrate objects with case-sensitive entity triplets to lower-case versions.',\n    )\n    .requiredOption(\n      '--publisher-type <TYPE>',\n      '(Required always) awsS3 | googleGcs | azureBlobStorage | openStackSwift - same as techdocs.publisher.type in Backstage app-config.yaml',\n    )\n    .requiredOption(\n      '--storage-name <BUCKET/CONTAINER NAME>',\n      '(Required always) In case of AWS/GCS, use the bucket name. In case of Azure, use container name. Same as techdocs.publisher.[TYPE].bucketName',\n    )\n    .option(\n      '--azureAccountName <AZURE ACCOUNT NAME>',\n      '(Required for Azure) specify when --publisher-type azureBlobStorage',\n    )\n    .option(\n      '--azureAccountKey <AZURE ACCOUNT KEY>',\n      'Azure Storage Account key to use for authentication. If not specified, you must set AZURE_TENANT_ID, AZURE_CLIENT_ID & AZURE_CLIENT_SECRET as environment variables.',\n    )\n    .option(\n      '--awsRoleArn <AWS ROLE ARN>',\n      'Optional AWS ARN of role to be assumed.',\n    )\n    .option(\n      '--awsEndpoint <AWS ENDPOINT>',\n      'Optional AWS endpoint to send requests to.',\n    )\n    .option(\n      '--awsS3ForcePathStyle',\n      'Optional AWS S3 option to force path style.',\n    )\n    .option(\n      '--osCredentialId <OPENSTACK SWIFT APPLICATION CREDENTIAL ID>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--osSecret <OPENSTACK SWIFT APPLICATION CREDENTIAL SECRET>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--osAuthUrl <OPENSTACK SWIFT AUTHURL>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--osSwiftUrl <OPENSTACK SWIFT SWIFTURL>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--removeOriginal',\n      'Optional Files are copied by default. If flag is set, files are renamed/moved instead.',\n      false,\n    )\n    .option(\n      '--concurrency <MAX CONCURRENT REQS>',\n      'Optional Controls the number of API requests allowed to be performed simultaneously.',\n      '25',\n    )\n    .option('-v, --verbose', 'Enable verbose output.', false)\n    .action(lazy(() => import('./migrate/migrate'), 'default'));\n\n  program\n    .command('publish')\n    .description(\n      'Publish generated TechDocs site to an external storage AWS S3, Google GCS, etc.',\n    )\n    .requiredOption(\n      '--publisher-type <TYPE>',\n      '(Required always) awsS3 | googleGcs | azureBlobStorage | openStackSwift - same as techdocs.publisher.type in Backstage app-config.yaml',\n    )\n    .requiredOption(\n      '--storage-name <BUCKET/CONTAINER NAME>',\n      '(Required always) In case of AWS/GCS, use the bucket name. In case of Azure, use container name. Same as techdocs.publisher.[TYPE].bucketName',\n    )\n    .requiredOption(\n      '--entity <NAMESPACE/KIND/NAME>',\n      '(Required always) Entity uid separated by / in namespace/kind/name order (case-sensitive). Example: default/Component/myEntity ',\n    )\n    .option(\n      '--legacyUseCaseSensitiveTripletPaths',\n      'Publishes objects with cased entity triplet prefix when set (e.g. namespace/Kind/name). Only use if your TechDocs backend is configured the same way.',\n      false,\n    )\n    .option(\n      '--azureAccountName <AZURE ACCOUNT NAME>',\n      '(Required for Azure) specify when --publisher-type azureBlobStorage',\n    )\n    .option(\n      '--azureAccountKey <AZURE ACCOUNT KEY>',\n      'Azure Storage Account key to use for authentication. If not specified, you must set AZURE_TENANT_ID, AZURE_CLIENT_ID & AZURE_CLIENT_SECRET as environment variables.',\n    )\n    .option(\n      '--awsRoleArn <AWS ROLE ARN>',\n      'Optional AWS ARN of role to be assumed.',\n    )\n    .option(\n      '--awsEndpoint <AWS ENDPOINT>',\n      'Optional AWS endpoint to send requests to.',\n    )\n    .option(\n      '--awsProxy <HTTPS Proxy>',\n      'Optional Proxy to use for AWS requests.',\n    )\n    .option('--awsS3sse <AWS SSE>', 'Optional AWS S3 Server Side Encryption.')\n    .option(\n      '--awsS3ForcePathStyle',\n      'Optional AWS S3 option to force path style.',\n    )\n    .option(\n      '--awsBucketRootPath <AWS BUCKET ROOT PATH>',\n      'Optional sub-directory to store files in Amazon S3',\n    )\n    .option(\n      '--awsMaxAttempts <AWS MAX ATTEMPTS>',\n      'Optional maximum number of retries for AWS S3 operations. If not specified, default value of 3 is used.',\n    )\n    .option(\n      '--osCredentialId <OPENSTACK SWIFT APPLICATION CREDENTIAL ID>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--osSecret <OPENSTACK SWIFT APPLICATION CREDENTIAL SECRET>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--osAuthUrl <OPENSTACK SWIFT AUTHURL>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--osSwiftUrl <OPENSTACK SWIFT SWIFTURL>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--gcsBucketRootPath <GCS BUCKET ROOT PATH>',\n      'Optional sub-directory to store files in Google cloud storage',\n    )\n    .option(\n      '--directory <PATH>',\n      'Path of the directory containing generated files to publish',\n      './site/',\n    )\n    .option(\n      '--skip-if-unchanged',\n      'Skip publishing if the local etag in techdocs_metadata.json matches the remote etag.' +\n        ' The generate step computes a generated site content hash automatically unless --etag is overridden.',\n      false,\n    )\n    .action(lazy(() => import('./publish/publish'), 'default'));\n\n  const serveRawAction = lazy(() => import('./serve/mkdocs'), 'default');\n\n  program\n    .command('serve:raw')\n    .description(\n      'Serve a documentation project locally using the configured engine.',\n    )\n    .option(\n      '-i, --docker-image <DOCKER_IMAGE>',\n      'The docker container to use',\n      defaultDockerImage,\n    )\n    .option(\n      '--docker-entrypoint <DOCKER_ENTRYPOINT>',\n      'Override the image entrypoint',\n    )\n    .option(\n      '--docker-option <DOCKER_OPTION...>',\n      'Extra options to pass to the docker run command, e.g. \"--add-host=internal.host:192.168.11.12\" (can be added multiple times).',\n    )\n    .option(\n      '--no-docker',\n      'Do not use Docker, run the engine serve command in current user environment.',\n    )\n    .option(\n      '--site-name',\n      'Name for site when using default config',\n      'Documentation Site',\n    )\n    .option('-p, --port <PORT>', 'Port to serve documentation locally', '8000')\n    .option('-v, --verbose', 'Enable verbose output.', false)\n    .option(\n      '--engine <ENGINE>',\n      'Documentation engine to use. Overrides the backstage.io/techdocs-engine annotation in catalog-info.yaml; defaults to mkdocs.',\n    )\n    .action(serveRawAction);\n\n  program\n    .command('serve:mkdocs')\n    .description(\n      '[Deprecated: use serve:raw] Serve a documentation project locally.',\n    )\n    .option(\n      '-i, --docker-image <DOCKER_IMAGE>',\n      'The mkdocs docker container to use',\n      defaultDockerImage,\n    )\n    .option(\n      '--docker-entrypoint <DOCKER_ENTRYPOINT>',\n      'Override the image entrypoint',\n    )\n    .option(\n      '--docker-option <DOCKER_OPTION...>',\n      'Extra options to pass to the docker run command, e.g. \"--add-host=internal.host:192.168.11.12\" (can be added multiple times).',\n    )\n    .option(\n      '--no-docker',\n      'Do not use Docker, run `mkdocs serve` in current user environment.',\n    )\n    .option(\n      '--site-name',\n      'Name for site when using default MkDocs config',\n      'Documentation Site',\n    )\n    .option('-p, --port <PORT>', 'Port to serve documentation locally', '8000')\n    .option('-v, --verbose', 'Enable verbose output.', false)\n    .option(\n      '--engine <ENGINE>',\n      'Documentation engine to use. Overrides the backstage.io/techdocs-engine annotation in catalog-info.yaml; defaults to mkdocs.',\n    )\n    .hook('preAction', () => {\n      process.stderr.write(\n        'serve:mkdocs is deprecated and will be removed in a future release. Use serve:raw instead.\\n',\n      );\n    })\n    .action(serveRawAction);\n\n  program\n    .command('serve')\n    .description(\n      'Serve a documentation project locally in a Backstage app-like environment',\n    )\n    .option(\n      '-i, --docker-image <DOCKER_IMAGE>',\n      'The mkdocs docker container to use',\n      defaultDockerImage,\n    )\n    .option(\n      '--docker-entrypoint <DOCKER_ENTRYPOINT>',\n      'Override the image entrypoint',\n    )\n    .option(\n      '--docker-option <DOCKER_OPTION...>',\n      'Extra options to pass to the docker run command, e.g. \"--add-host=internal.host:192.168.11.12\" (can be added multiple times).',\n    )\n    .option(\n      '--no-docker',\n      'Do not use Docker, use MkDocs executable in current user environment.',\n    )\n    .option(\n      '--site-name',\n      'Name for site when using default MkDocs config',\n      'Documentation Site',\n    )\n    .option(\n      '--engine-port <PORT>',\n      'Port for the documentation engine server (MkDocs, Zensical, etc.) to listen on. The Backstage preview app is served on --preview-app-port.',\n      '8000',\n    )\n    .option(\n      '--mkdocs-port <PORT>',\n      '[Deprecated: use --engine-port] Port for MkDocs server to use',\n    )\n    .option('-v, --verbose', 'Enable verbose output.', false)\n    .option(\n      '--preview-app-bundle-path <PATH_TO_BUNDLE>',\n      'Preview documentation using another web app',\n    )\n    .option(\n      '--preview-app-port <PORT>',\n      'Port for the preview app to be served on',\n      defaultPreviewAppPort,\n    )\n    .option(\n      '-c, --config-file-name <FILENAME>',\n      'Config file name for the documentation engine (e.g. mkdocs.yml). Overrides automatic detection.',\n    )\n    .option(\n      '--mkdocs-config-file-name <FILENAME>',\n      '[Deprecated: use --config-file-name] Mkdocs config file name',\n    )\n    .option(\n      '--parameter-clean',\n      'Pass \"--clean\" to the documentation engine server. Clears the build cache before serving.',\n      false,\n    )\n    .option(\n      '--mkdocs-parameter-clean',\n      '[Deprecated: use --parameter-clean] Pass \"--clean\" parameter to mkdocs server',\n      false,\n    )\n    .option(\n      '--parameter-dirtyreload',\n      'Pass \"--dirtyreload\" to the documentation engine server. Only rebuilds changed files on reload (MkDocs only; ignored by other engines).',\n      false,\n    )\n    .option(\n      '--mkdocs-parameter-dirtyreload',\n      '[Deprecated: use --parameter-dirtyreload] Pass \"--dirtyreload\" parameter to mkdocs server',\n      false,\n    )\n    .option(\n      '--parameter-strict',\n      'Pass \"--strict\" to the documentation engine server. Treats warnings as errors during build.',\n      false,\n    )\n    .option(\n      '--mkdocs-parameter-strict',\n      '[Deprecated: use --parameter-strict] Pass \"--strict\" parameter to mkdocs server',\n      false,\n    )\n    .option(\n      '--engine <ENGINE>',\n      'Documentation engine to use. Overrides the backstage.io/techdocs-engine annotation in catalog-info.yaml; defaults to mkdocs.',\n    )\n    .hook('preAction', command => {\n      if (\n        command.opts().previewAppPort !== defaultPreviewAppPort &&\n        !command.opts().previewAppBundlePath\n      ) {\n        command.error(\n          '--preview-app-port can only be used together with --preview-app-bundle-path',\n        );\n      }\n    })\n    .action(lazy(() => import('./serve/serve'), 'default'));\n}\n\n// Humbly taken from backstage-cli's registerCommands\ntype ActionFunc = (...args: any[]) => Promise<void>;\ntype ActionExports<TModule extends object> = {\n  [KName in keyof TModule as TModule[KName] extends ActionFunc\n    ? KName\n    : never]: TModule[KName];\n};\n\n// Wraps an action function so that it always exits and handles errors\nexport function lazy<TModule extends object>(\n  moduleLoader: () => Promise<TModule>,\n  exportName: keyof ActionExports<TModule>,\n): (...args: any[]) => Promise<never> {\n  return async (...args: any[]) => {\n    try {\n      const mod = await moduleLoader();\n      const actualModule = (\n        mod as unknown as { default: ActionExports<TModule> }\n      ).default;\n      const actionFunc = actualModule[exportName] as ActionFunc;\n      await actionFunc(...args);\n\n      process.exit(0);\n    } catch (error) {\n      console.error(error.message);\n      process.exit(1);\n    }\n  };\n}\n"],"names":["TechdocsGenerator"],"mappings":";;;;AAmBA,MAAM,qBAAqBA,oCAAA,CAAkB,kBAAA;AAC7C,MAAM,qBAAA,GAAwB,MAAA;AAEvB,SAAS,iBAAiB,OAAA,EAAkB;AACjD,EAAA,OAAA,CACG,OAAA,CAAQ,UAAU,CAAA,CAClB,WAAA,CAAY,oDAAoD,CAAA,CAChE,MAAA;AAAA,IACC,qBAAA;AAAA,IACA,6DAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,qBAAA;AAAA,IACA,sDAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,+BAAA;AAAA,IACA,oCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA,CAAO,WAAA,EAAa,qCAAqC,CAAA,CACzD,MAAA;AAAA,IACC,aAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,gCAAA;AAAA,IACA;AAAA,GAGF,CACC,MAAA;AAAA,IACC,eAAA;AAAA,IACA;AAAA,GAEF,CACC,MAAA;AAAA,IACC,aAAA;AAAA,IACA,gDAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA,CAAO,eAAA,EAAiB,wBAAA,EAA0B,KAAK,CAAA,CACvD,MAAA;AAAA,IACC,gCAAA;AAAA,IACA,kEAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,+BAAA;AAAA,IACA,qJAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,wBAAA;AAAA,IACA,8LAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,qCAAA;AAAA,IACA,qEAAA;AAAA,IACA;AAAC,GACH,CACC,MAAA;AAAA,IACC,sDAAA;AAAA,IACA,8QAAA;AAAA,IACA;AAAC,GACH,CACC,MAAA;AAAA,IACC,oBAAA;AAAA,IACA,6FAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,mBAAA;AAAA,IACA;AAAA,GACF,CACC,KAAA,CAAM,OAAO,CAAA,CACb,MAAA,CAAO,IAAA,CAAK,MAAM,OAAO,4BAAqB,CAAA,EAAG,SAAS,CAAC,CAAA;AAE9D,EAAA,OAAA,CACG,OAAA,CAAQ,SAAS,CAAA,CACjB,WAAA;AAAA,IACC;AAAA,GACF,CACC,cAAA;AAAA,IACC,yBAAA;AAAA,IACA;AAAA,GACF,CACC,cAAA;AAAA,IACC,wCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,uCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,6BAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,8BAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,uBAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,8DAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,4DAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,uCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,kBAAA;AAAA,IACA,wFAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,qCAAA;AAAA,IACA,sFAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA,CAAO,eAAA,EAAiB,wBAAA,EAA0B,KAAK,CAAA,CACvD,MAAA,CAAO,IAAA,CAAK,MAAM,OAAO,0BAAmB,CAAA,EAAG,SAAS,CAAC,CAAA;AAE5D,EAAA,OAAA,CACG,OAAA,CAAQ,SAAS,CAAA,CACjB,WAAA;AAAA,IACC;AAAA,GACF,CACC,cAAA;AAAA,IACC,yBAAA;AAAA,IACA;AAAA,GACF,CACC,cAAA;AAAA,IACC,wCAAA;AAAA,IACA;AAAA,GACF,CACC,cAAA;AAAA,IACC,gCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,sCAAA;AAAA,IACA,uJAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,uCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,6BAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,8BAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,0BAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA,CAAO,sBAAA,EAAwB,yCAAyC,CAAA,CACxE,MAAA;AAAA,IACC,uBAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,4CAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,qCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,8DAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,4DAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,uCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,4CAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,oBAAA;AAAA,IACA,6DAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,qBAAA;AAAA,IACA,0LAAA;AAAA,IAEA;AAAA,GACF,CACC,OAAO,IAAA,CAAK,MAAM,OAAO,0BAAmB,CAAA,EAAG,SAAS,CAAC,CAAA;AAE5D,EAAA,MAAM,iBAAiB,IAAA,CAAK,MAAM,OAAO,uBAAgB,GAAG,SAAS,CAAA;AAErE,EAAA,OAAA,CACG,OAAA,CAAQ,WAAW,CAAA,CACnB,WAAA;AAAA,IACC;AAAA,GACF,CACC,MAAA;AAAA,IACC,mCAAA;AAAA,IACA,6BAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,oCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,aAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,aAAA;AAAA,IACA,yCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA,CAAO,mBAAA,EAAqB,qCAAA,EAAuC,MAAM,EACzE,MAAA,CAAO,eAAA,EAAiB,wBAAA,EAA0B,KAAK,CAAA,CACvD,MAAA;AAAA,IACC,mBAAA;AAAA,IACA;AAAA,GACF,CACC,OAAO,cAAc,CAAA;AAExB,EAAA,OAAA,CACG,OAAA,CAAQ,cAAc,CAAA,CACtB,WAAA;AAAA,IACC;AAAA,GACF,CACC,MAAA;AAAA,IACC,mCAAA;AAAA,IACA,oCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,oCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,aAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,aAAA;AAAA,IACA,gDAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA,CAAO,mBAAA,EAAqB,qCAAA,EAAuC,MAAM,EACzE,MAAA,CAAO,eAAA,EAAiB,wBAAA,EAA0B,KAAK,CAAA,CACvD,MAAA;AAAA,IACC,mBAAA;AAAA,IACA;AAAA,GACF,CACC,IAAA,CAAK,WAAA,EAAa,MAAM;AACvB,IAAA,OAAA,CAAQ,MAAA,CAAO,KAAA;AAAA,MACb;AAAA,KACF;AAAA,EACF,CAAC,CAAA,CACA,MAAA,CAAO,cAAc,CAAA;AAExB,EAAA,OAAA,CACG,OAAA,CAAQ,OAAO,CAAA,CACf,WAAA;AAAA,IACC;AAAA,GACF,CACC,MAAA;AAAA,IACC,mCAAA;AAAA,IACA,oCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,oCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,aAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,aAAA;AAAA,IACA,gDAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,sBAAA;AAAA,IACA,4IAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,sBAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA,CAAO,eAAA,EAAiB,wBAAA,EAA0B,KAAK,CAAA,CACvD,MAAA;AAAA,IACC,4CAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,2BAAA;AAAA,IACA,0CAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,mCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,sCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,mBAAA;AAAA,IACA,2FAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,0BAAA;AAAA,IACA,+EAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,yBAAA;AAAA,IACA,yIAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,gCAAA;AAAA,IACA,2FAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,oBAAA;AAAA,IACA,6FAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,2BAAA;AAAA,IACA,iFAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,mBAAA;AAAA,IACA;AAAA,GACF,CACC,IAAA,CAAK,WAAA,EAAa,CAAA,OAAA,KAAW;AAC5B,IAAA,IACE,OAAA,CAAQ,MAAK,CAAE,cAAA,KAAmB,yBAClC,CAAC,OAAA,CAAQ,IAAA,EAAK,CAAE,oBAAA,EAChB;AACA,MAAA,OAAA,CAAQ,KAAA;AAAA,QACN;AAAA,OACF;AAAA,IACF;AAAA,EACF,CAAC,EACA,MAAA,CAAO,IAAA,CAAK,MAAM,OAAO,sBAAe,CAAA,EAAG,SAAS,CAAC,CAAA;AAC1D;AAWO,SAAS,IAAA,CACd,cACA,UAAA,EACoC;AACpC,EAAA,OAAO,UAAU,IAAA,KAAgB;AAC/B,IAAA,IAAI;AACF,MAAA,MAAM,GAAA,GAAM,MAAM,YAAA,EAAa;AAC/B,MAAA,MAAM,eACJ,GAAA,CACA,OAAA;AACF,MAAA,MAAM,UAAA,GAAa,aAAa,UAAU,CAAA;AAC1C,MAAA,MAAM,UAAA,CAAW,GAAG,IAAI,CAAA;AAExB,MAAA,OAAA,CAAQ,KAAK,CAAC,CAAA;AAAA,IAChB,SAAS,KAAA,EAAO;AACd,MAAA,OAAA,CAAQ,KAAA,CAAM,MAAM,OAAO,CAAA;AAC3B,MAAA,OAAA,CAAQ,KAAK,CAAC,CAAA;AAAA,IAChB;AAAA,EACF,CAAA;AACF;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../../src/commands/index.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 { Command } from 'commander';\n\nconst defaultPreviewAppPort = '3000';\n\nexport function registerCommands(program: Command) {\n  program\n    .command('generate')\n    .description(\n      'Generate a TechDocs documentation site with the selected engine (MkDocs by default).',\n    )\n    .option(\n      '--source-dir <PATH>',\n      'Source directory containing mkdocs.yml and docs/ directory.',\n      '.',\n    )\n    .option(\n      '--output-dir <PATH>',\n      'Output directory containing generated TechDocs site.',\n      './site/',\n    )\n    .option(\n      '--docker-image <DOCKER_IMAGE>',\n      \"Docker image to use. Defaults to the selected engine's image.\",\n    )\n    .option('--no-pull', 'Do not pull the latest docker image')\n    .option(\n      '--no-docker',\n      'Do not use Docker, run the engine and its plugins in the current user environment.',\n    )\n    .option(\n      '--techdocs-ref <HOST_TYPE:URL>',\n      'The repository hosting documentation source files e.g. url:https://ghe.mycompany.net.com/org/repo.' +\n        '\\nThis value is same as the backstage.io/techdocs-ref annotation of the corresponding Backstage entity.' +\n        '\\nIt is completely fine to skip this as it is only being used to set repo_url in mkdocs.yml if not found.\\n',\n    )\n    .option(\n      '--etag <ETAG>',\n      'A unique identifier for the prepared tree e.g. commit SHA. If provided it will be stored in techdocs_metadata.json.' +\n        ' If omitted, a sha256 content hash of the generated site output is computed automatically.',\n    )\n    .option(\n      '--site-name',\n      'Name for site when using the default config',\n      'Documentation Site',\n    )\n    .option('-v, --verbose', 'Enable verbose output.', false)\n    .option(\n      '--omitTechdocsCoreMkdocsPlugin',\n      \"Don't patch MkDocs file automatically with techdocs-core plugin.\",\n      false,\n    )\n    .option(\n      '--legacyCopyReadmeMdToIndexMd',\n      'Attempt to ensure an index.md exists falling back to using <docs-dir>/README.md or README.md in case a default <docs-dir>/index.md is not provided.',\n      false,\n    )\n    .option(\n      '--disableExternalFonts',\n      'Disable external font downloads by default by setting theme.font: false in mkdocs.yml when not already configured. Useful for air-gapped environments where Google fonts cannot be accessed.',\n      false,\n    )\n    .option(\n      '--defaultPlugin [defaultPlugins...]',\n      'Plugins which should be added automatically to the mkdocs.yaml file',\n      [],\n    )\n    .option(\n      '--dangerouslyAllowAdditionalKeys [additionalKeys...]',\n      'Top-level mkdocs.yml keys to allow beyond the built-in supported set, without failing or stripping them. Same as the techdocs.generator.mkdocs.dangerouslyAllowAdditionalKeys backend config option, which techdocs-cli generate does not currently read from a config file.',\n      [],\n    )\n    .option(\n      '--runAsDefaultUser',\n      'Bypass setting the container user as the same user and group id as host for Linux and MacOS',\n      false,\n    )\n    .option(\n      '--engine <ENGINE>',\n      'Documentation engine to use. Overrides the backstage.io/techdocs-engine annotation in catalog-info.yaml; defaults to mkdocs.',\n    )\n    .alias('build')\n    .action(lazy(() => import('./generate/generate'), 'default'));\n\n  program\n    .command('migrate')\n    .description(\n      'Migrate objects with case-sensitive entity triplets to lower-case versions.',\n    )\n    .requiredOption(\n      '--publisher-type <TYPE>',\n      '(Required always) awsS3 | googleGcs | azureBlobStorage | openStackSwift - same as techdocs.publisher.type in Backstage app-config.yaml',\n    )\n    .requiredOption(\n      '--storage-name <BUCKET/CONTAINER NAME>',\n      '(Required always) In case of AWS/GCS, use the bucket name. In case of Azure, use container name. Same as techdocs.publisher.[TYPE].bucketName',\n    )\n    .option(\n      '--azureAccountName <AZURE ACCOUNT NAME>',\n      '(Required for Azure) specify when --publisher-type azureBlobStorage',\n    )\n    .option(\n      '--azureAccountKey <AZURE ACCOUNT KEY>',\n      'Azure Storage Account key to use for authentication. If not specified, you must set AZURE_TENANT_ID, AZURE_CLIENT_ID & AZURE_CLIENT_SECRET as environment variables.',\n    )\n    .option(\n      '--awsRoleArn <AWS ROLE ARN>',\n      'Optional AWS ARN of role to be assumed.',\n    )\n    .option(\n      '--awsEndpoint <AWS ENDPOINT>',\n      'Optional AWS endpoint to send requests to.',\n    )\n    .option(\n      '--awsS3ForcePathStyle',\n      'Optional AWS S3 option to force path style.',\n    )\n    .option(\n      '--osCredentialId <OPENSTACK SWIFT APPLICATION CREDENTIAL ID>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--osSecret <OPENSTACK SWIFT APPLICATION CREDENTIAL SECRET>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--osAuthUrl <OPENSTACK SWIFT AUTHURL>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--osSwiftUrl <OPENSTACK SWIFT SWIFTURL>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--removeOriginal',\n      'Optional Files are copied by default. If flag is set, files are renamed/moved instead.',\n      false,\n    )\n    .option(\n      '--concurrency <MAX CONCURRENT REQS>',\n      'Optional Controls the number of API requests allowed to be performed simultaneously.',\n      '25',\n    )\n    .option('-v, --verbose', 'Enable verbose output.', false)\n    .action(lazy(() => import('./migrate/migrate'), 'default'));\n\n  program\n    .command('publish')\n    .description(\n      'Publish generated TechDocs site to an external storage AWS S3, Google GCS, etc.',\n    )\n    .requiredOption(\n      '--publisher-type <TYPE>',\n      '(Required always) awsS3 | googleGcs | azureBlobStorage | openStackSwift - same as techdocs.publisher.type in Backstage app-config.yaml',\n    )\n    .requiredOption(\n      '--storage-name <BUCKET/CONTAINER NAME>',\n      '(Required always) In case of AWS/GCS, use the bucket name. In case of Azure, use container name. Same as techdocs.publisher.[TYPE].bucketName',\n    )\n    .requiredOption(\n      '--entity <NAMESPACE/KIND/NAME>',\n      '(Required always) Entity uid separated by / in namespace/kind/name order (case-sensitive). Example: default/Component/myEntity ',\n    )\n    .option(\n      '--legacyUseCaseSensitiveTripletPaths',\n      'Publishes objects with cased entity triplet prefix when set (e.g. namespace/Kind/name). Only use if your TechDocs backend is configured the same way.',\n      false,\n    )\n    .option(\n      '--azureAccountName <AZURE ACCOUNT NAME>',\n      '(Required for Azure) specify when --publisher-type azureBlobStorage',\n    )\n    .option(\n      '--azureAccountKey <AZURE ACCOUNT KEY>',\n      'Azure Storage Account key to use for authentication. If not specified, you must set AZURE_TENANT_ID, AZURE_CLIENT_ID & AZURE_CLIENT_SECRET as environment variables.',\n    )\n    .option(\n      '--awsRoleArn <AWS ROLE ARN>',\n      'Optional AWS ARN of role to be assumed.',\n    )\n    .option(\n      '--awsEndpoint <AWS ENDPOINT>',\n      'Optional AWS endpoint to send requests to.',\n    )\n    .option(\n      '--awsProxy <HTTPS Proxy>',\n      'Optional Proxy to use for AWS requests.',\n    )\n    .option('--awsS3sse <AWS SSE>', 'Optional AWS S3 Server Side Encryption.')\n    .option(\n      '--awsS3ForcePathStyle',\n      'Optional AWS S3 option to force path style.',\n    )\n    .option(\n      '--awsBucketRootPath <AWS BUCKET ROOT PATH>',\n      'Optional sub-directory to store files in Amazon S3',\n    )\n    .option(\n      '--awsMaxAttempts <AWS MAX ATTEMPTS>',\n      'Optional maximum number of retries for AWS S3 operations. If not specified, default value of 3 is used.',\n    )\n    .option(\n      '--osCredentialId <OPENSTACK SWIFT APPLICATION CREDENTIAL ID>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--osSecret <OPENSTACK SWIFT APPLICATION CREDENTIAL SECRET>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--osAuthUrl <OPENSTACK SWIFT AUTHURL>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--osSwiftUrl <OPENSTACK SWIFT SWIFTURL>',\n      '(Required for OpenStack) specify when --publisher-type openStackSwift',\n    )\n    .option(\n      '--gcsBucketRootPath <GCS BUCKET ROOT PATH>',\n      'Optional sub-directory to store files in Google cloud storage',\n    )\n    .option(\n      '--directory <PATH>',\n      'Path of the directory containing generated files to publish',\n      './site/',\n    )\n    .option(\n      '--skip-if-unchanged',\n      'Skip publishing if the local etag in techdocs_metadata.json matches the remote etag.' +\n        ' The generate step computes a generated site content hash automatically unless --etag is overridden.',\n      false,\n    )\n    .action(lazy(() => import('./publish/publish'), 'default'));\n\n  const serveRawAction = lazy(() => import('./serve/mkdocs'), 'default');\n\n  program\n    .command('serve:raw')\n    .description(\n      'Serve a documentation project locally using the configured engine.',\n    )\n    .option(\n      '-i, --docker-image <DOCKER_IMAGE>',\n      \"Docker image to use. Defaults to the selected engine's image.\",\n    )\n    .option(\n      '--docker-entrypoint <DOCKER_ENTRYPOINT>',\n      'Override the image entrypoint',\n    )\n    .option(\n      '--docker-option <DOCKER_OPTION...>',\n      'Extra options to pass to the docker run command, e.g. \"--add-host=internal.host:192.168.11.12\" (can be added multiple times).',\n    )\n    .option(\n      '--no-docker',\n      'Do not use Docker, run the engine serve command in the current user environment.',\n    )\n    .option(\n      '--site-name',\n      'Name for site when using the default config',\n      'Documentation Site',\n    )\n    .option('-p, --port <PORT>', 'Port to serve documentation locally', '8000')\n    .option('-v, --verbose', 'Enable verbose output.', false)\n    .option(\n      '--engine <ENGINE>',\n      'Documentation engine to use. Overrides the backstage.io/techdocs-engine annotation in catalog-info.yaml; defaults to mkdocs.',\n    )\n    .action(serveRawAction);\n\n  program\n    .command('serve:mkdocs')\n    .description(\n      '[Deprecated: use serve:raw] Serve a documentation project locally.',\n    )\n    .option(\n      '-i, --docker-image <DOCKER_IMAGE>',\n      \"Docker image to use. Defaults to the selected engine's image.\",\n    )\n    .option(\n      '--docker-entrypoint <DOCKER_ENTRYPOINT>',\n      'Override the image entrypoint',\n    )\n    .option(\n      '--docker-option <DOCKER_OPTION...>',\n      'Extra options to pass to the docker run command, e.g. \"--add-host=internal.host:192.168.11.12\" (can be added multiple times).',\n    )\n    .option(\n      '--no-docker',\n      'Do not use Docker, run `mkdocs serve` in current user environment.',\n    )\n    .option(\n      '--site-name',\n      'Name for site when using the default config',\n      'Documentation Site',\n    )\n    .option('-p, --port <PORT>', 'Port to serve documentation locally', '8000')\n    .option('-v, --verbose', 'Enable verbose output.', false)\n    .option(\n      '--engine <ENGINE>',\n      'Documentation engine to use. Overrides the backstage.io/techdocs-engine annotation in catalog-info.yaml; defaults to mkdocs.',\n    )\n    .hook('preAction', command => {\n      command.setOptionValue('deprecatedCommandAlias', 'serve:mkdocs');\n    })\n    .action(serveRawAction);\n\n  program\n    .command('serve')\n    .description(\n      'Serve a documentation project locally in a Backstage app-like environment',\n    )\n    .option(\n      '-i, --docker-image <DOCKER_IMAGE>',\n      \"Docker image to use. Defaults to the selected engine's image.\",\n    )\n    .option(\n      '--docker-entrypoint <DOCKER_ENTRYPOINT>',\n      'Override the image entrypoint',\n    )\n    .option(\n      '--docker-option <DOCKER_OPTION...>',\n      'Extra options to pass to the docker run command, e.g. \"--add-host=internal.host:192.168.11.12\" (can be added multiple times).',\n    )\n    .option(\n      '--no-docker',\n      'Do not use Docker, run the engine in the current user environment.',\n    )\n    .option(\n      '--site-name',\n      'Name for site when using the default config',\n      'Documentation Site',\n    )\n    .option(\n      '--engine-port <PORT>',\n      'Port for the documentation engine server (MkDocs, Zensical, etc.) to listen on. Defaults to 8000. The Backstage preview app is served on --preview-app-port.',\n    )\n    .option(\n      '--mkdocs-port <PORT>',\n      '[Deprecated: use --engine-port] Port for MkDocs server to use',\n    )\n    .option('-v, --verbose', 'Enable verbose output.', false)\n    .option(\n      '--preview-app-bundle-path <PATH_TO_BUNDLE>',\n      'Preview documentation using another web app',\n    )\n    .option(\n      '--preview-app-port <PORT>',\n      'Port for the preview app to be served on',\n      defaultPreviewAppPort,\n    )\n    .option(\n      '-c, --config-file-name <FILENAME>',\n      'Config file name for the documentation engine (e.g. mkdocs.yml). Overrides automatic detection.',\n    )\n    .option(\n      '--mkdocs-config-file-name <FILENAME>',\n      '[Deprecated: use --config-file-name] Mkdocs config file name',\n    )\n    .option(\n      '--parameter-clean',\n      'Pass \"--clean\" to the documentation engine server. Clears the build cache before serving.',\n      false,\n    )\n    .option(\n      '--mkdocs-parameter-clean',\n      '[Deprecated: use --parameter-clean] Pass \"--clean\" parameter to mkdocs server',\n      false,\n    )\n    .option(\n      '--parameter-dirtyreload',\n      'Pass \"--dirtyreload\" to the documentation engine server. Only rebuilds changed files on reload (MkDocs only; ignored by other engines).',\n      false,\n    )\n    .option(\n      '--mkdocs-parameter-dirtyreload',\n      '[Deprecated: use --parameter-dirtyreload] Pass \"--dirtyreload\" parameter to mkdocs server',\n      false,\n    )\n    .option(\n      '--parameter-strict',\n      'Pass \"--strict\" to the documentation engine server. Treats warnings as errors during build.',\n      false,\n    )\n    .option(\n      '--mkdocs-parameter-strict',\n      '[Deprecated: use --parameter-strict] Pass \"--strict\" parameter to mkdocs server',\n      false,\n    )\n    .option(\n      '--engine <ENGINE>',\n      'Documentation engine to use. Overrides the backstage.io/techdocs-engine annotation in catalog-info.yaml; defaults to mkdocs.',\n    )\n    .hook('preAction', command => {\n      if (\n        command.opts().previewAppPort !== defaultPreviewAppPort &&\n        !command.opts().previewAppBundlePath\n      ) {\n        command.error(\n          '--preview-app-port can only be used together with --preview-app-bundle-path',\n        );\n      }\n    })\n    .action(lazy(() => import('./serve/serve'), 'default'));\n}\n\n// Humbly taken from backstage-cli's registerCommands\ntype ActionFunc = (...args: any[]) => Promise<void>;\ntype ActionExports<TModule extends object> = {\n  [KName in keyof TModule as TModule[KName] extends ActionFunc\n    ? KName\n    : never]: TModule[KName];\n};\n\n// Wraps an action function so that it always exits and handles errors\nexport function lazy<TModule extends object>(\n  moduleLoader: () => Promise<TModule>,\n  exportName: keyof ActionExports<TModule>,\n): (...args: any[]) => Promise<never> {\n  return async (...args: any[]) => {\n    try {\n      const mod = await moduleLoader();\n      const actualModule = (\n        mod as unknown as { default: ActionExports<TModule> }\n      ).default;\n      const actionFunc = actualModule[exportName] as ActionFunc;\n      await actionFunc(...args);\n\n      process.exit(0);\n    } catch (error) {\n      console.error(error.message);\n      process.exit(1);\n    }\n  };\n}\n"],"names":[],"mappings":";;AAkBA,MAAM,qBAAA,GAAwB,MAAA;AAEvB,SAAS,iBAAiB,OAAA,EAAkB;AACjD,EAAA,OAAA,CACG,OAAA,CAAQ,UAAU,CAAA,CAClB,WAAA;AAAA,IACC;AAAA,GACF,CACC,MAAA;AAAA,IACC,qBAAA;AAAA,IACA,6DAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,qBAAA;AAAA,IACA,sDAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,+BAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA,CAAO,WAAA,EAAa,qCAAqC,CAAA,CACzD,MAAA;AAAA,IACC,aAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,gCAAA;AAAA,IACA;AAAA,GAGF,CACC,MAAA;AAAA,IACC,eAAA;AAAA,IACA;AAAA,GAEF,CACC,MAAA;AAAA,IACC,aAAA;AAAA,IACA,6CAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA,CAAO,eAAA,EAAiB,wBAAA,EAA0B,KAAK,CAAA,CACvD,MAAA;AAAA,IACC,gCAAA;AAAA,IACA,kEAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,+BAAA;AAAA,IACA,qJAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,wBAAA;AAAA,IACA,8LAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,qCAAA;AAAA,IACA,qEAAA;AAAA,IACA;AAAC,GACH,CACC,MAAA;AAAA,IACC,sDAAA;AAAA,IACA,8QAAA;AAAA,IACA;AAAC,GACH,CACC,MAAA;AAAA,IACC,oBAAA;AAAA,IACA,6FAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,mBAAA;AAAA,IACA;AAAA,GACF,CACC,KAAA,CAAM,OAAO,CAAA,CACb,MAAA,CAAO,IAAA,CAAK,MAAM,OAAO,4BAAqB,CAAA,EAAG,SAAS,CAAC,CAAA;AAE9D,EAAA,OAAA,CACG,OAAA,CAAQ,SAAS,CAAA,CACjB,WAAA;AAAA,IACC;AAAA,GACF,CACC,cAAA;AAAA,IACC,yBAAA;AAAA,IACA;AAAA,GACF,CACC,cAAA;AAAA,IACC,wCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,uCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,6BAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,8BAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,uBAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,8DAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,4DAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,uCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,kBAAA;AAAA,IACA,wFAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,qCAAA;AAAA,IACA,sFAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA,CAAO,eAAA,EAAiB,wBAAA,EAA0B,KAAK,CAAA,CACvD,MAAA,CAAO,IAAA,CAAK,MAAM,OAAO,0BAAmB,CAAA,EAAG,SAAS,CAAC,CAAA;AAE5D,EAAA,OAAA,CACG,OAAA,CAAQ,SAAS,CAAA,CACjB,WAAA;AAAA,IACC;AAAA,GACF,CACC,cAAA;AAAA,IACC,yBAAA;AAAA,IACA;AAAA,GACF,CACC,cAAA;AAAA,IACC,wCAAA;AAAA,IACA;AAAA,GACF,CACC,cAAA;AAAA,IACC,gCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,sCAAA;AAAA,IACA,uJAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,uCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,6BAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,8BAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,0BAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA,CAAO,sBAAA,EAAwB,yCAAyC,CAAA,CACxE,MAAA;AAAA,IACC,uBAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,4CAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,qCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,8DAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,4DAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,uCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,4CAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,oBAAA;AAAA,IACA,6DAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,qBAAA;AAAA,IACA,0LAAA;AAAA,IAEA;AAAA,GACF,CACC,OAAO,IAAA,CAAK,MAAM,OAAO,0BAAmB,CAAA,EAAG,SAAS,CAAC,CAAA;AAE5D,EAAA,MAAM,iBAAiB,IAAA,CAAK,MAAM,OAAO,uBAAgB,GAAG,SAAS,CAAA;AAErE,EAAA,OAAA,CACG,OAAA,CAAQ,WAAW,CAAA,CACnB,WAAA;AAAA,IACC;AAAA,GACF,CACC,MAAA;AAAA,IACC,mCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,oCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,aAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,aAAA;AAAA,IACA,6CAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA,CAAO,mBAAA,EAAqB,qCAAA,EAAuC,MAAM,EACzE,MAAA,CAAO,eAAA,EAAiB,wBAAA,EAA0B,KAAK,CAAA,CACvD,MAAA;AAAA,IACC,mBAAA;AAAA,IACA;AAAA,GACF,CACC,OAAO,cAAc,CAAA;AAExB,EAAA,OAAA,CACG,OAAA,CAAQ,cAAc,CAAA,CACtB,WAAA;AAAA,IACC;AAAA,GACF,CACC,MAAA;AAAA,IACC,mCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,oCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,aAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,aAAA;AAAA,IACA,6CAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA,CAAO,mBAAA,EAAqB,qCAAA,EAAuC,MAAM,EACzE,MAAA,CAAO,eAAA,EAAiB,wBAAA,EAA0B,KAAK,CAAA,CACvD,MAAA;AAAA,IACC,mBAAA;AAAA,IACA;AAAA,GACF,CACC,IAAA,CAAK,WAAA,EAAa,CAAA,OAAA,KAAW;AAC5B,IAAA,OAAA,CAAQ,cAAA,CAAe,0BAA0B,cAAc,CAAA;AAAA,EACjE,CAAC,CAAA,CACA,MAAA,CAAO,cAAc,CAAA;AAExB,EAAA,OAAA,CACG,OAAA,CAAQ,OAAO,CAAA,CACf,WAAA;AAAA,IACC;AAAA,GACF,CACC,MAAA;AAAA,IACC,mCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,yCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,oCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,aAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,aAAA;AAAA,IACA,6CAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,sBAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,sBAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA,CAAO,eAAA,EAAiB,wBAAA,EAA0B,KAAK,CAAA,CACvD,MAAA;AAAA,IACC,4CAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,2BAAA;AAAA,IACA,0CAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,mCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,sCAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,mBAAA;AAAA,IACA,2FAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,0BAAA;AAAA,IACA,+EAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,yBAAA;AAAA,IACA,yIAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,gCAAA;AAAA,IACA,2FAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,oBAAA;AAAA,IACA,6FAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,2BAAA;AAAA,IACA,iFAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA;AAAA,IACC,mBAAA;AAAA,IACA;AAAA,GACF,CACC,IAAA,CAAK,WAAA,EAAa,CAAA,OAAA,KAAW;AAC5B,IAAA,IACE,OAAA,CAAQ,MAAK,CAAE,cAAA,KAAmB,yBAClC,CAAC,OAAA,CAAQ,IAAA,EAAK,CAAE,oBAAA,EAChB;AACA,MAAA,OAAA,CAAQ,KAAA;AAAA,QACN;AAAA,OACF;AAAA,IACF;AAAA,EACF,CAAC,EACA,MAAA,CAAO,IAAA,CAAK,MAAM,OAAO,sBAAe,CAAA,EAAG,SAAS,CAAC,CAAA;AAC1D;AAWO,SAAS,IAAA,CACd,cACA,UAAA,EACoC;AACpC,EAAA,OAAO,UAAU,IAAA,KAAgB;AAC/B,IAAA,IAAI;AACF,MAAA,MAAM,GAAA,GAAM,MAAM,YAAA,EAAa;AAC/B,MAAA,MAAM,eACJ,GAAA,CACA,OAAA;AACF,MAAA,MAAM,UAAA,GAAa,aAAa,UAAU,CAAA;AAC1C,MAAA,MAAM,UAAA,CAAW,GAAG,IAAI,CAAA;AAExB,MAAA,OAAA,CAAQ,KAAK,CAAC,CAAA;AAAA,IAChB,SAAS,KAAA,EAAO;AACd,MAAA,OAAA,CAAQ,KAAA,CAAM,MAAM,OAAO,CAAA;AAC3B,MAAA,OAAA,CAAQ,KAAK,CAAC,CAAA;AAAA,IAChB;AAAA,EACF,CAAA;AACF;;;"}

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

@@ -8,8 +8,9 @@ var server = require('../../lib/server.cjs.js');
 var pluginTechdocsNode = require('@backstage/plugin-techdocs-node');
 var fs = require('fs-extra');
 var utils = require('./utils.cjs.js');
-var engineConfig = require('../../lib/engineConfig.cjs.js');
+var registry = require('../../lib/engines/registry.cjs.js');
 var catalogEntity = require('../../lib/catalogEntity.cjs.js');
+var prepareServeConfig = require('../../lib/prepareServeConfig.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
@@ -18,12 +19,17 @@ var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
 
 async function serveMkdocs(opts) {
   const logger = utility.createLogger({ verbose: opts.verbose });
+  if (opts.deprecatedCommandAlias) {
+    logger.warn(
+      `${opts.deprecatedCommandAlias} is deprecated and will be removed in a future release. Use serve:raw instead.`
+    );
+  }
   const { engine, source: engineSource } = await catalogEntity.resolveEngine(
     process.cwd(),
     opts.engine,
     logger
   );
-  const engineConfig$1 = engineConfig.getEngineConfig(engine, engineSource);
+  const engineConfig = registry.getEngineConfig(engine, engineSource);
   const localAddr = `http://127.0.0.1:${opts.port}`;
   if (opts.docker) {
     const isDockerOperational = await utils.checkIfDockerIsOperational(logger);
@@ -35,6 +41,11 @@ async function serveMkdocs(opts) {
     "./",
     opts.siteName
   );
+  const serveConfigPath = await prepareServeConfig.prepareServeConfig(
+    engineConfig,
+    mkdocsYmlPath,
+    logger
+  );
   let boolOpenBrowserTriggered = false;
   const logFunc = (data) => {
     const logLines = data.toString().split("\n");
@@ -44,7 +55,7 @@ async function serveMkdocs(opts) {
         return;
       }
       logger.verbose(`${logPrefix} ${line}`);
-      if (!boolOpenBrowserTriggered && line.includes(`${engineConfig$1.startupLogPattern}`)) {
+      if (!boolOpenBrowserTriggered && engineConfig.startupLogPattern.test(line)) {
         logger.info(`
 Starting ${engine} server on ${localAddr}
 `);
@@ -55,15 +66,15 @@ Starting ${engine} server on ${localAddr}
   };
   const childProcess = server.runEngineServer({
     port: opts.port,
-    dockerImage: opts.dockerImage,
+    dockerImage: opts.dockerImage ?? engineConfig.defaultImage,
     dockerEntrypoint: opts.dockerEntrypoint,
     dockerOptions: opts.dockerOption,
     useDocker: opts.docker,
     onStdout: logFunc,
     onStderr: logFunc,
-    engineBinary: engineConfig$1.binary,
-    engineServeArgs: engineConfig$1.serveArgs(opts.port, {
-      configFile: mkdocsYmlPath,
+    engineBinary: engineConfig.binary,
+    engineServeArgs: engineConfig.serveArgs(opts.port, {
+      configFile: serveConfigPath,
       useDocker: opts.docker
     })
   });

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

@@ -1 +1 @@
-{"version":3,"file":"mkdocs.cjs.js","sources":["../../../src/commands/serve/mkdocs.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 openBrowser from 'react-dev-utils/openBrowser';\nimport { createLogger } from '../../lib/utility';\nimport { runEngineServer } from '../../lib/server';\nimport { RunOnOutput } from '@backstage/cli-common';\nimport { getMkdocsYml } from '@backstage/plugin-techdocs-node';\nimport fs from 'fs-extra';\nimport { checkIfDockerIsOperational } from './utils';\nimport { getEngineConfig } from '../../lib/engineConfig';\nimport { resolveEngine } from '../../lib/catalogEntity';\n\nexport default async function serveMkdocs(opts: OptionValues) {\n  const logger = createLogger({ verbose: opts.verbose });\n\n  const { engine, source: engineSource } = await resolveEngine(\n    process.cwd(),\n    opts.engine,\n    logger,\n  );\n  const engineConfig = getEngineConfig(engine, engineSource);\n\n  const localAddr = `http://127.0.0.1:${opts.port}`;\n\n  if (opts.docker) {\n    const isDockerOperational = await checkIfDockerIsOperational(logger);\n    if (!isDockerOperational) {\n      return;\n    }\n  }\n\n  const { path: mkdocsYmlPath, configIsTemporary } = await getMkdocsYml(\n    './',\n    opts.siteName,\n  );\n\n  // We want to open browser only once based on a log.\n  let boolOpenBrowserTriggered = false;\n\n  const logFunc: RunOnOutput = data => {\n    // Sometimes the lines contain an unnecessary extra new line in between\n    const logLines = data.toString().split('\\n');\n    const logPrefix = opts.docker ? `[docker/${engine}]` : `[${engine}]`;\n    logLines.forEach(line => {\n      if (line === '') {\n        return;\n      }\n\n      // Logs from container is verbose.\n      logger.verbose(`${logPrefix} ${line}`);\n\n      // When the server has started, open a new browser tab for the user.\n      if (\n        !boolOpenBrowserTriggered &&\n        line.includes(`${engineConfig.startupLogPattern}`)\n      ) {\n        // Always open the local address, since 0.0.0.0 belongs to docker\n        logger.info(`\\nStarting ${engine} server on ${localAddr}\\n`);\n        openBrowser(localAddr);\n        boolOpenBrowserTriggered = true;\n      }\n    });\n  };\n  // Engines may log to stderr rather than stdout (mkdocs does, see\n  // https://github.com/mkdocs/mkdocs/issues/879), so watch both streams.\n\n  const childProcess = runEngineServer({\n    port: opts.port,\n    dockerImage: opts.dockerImage,\n    dockerEntrypoint: opts.dockerEntrypoint,\n    dockerOptions: opts.dockerOption,\n    useDocker: opts.docker,\n    onStdout: logFunc,\n    onStderr: logFunc,\n    engineBinary: engineConfig.binary,\n    engineServeArgs: engineConfig.serveArgs(opts.port, {\n      configFile: mkdocsYmlPath,\n      useDocker: opts.docker,\n    }),\n  });\n\n  // Keep waiting for user to cancel the process\n  await childProcess.waitForExit();\n\n  if (configIsTemporary) {\n    process.on('exit', async () => {\n      fs.rmSync(mkdocsYmlPath, {});\n    });\n  }\n}\n"],"names":["createLogger","resolveEngine","engineConfig","getEngineConfig","checkIfDockerIsOperational","getMkdocsYml","openBrowser","runEngineServer","fs"],"mappings":";;;;;;;;;;;;;;;;;;AA2BA,eAA8B,YAAY,IAAA,EAAoB;AAC5D,EAAA,MAAM,SAASA,oBAAA,CAAa,EAAE,OAAA,EAAS,IAAA,CAAK,SAAS,CAAA;AAErD,EAAA,MAAM,EAAE,MAAA,EAAQ,MAAA,EAAQ,YAAA,KAAiB,MAAMC,2BAAA;AAAA,IAC7C,QAAQ,GAAA,EAAI;AAAA,IACZ,IAAA,CAAK,MAAA;AAAA,IACL;AAAA,GACF;AACA,EAAA,MAAMC,cAAA,GAAeC,4BAAA,CAAgB,MAAA,EAAQ,YAAY,CAAA;AAEzD,EAAA,MAAM,SAAA,GAAY,CAAA,iBAAA,EAAoB,IAAA,CAAK,IAAI,CAAA,CAAA;AAE/C,EAAA,IAAI,KAAK,MAAA,EAAQ;AACf,IAAA,MAAM,mBAAA,GAAsB,MAAMC,gCAAA,CAA2B,MAAM,CAAA;AACnE,IAAA,IAAI,CAAC,mBAAA,EAAqB;AACxB,MAAA;AAAA,IACF;AAAA,EACF;AAEA,EAAA,MAAM,EAAE,IAAA,EAAM,aAAA,EAAe,iBAAA,KAAsB,MAAMC,+BAAA;AAAA,IACvD,IAAA;AAAA,IACA,IAAA,CAAK;AAAA,GACP;AAGA,EAAA,IAAI,wBAAA,GAA2B,KAAA;AAE/B,EAAA,MAAM,UAAuB,CAAA,IAAA,KAAQ;AAEnC,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,QAAA,EAAS,CAAE,MAAM,IAAI,CAAA;AAC3C,IAAA,MAAM,YAAY,IAAA,CAAK,MAAA,GAAS,WAAW,MAAM,CAAA,CAAA,CAAA,GAAM,IAAI,MAAM,CAAA,CAAA,CAAA;AACjE,IAAA,QAAA,CAAS,QAAQ,CAAA,IAAA,KAAQ;AACvB,MAAA,IAAI,SAAS,EAAA,EAAI;AACf,QAAA;AAAA,MACF;AAGA,MAAA,MAAA,CAAO,OAAA,CAAQ,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,IAAI,CAAA,CAAE,CAAA;AAGrC,MAAA,IACE,CAAC,4BACD,IAAA,CAAK,QAAA,CAAS,GAAGH,cAAA,CAAa,iBAAiB,EAAE,CAAA,EACjD;AAEA,QAAA,MAAA,CAAO,IAAA,CAAK;AAAA,SAAA,EAAc,MAAM,cAAc,SAAS;AAAA,CAAI,CAAA;AAC3D,QAAAI,4BAAA,CAAY,SAAS,CAAA;AACrB,QAAA,wBAAA,GAA2B,IAAA;AAAA,MAC7B;AAAA,IACF,CAAC,CAAA;AAAA,EACH,CAAA;AAIA,EAAA,MAAM,eAAeC,sBAAA,CAAgB;AAAA,IACnC,MAAM,IAAA,CAAK,IAAA;AAAA,IACX,aAAa,IAAA,CAAK,WAAA;AAAA,IAClB,kBAAkB,IAAA,CAAK,gBAAA;AAAA,IACvB,eAAe,IAAA,CAAK,YAAA;AAAA,IACpB,WAAW,IAAA,CAAK,MAAA;AAAA,IAChB,QAAA,EAAU,OAAA;AAAA,IACV,QAAA,EAAU,OAAA;AAAA,IACV,cAAcL,cAAA,CAAa,MAAA;AAAA,IAC3B,eAAA,EAAiBA,cAAA,CAAa,SAAA,CAAU,IAAA,CAAK,IAAA,EAAM;AAAA,MACjD,UAAA,EAAY,aAAA;AAAA,MACZ,WAAW,IAAA,CAAK;AAAA,KACjB;AAAA,GACF,CAAA;AAGD,EAAA,MAAM,aAAa,WAAA,EAAY;AAE/B,EAAA,IAAI,iBAAA,EAAmB;AACrB,IAAA,OAAA,CAAQ,EAAA,CAAG,QAAQ,YAAY;AAC7B,MAAAM,mBAAA,CAAG,MAAA,CAAO,aAAA,EAAe,EAAE,CAAA;AAAA,IAC7B,CAAC,CAAA;AAAA,EACH;AACF;;"}
+{"version":3,"file":"mkdocs.cjs.js","sources":["../../../src/commands/serve/mkdocs.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 openBrowser from 'react-dev-utils/openBrowser';\nimport { createLogger } from '../../lib/utility';\nimport { runEngineServer } from '../../lib/server';\nimport { RunOnOutput } from '@backstage/cli-common';\nimport { getMkdocsYml } from '@backstage/plugin-techdocs-node';\nimport fs from 'fs-extra';\nimport { checkIfDockerIsOperational } from './utils';\nimport { getEngineConfig } from '../../lib/engines';\nimport { resolveEngine } from '../../lib/catalogEntity';\nimport { prepareServeConfig } from '../../lib/prepareServeConfig';\n\nexport default async function serveMkdocs(opts: OptionValues) {\n  const logger = createLogger({ verbose: opts.verbose });\n  if (opts.deprecatedCommandAlias) {\n    logger.warn(\n      `${opts.deprecatedCommandAlias} is deprecated and will be removed in a future release. Use serve:raw instead.`,\n    );\n  }\n\n  const { engine, source: engineSource } = await resolveEngine(\n    process.cwd(),\n    opts.engine,\n    logger,\n  );\n  const engineConfig = getEngineConfig(engine, engineSource);\n\n  const localAddr = `http://127.0.0.1:${opts.port}`;\n\n  if (opts.docker) {\n    const isDockerOperational = await checkIfDockerIsOperational(logger);\n    if (!isDockerOperational) {\n      return;\n    }\n  }\n\n  const { path: mkdocsYmlPath, configIsTemporary } = await getMkdocsYml(\n    './',\n    opts.siteName,\n  );\n\n  const serveConfigPath = await prepareServeConfig(\n    engineConfig,\n    mkdocsYmlPath,\n    logger,\n  );\n\n  // We want to open browser only once based on a log.\n  let boolOpenBrowserTriggered = false;\n\n  const logFunc: RunOnOutput = data => {\n    // Sometimes the lines contain an unnecessary extra new line in between\n    const logLines = data.toString().split('\\n');\n    const logPrefix = opts.docker ? `[docker/${engine}]` : `[${engine}]`;\n    logLines.forEach(line => {\n      if (line === '') {\n        return;\n      }\n\n      // Logs from container is verbose.\n      logger.verbose(`${logPrefix} ${line}`);\n\n      // When the server has started, open a new browser tab for the user.\n      if (\n        !boolOpenBrowserTriggered &&\n        engineConfig.startupLogPattern.test(line)\n      ) {\n        // Always open the local address, since 0.0.0.0 belongs to docker\n        logger.info(`\\nStarting ${engine} server on ${localAddr}\\n`);\n        openBrowser(localAddr);\n        boolOpenBrowserTriggered = true;\n      }\n    });\n  };\n  // Engines may log to stderr rather than stdout (mkdocs does, see\n  // https://github.com/mkdocs/mkdocs/issues/879), so watch both streams.\n\n  const childProcess = runEngineServer({\n    port: opts.port,\n    dockerImage: opts.dockerImage ?? engineConfig.defaultImage,\n    dockerEntrypoint: opts.dockerEntrypoint,\n    dockerOptions: opts.dockerOption,\n    useDocker: opts.docker,\n    onStdout: logFunc,\n    onStderr: logFunc,\n    engineBinary: engineConfig.binary,\n    engineServeArgs: engineConfig.serveArgs(opts.port, {\n      configFile: serveConfigPath,\n      useDocker: opts.docker,\n    }),\n  });\n\n  // Keep waiting for user to cancel the process\n  await childProcess.waitForExit();\n\n  if (configIsTemporary) {\n    process.on('exit', async () => {\n      fs.rmSync(mkdocsYmlPath, {});\n    });\n  }\n}\n"],"names":["createLogger","resolveEngine","getEngineConfig","checkIfDockerIsOperational","getMkdocsYml","prepareServeConfig","openBrowser","runEngineServer","fs"],"mappings":";;;;;;;;;;;;;;;;;;;AA4BA,eAA8B,YAAY,IAAA,EAAoB;AAC5D,EAAA,MAAM,SAASA,oBAAA,CAAa,EAAE,OAAA,EAAS,IAAA,CAAK,SAAS,CAAA;AACrD,EAAA,IAAI,KAAK,sBAAA,EAAwB;AAC/B,IAAA,MAAA,CAAO,IAAA;AAAA,MACL,CAAA,EAAG,KAAK,sBAAsB,CAAA,8EAAA;AAAA,KAChC;AAAA,EACF;AAEA,EAAA,MAAM,EAAE,MAAA,EAAQ,MAAA,EAAQ,YAAA,KAAiB,MAAMC,2BAAA;AAAA,IAC7C,QAAQ,GAAA,EAAI;AAAA,IACZ,IAAA,CAAK,MAAA;AAAA,IACL;AAAA,GACF;AACA,EAAA,MAAM,YAAA,GAAeC,wBAAA,CAAgB,MAAA,EAAQ,YAAY,CAAA;AAEzD,EAAA,MAAM,SAAA,GAAY,CAAA,iBAAA,EAAoB,IAAA,CAAK,IAAI,CAAA,CAAA;AAE/C,EAAA,IAAI,KAAK,MAAA,EAAQ;AACf,IAAA,MAAM,mBAAA,GAAsB,MAAMC,gCAAA,CAA2B,MAAM,CAAA;AACnE,IAAA,IAAI,CAAC,mBAAA,EAAqB;AACxB,MAAA;AAAA,IACF;AAAA,EACF;AAEA,EAAA,MAAM,EAAE,IAAA,EAAM,aAAA,EAAe,iBAAA,KAAsB,MAAMC,+BAAA;AAAA,IACvD,IAAA;AAAA,IACA,IAAA,CAAK;AAAA,GACP;AAEA,EAAA,MAAM,kBAAkB,MAAMC,qCAAA;AAAA,IAC5B,YAAA;AAAA,IACA,aAAA;AAAA,IACA;AAAA,GACF;AAGA,EAAA,IAAI,wBAAA,GAA2B,KAAA;AAE/B,EAAA,MAAM,UAAuB,CAAA,IAAA,KAAQ;AAEnC,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,QAAA,EAAS,CAAE,MAAM,IAAI,CAAA;AAC3C,IAAA,MAAM,YAAY,IAAA,CAAK,MAAA,GAAS,WAAW,MAAM,CAAA,CAAA,CAAA,GAAM,IAAI,MAAM,CAAA,CAAA,CAAA;AACjE,IAAA,QAAA,CAAS,QAAQ,CAAA,IAAA,KAAQ;AACvB,MAAA,IAAI,SAAS,EAAA,EAAI;AACf,QAAA;AAAA,MACF;AAGA,MAAA,MAAA,CAAO,OAAA,CAAQ,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,IAAI,CAAA,CAAE,CAAA;AAGrC,MAAA,IACE,CAAC,wBAAA,IACD,YAAA,CAAa,iBAAA,CAAkB,IAAA,CAAK,IAAI,CAAA,EACxC;AAEA,QAAA,MAAA,CAAO,IAAA,CAAK;AAAA,SAAA,EAAc,MAAM,cAAc,SAAS;AAAA,CAAI,CAAA;AAC3D,QAAAC,4BAAA,CAAY,SAAS,CAAA;AACrB,QAAA,wBAAA,GAA2B,IAAA;AAAA,MAC7B;AAAA,IACF,CAAC,CAAA;AAAA,EACH,CAAA;AAIA,EAAA,MAAM,eAAeC,sBAAA,CAAgB;AAAA,IACnC,MAAM,IAAA,CAAK,IAAA;AAAA,IACX,WAAA,EAAa,IAAA,CAAK,WAAA,IAAe,YAAA,CAAa,YAAA;AAAA,IAC9C,kBAAkB,IAAA,CAAK,gBAAA;AAAA,IACvB,eAAe,IAAA,CAAK,YAAA;AAAA,IACpB,WAAW,IAAA,CAAK,MAAA;AAAA,IAChB,QAAA,EAAU,OAAA;AAAA,IACV,QAAA,EAAU,OAAA;AAAA,IACV,cAAc,YAAA,CAAa,MAAA;AAAA,IAC3B,eAAA,EAAiB,YAAA,CAAa,SAAA,CAAU,IAAA,CAAK,IAAA,EAAM;AAAA,MACjD,UAAA,EAAY,eAAA;AAAA,MACZ,WAAW,IAAA,CAAK;AAAA,KACjB;AAAA,GACF,CAAA;AAGD,EAAA,MAAM,aAAa,WAAA,EAAY;AAE/B,EAAA,IAAI,iBAAA,EAAmB;AACrB,IAAA,OAAA,CAAQ,EAAA,CAAG,QAAQ,YAAY;AAC7B,MAAAC,mBAAA,CAAG,MAAA,CAAO,aAAA,EAAe,EAAE,CAAA;AAAA,IAC7B,CAAC,CAAA;AAAA,EACH;AACF;;"}

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

@@ -11,8 +11,9 @@ var utility = require('../../lib/utility.cjs.js');
 var pluginTechdocsNode = require('@backstage/plugin-techdocs-node');
 var fs = require('fs-extra');
 var utils = require('./utils.cjs.js');
-var engineConfig = require('../../lib/engineConfig.cjs.js');
+var registry = require('../../lib/engines/registry.cjs.js');
 var catalogEntity = require('../../lib/catalogEntity.cjs.js');
+var prepareServeConfig = require('../../lib/prepareServeConfig.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
@@ -40,15 +41,15 @@ async function serve(opts) {
     opts.engine,
     logger
   );
-  const engineConfig$1 = engineConfig.getEngineConfig(engine, engineSource);
+  const engineConfig = registry.getEngineConfig(engine, engineSource);
   const isDevMode = Object.keys(process.env).includes("TECHDOCS_CLI_DEV_MODE") ? true : false;
   const backstageBackendPort = 7007;
-  const enginePort = opts.enginePort ?? opts.mkdocsPort ?? "8000";
-  if (opts.mkdocsPort && !opts.enginePort) {
-    logger.warn(
-      "--mkdocs-port is deprecated and will be removed in a future release. Use --engine-port instead."
-    );
-  }
+  const enginePort = utils.resolveDeprecatedOption(logger, {
+    value: opts.enginePort,
+    flag: "--engine-port",
+    deprecatedValue: opts.mkdocsPort,
+    deprecatedFlag: "--mkdocs-port"
+  }) ?? "8000";
   for (const flag of ["Clean", "Dirtyreload", "Strict"]) {
     if (opts[`mkdocsParameter${flag}`]) {
       logger.warn(
@@ -59,17 +60,22 @@ async function serve(opts) {
   const engineDockerAddr = `http://0.0.0.0:${enginePort}`;
   const engineLocalAddr = `http://127.0.0.1:${enginePort}`;
   const engineExpectedDevAddr = opts.docker ? engineDockerAddr : engineLocalAddr;
-  const configFileName = opts.configFileName ?? opts.mkdocsConfigFileName;
-  if (opts.mkdocsConfigFileName && !opts.configFileName) {
-    logger.warn(
-      "--mkdocs-config-file-name is deprecated and will be removed in a future release. Use --config-file-name instead."
-    );
-  }
+  const configFileName = utils.resolveDeprecatedOption(logger, {
+    value: opts.configFileName,
+    flag: "--config-file-name",
+    deprecatedValue: opts.mkdocsConfigFileName,
+    deprecatedFlag: "--mkdocs-config-file-name"
+  });
   const siteName = opts.siteName;
   const { path: mkdocsYmlPath, configIsTemporary } = await pluginTechdocsNode.getMkdocsYml("./", {
     name: siteName,
     mkdocsConfigFileName: configFileName
   });
+  const serveConfigPath = await prepareServeConfig.prepareServeConfig(
+    engineConfig,
+    mkdocsYmlPath,
+    logger
+  );
   if (opts.docker) {
     const isDockerOperational = await utils.checkIfDockerIsOperational(logger);
     if (!isDockerOperational) {
@@ -85,7 +91,7 @@ async function serve(opts) {
         return;
       }
       logger.verbose(`${logPrefix} ${line}`);
-      if (!docsServerHasStarted && line.includes(`${engineConfig$1.startupLogPattern}`)) {
+      if (!docsServerHasStarted && engineConfig.startupLogPattern.test(line)) {
         docsServerHasStarted = true;
       }
     });
@@ -93,15 +99,15 @@ async function serve(opts) {
   logger.info(`Starting ${engine} server.`);
   const docsChildProcess = server.runEngineServer({
     port: enginePort,
-    dockerImage: opts.dockerImage,
+    dockerImage: opts.dockerImage ?? engineConfig.defaultImage,
     dockerEntrypoint: opts.dockerEntrypoint,
     dockerOptions: opts.dockerOption,
     useDocker: opts.docker,
     onStdout: docsLogFunc,
     onStderr: docsLogFunc,
-    engineBinary: engineConfig$1.binary,
-    engineServeArgs: engineConfig$1.serveArgs(enginePort, {
-      configFile: mkdocsYmlPath,
+    engineBinary: engineConfig.binary,
+    engineServeArgs: engineConfig.serveArgs(enginePort, {
+      configFile: serveConfigPath,
       clean: opts.parameterClean || opts.mkdocsParameterClean,
       dirtyReload: opts.parameterDirtyreload || opts.mkdocsParameterDirtyreload,
       strict: opts.parameterStrict || opts.mkdocsParameterStrict,
@@ -127,7 +133,7 @@ async function serve(opts) {
     port,
     engineExpectedDevAddr,
     opts.verbose,
-    engineConfig$1
+    engineConfig
   );
   httpServer$1.serve().catch((err) => {
     logger.error("Failed to start HTTP server", err);

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

@@ -1 +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 'node:path';\nimport openBrowser from 'react-dev-utils/openBrowser';\nimport { findOwnPaths, RunOnOutput } from '@backstage/cli-common';\nimport HTTPServer from '../../lib/httpServer';\nimport { runEngineServer } from '../../lib/server';\nimport { createLogger } from '../../lib/utility';\nimport { getMkdocsYml } from '@backstage/plugin-techdocs-node';\nimport fs from 'fs-extra';\nimport { checkIfDockerIsOperational } from './utils';\nimport { getEngineConfig } from '../../lib/engineConfig';\nimport { resolveEngine } from '../../lib/catalogEntity';\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 findOwnPaths(__dirname).resolve('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  const { engine, source: engineSource } = await resolveEngine(\n    process.cwd(),\n    opts.engine,\n    logger,\n  );\n  const engineConfig = getEngineConfig(engine, engineSource);\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 enginePort = opts.enginePort ?? opts.mkdocsPort ?? '8000';\n  if (opts.mkdocsPort && !opts.enginePort) {\n    logger.warn(\n      '--mkdocs-port is deprecated and will be removed in a future release. Use --engine-port instead.',\n    );\n  }\n  for (const flag of ['Clean', 'Dirtyreload', 'Strict']) {\n    if (opts[`mkdocsParameter${flag}`]) {\n      logger.warn(\n        `--mkdocs-parameter-${flag.toLowerCase()} is deprecated and will be removed in a future release. Use --parameter-${flag.toLowerCase()} instead.`,\n      );\n    }\n  }\n\n  const engineDockerAddr = `http://0.0.0.0:${enginePort}`;\n  const engineLocalAddr = `http://127.0.0.1:${enginePort}`;\n  const engineExpectedDevAddr = opts.docker\n    ? engineDockerAddr\n    : engineLocalAddr;\n\n  const configFileName = opts.configFileName ?? opts.mkdocsConfigFileName;\n  if (opts.mkdocsConfigFileName && !opts.configFileName) {\n    logger.warn(\n      '--mkdocs-config-file-name is deprecated and will be removed in a future release. Use --config-file-name instead.',\n    );\n  }\n  const siteName = opts.siteName;\n\n  const { path: mkdocsYmlPath, configIsTemporary } = await getMkdocsYml('./', {\n    name: siteName,\n    mkdocsConfigFileName: configFileName,\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 docsServerHasStarted = false;\n  const docsLogFunc: RunOnOutput = data => {\n    const logLines = data.toString().split('\\n');\n    const logPrefix = opts.docker ? `[docker/${engine}]` : `[${engine}]`;\n    logLines.forEach(line => {\n      if (line === '') {\n        return;\n      }\n\n      logger.verbose(`${logPrefix} ${line}`);\n\n      if (\n        !docsServerHasStarted &&\n        line.includes(`${engineConfig.startupLogPattern}`)\n      ) {\n        docsServerHasStarted = true;\n      }\n    });\n  };\n  logger.info(`Starting ${engine} server.`);\n  const docsChildProcess = runEngineServer({\n    port: enginePort,\n    dockerImage: opts.dockerImage,\n    dockerEntrypoint: opts.dockerEntrypoint,\n    dockerOptions: opts.dockerOption,\n    useDocker: opts.docker,\n    onStdout: docsLogFunc,\n    onStderr: docsLogFunc,\n    engineBinary: engineConfig.binary,\n    engineServeArgs: engineConfig.serveArgs(enginePort, {\n      configFile: mkdocsYmlPath,\n      clean: opts.parameterClean || opts.mkdocsParameterClean,\n      dirtyReload: opts.parameterDirtyreload || opts.mkdocsParameterDirtyreload,\n      strict: opts.parameterStrict || opts.mkdocsParameterStrict,\n      useDocker: opts.docker,\n    }),\n  });\n\n  for (let attempt = 0; attempt < 30; attempt++) {\n    await new Promise(r => setTimeout(r, 3000));\n    if (docsServerHasStarted) {\n      break;\n    }\n    logger.info(`Waiting for ${engine} server to start...`);\n  }\n\n  if (!docsServerHasStarted) {\n    logger.error(\n      `${engine} 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    engineExpectedDevAddr,\n    opts.verbose,\n    engineConfig,\n  );\n\n  httpServer\n    .serve()\n    .catch(err => {\n      logger.error('Failed to start HTTP server', err);\n      docsChildProcess.kill();\n      process.exit(1);\n    })\n    .then(() => {\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 docsChildProcess.waitForExit();\n\n  if (configIsTemporary) {\n    process.on('exit', async () => {\n      fs.rmSync(mkdocsYmlPath, {});\n    });\n  }\n}\n"],"names":["path","findOwnPaths","createLogger","resolveEngine","engineConfig","getEngineConfig","getMkdocsYml","checkIfDockerIsOperational","runEngineServer","httpServer","HTTPServer","openBrowser","fs"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AA6BA,SAAS,qBAAA,GAAgC;AACvC,EAAA,IAAI;AACF,IAAA,OAAOA,qBAAA,CAAK,IAAA;AAAA,MACVA,qBAAA,CAAK,OAAA,CAAQ,OAAA,CAAQ,OAAA,CAAQ,wCAAwC,CAAC,CAAA;AAAA,MACtE;AAAA,KACF;AAAA,EACF,CAAA,CAAA,MAAQ;AASN,IAAA,OAAOC,sBAAA,CAAa,SAAS,CAAA,CAAE,OAAA,CAAQ,mBAAmB,CAAA;AAAA,EAC5D;AACF;AAEA,SAAS,kBAAkB,IAAA,EAA4B;AACrD,EAAA,OAAO,IAAA,CAAK,wBAAwB,qBAAA,EAAsB;AAC5D;AAEA,eAA8B,MAAM,IAAA,EAAoB;AACtD,EAAA,MAAM,SAASC,oBAAA,CAAa,EAAE,OAAA,EAAS,IAAA,CAAK,SAAS,CAAA;AAErD,EAAA,MAAM,EAAE,MAAA,EAAQ,MAAA,EAAQ,YAAA,KAAiB,MAAMC,2BAAA;AAAA,IAC7C,QAAQ,GAAA,EAAI;AAAA,IACZ,IAAA,CAAK,MAAA;AAAA,IACL;AAAA,GACF;AACA,EAAA,MAAMC,cAAA,GAAeC,4BAAA,CAAgB,MAAA,EAAQ,YAAY,CAAA;AAKzD,EAAA,MAAM,SAAA,GAAY,OAAO,IAAA,CAAK,OAAA,CAAQ,GAAG,CAAA,CAAE,QAAA,CAAS,uBAAuB,CAAA,GACvE,IAAA,GACA,KAAA;AAEJ,EAAA,MAAM,oBAAA,GAAuB,IAAA;AAE7B,EAAA,MAAM,UAAA,GAAa,IAAA,CAAK,UAAA,IAAc,IAAA,CAAK,UAAA,IAAc,MAAA;AACzD,EAAA,IAAI,IAAA,CAAK,UAAA,IAAc,CAAC,IAAA,CAAK,UAAA,EAAY;AACvC,IAAA,MAAA,CAAO,IAAA;AAAA,MACL;AAAA,KACF;AAAA,EACF;AACA,EAAA,KAAA,MAAW,IAAA,IAAQ,CAAC,OAAA,EAAS,aAAA,EAAe,QAAQ,CAAA,EAAG;AACrD,IAAA,IAAI,IAAA,CAAK,CAAA,eAAA,EAAkB,IAAI,CAAA,CAAE,CAAA,EAAG;AAClC,MAAA,MAAA,CAAO,IAAA;AAAA,QACL,sBAAsB,IAAA,CAAK,WAAA,EAAa,CAAA,wEAAA,EAA2E,IAAA,CAAK,aAAa,CAAA,SAAA;AAAA,OACvI;AAAA,IACF;AAAA,EACF;AAEA,EAAA,MAAM,gBAAA,GAAmB,kBAAkB,UAAU,CAAA,CAAA;AACrD,EAAA,MAAM,eAAA,GAAkB,oBAAoB,UAAU,CAAA,CAAA;AACtD,EAAA,MAAM,qBAAA,GAAwB,IAAA,CAAK,MAAA,GAC/B,gBAAA,GACA,eAAA;AAEJ,EAAA,MAAM,cAAA,GAAiB,IAAA,CAAK,cAAA,IAAkB,IAAA,CAAK,oBAAA;AACnD,EAAA,IAAI,IAAA,CAAK,oBAAA,IAAwB,CAAC,IAAA,CAAK,cAAA,EAAgB;AACrD,IAAA,MAAA,CAAO,IAAA;AAAA,MACL;AAAA,KACF;AAAA,EACF;AACA,EAAA,MAAM,WAAW,IAAA,CAAK,QAAA;AAEtB,EAAA,MAAM,EAAE,IAAA,EAAM,aAAA,EAAe,mBAAkB,GAAI,MAAMC,gCAAa,IAAA,EAAM;AAAA,IAC1E,IAAA,EAAM,QAAA;AAAA,IACN,oBAAA,EAAsB;AAAA,GACvB,CAAA;AAGD,EAAA,IAAI,KAAK,MAAA,EAAQ;AACf,IAAA,MAAM,mBAAA,GAAsB,MAAMC,gCAAA,CAA2B,MAAM,CAAA;AACnE,IAAA,IAAI,CAAC,mBAAA,EAAqB;AACxB,MAAA;AAAA,IACF;AAAA,EACF;AAEA,EAAA,IAAI,oBAAA,GAAuB,KAAA;AAC3B,EAAA,MAAM,cAA2B,CAAA,IAAA,KAAQ;AACvC,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,QAAA,EAAS,CAAE,MAAM,IAAI,CAAA;AAC3C,IAAA,MAAM,YAAY,IAAA,CAAK,MAAA,GAAS,WAAW,MAAM,CAAA,CAAA,CAAA,GAAM,IAAI,MAAM,CAAA,CAAA,CAAA;AACjE,IAAA,QAAA,CAAS,QAAQ,CAAA,IAAA,KAAQ;AACvB,MAAA,IAAI,SAAS,EAAA,EAAI;AACf,QAAA;AAAA,MACF;AAEA,MAAA,MAAA,CAAO,OAAA,CAAQ,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,IAAI,CAAA,CAAE,CAAA;AAErC,MAAA,IACE,CAAC,wBACD,IAAA,CAAK,QAAA,CAAS,GAAGH,cAAA,CAAa,iBAAiB,EAAE,CAAA,EACjD;AACA,QAAA,oBAAA,GAAuB,IAAA;AAAA,MACzB;AAAA,IACF,CAAC,CAAA;AAAA,EACH,CAAA;AACA,EAAA,MAAA,CAAO,IAAA,CAAK,CAAA,SAAA,EAAY,MAAM,CAAA,QAAA,CAAU,CAAA;AACxC,EAAA,MAAM,mBAAmBI,sBAAA,CAAgB;AAAA,IACvC,IAAA,EAAM,UAAA;AAAA,IACN,aAAa,IAAA,CAAK,WAAA;AAAA,IAClB,kBAAkB,IAAA,CAAK,gBAAA;AAAA,IACvB,eAAe,IAAA,CAAK,YAAA;AAAA,IACpB,WAAW,IAAA,CAAK,MAAA;AAAA,IAChB,QAAA,EAAU,WAAA;AAAA,IACV,QAAA,EAAU,WAAA;AAAA,IACV,cAAcJ,cAAA,CAAa,MAAA;AAAA,IAC3B,eAAA,EAAiBA,cAAA,CAAa,SAAA,CAAU,UAAA,EAAY;AAAA,MAClD,UAAA,EAAY,aAAA;AAAA,MACZ,KAAA,EAAO,IAAA,CAAK,cAAA,IAAkB,IAAA,CAAK,oBAAA;AAAA,MACnC,WAAA,EAAa,IAAA,CAAK,oBAAA,IAAwB,IAAA,CAAK,0BAAA;AAAA,MAC/C,MAAA,EAAQ,IAAA,CAAK,eAAA,IAAmB,IAAA,CAAK,qBAAA;AAAA,MACrC,WAAW,IAAA,CAAK;AAAA,KACjB;AAAA,GACF,CAAA;AAED,EAAA,KAAA,IAAS,OAAA,GAAU,CAAA,EAAG,OAAA,GAAU,EAAA,EAAI,OAAA,EAAA,EAAW;AAC7C,IAAA,MAAM,IAAI,OAAA,CAAQ,CAAA,CAAA,KAAK,UAAA,CAAW,CAAA,EAAG,GAAI,CAAC,CAAA;AAC1C,IAAA,IAAI,oBAAA,EAAsB;AACxB,MAAA;AAAA,IACF;AACA,IAAA,MAAA,CAAO,IAAA,CAAK,CAAA,YAAA,EAAe,MAAM,CAAA,mBAAA,CAAqB,CAAA;AAAA,EACxD;AAEA,EAAA,IAAI,CAAC,oBAAA,EAAsB;AACzB,IAAA,MAAA,CAAO,KAAA;AAAA,MACL,GAAG,MAAM,CAAA,uFAAA;AAAA,KACX;AAAA,EACF;AAEA,EAAA,MAAM,IAAA,GAAO,SAAA,GAAY,oBAAA,GAAuB,IAAA,CAAK,cAAA;AACrD,EAAA,MAAM,cAAA,GAAiB,kBAAkB,IAAI,CAAA;AAC7C,EAAA,MAAMK,eAAa,IAAIC,kBAAA;AAAA,IACrB,cAAA;AAAA,IACA,IAAA;AAAA,IACA,qBAAA;AAAA,IACA,IAAA,CAAK,OAAA;AAAA,IACLN;AAAA,GACF;AAEA,EAAAK,YAAA,CACG,KAAA,EAAM,CACN,KAAA,CAAM,CAAA,GAAA,KAAO;AACZ,IAAA,MAAA,CAAO,KAAA,CAAM,+BAA+B,GAAG,CAAA;AAC/C,IAAA,gBAAA,CAAiB,IAAA,EAAK;AACtB,IAAA,OAAA,CAAQ,KAAK,CAAC,CAAA;AAAA,EAChB,CAAC,CAAA,CACA,IAAA,CAAK,MAAM;AACV,IAAAE,4BAAA,CAAY,CAAA,iBAAA,EAAoB,IAAI,CAAA,8BAAA,CAAgC,CAAA;AACpE,IAAA,MAAA,CAAO,IAAA;AAAA,MACL,iDAAiD,IAAI,CAAA;AAAA,gBAAA;AAAA,KACvD;AAAA,EACF,CAAC,CAAA;AAEH,EAAA,MAAM,iBAAiB,WAAA,EAAY;AAEnC,EAAA,IAAI,iBAAA,EAAmB;AACrB,IAAA,OAAA,CAAQ,EAAA,CAAG,QAAQ,YAAY;AAC7B,MAAAC,mBAAA,CAAG,MAAA,CAAO,aAAA,EAAe,EAAE,CAAA;AAAA,IAC7B,CAAC,CAAA;AAAA,EACH;AACF;;"}
+{"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 'node:path';\nimport openBrowser from 'react-dev-utils/openBrowser';\nimport { findOwnPaths, RunOnOutput } from '@backstage/cli-common';\nimport HTTPServer from '../../lib/httpServer';\nimport { runEngineServer } from '../../lib/server';\nimport { createLogger } from '../../lib/utility';\nimport { getMkdocsYml } from '@backstage/plugin-techdocs-node';\nimport fs from 'fs-extra';\nimport { checkIfDockerIsOperational, resolveDeprecatedOption } from './utils';\nimport { getEngineConfig } from '../../lib/engines';\nimport { resolveEngine } from '../../lib/catalogEntity';\nimport { prepareServeConfig } from '../../lib/prepareServeConfig';\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 findOwnPaths(__dirname).resolve('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  const { engine, source: engineSource } = await resolveEngine(\n    process.cwd(),\n    opts.engine,\n    logger,\n  );\n  const engineConfig = getEngineConfig(engine, engineSource);\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 enginePort =\n    resolveDeprecatedOption(logger, {\n      value: opts.enginePort,\n      flag: '--engine-port',\n      deprecatedValue: opts.mkdocsPort,\n      deprecatedFlag: '--mkdocs-port',\n    }) ?? '8000';\n  for (const flag of ['Clean', 'Dirtyreload', 'Strict']) {\n    if (opts[`mkdocsParameter${flag}`]) {\n      logger.warn(\n        `--mkdocs-parameter-${flag.toLowerCase()} is deprecated and will be removed in a future release. Use --parameter-${flag.toLowerCase()} instead.`,\n      );\n    }\n  }\n\n  const engineDockerAddr = `http://0.0.0.0:${enginePort}`;\n  const engineLocalAddr = `http://127.0.0.1:${enginePort}`;\n  const engineExpectedDevAddr = opts.docker\n    ? engineDockerAddr\n    : engineLocalAddr;\n\n  const configFileName = resolveDeprecatedOption(logger, {\n    value: opts.configFileName,\n    flag: '--config-file-name',\n    deprecatedValue: opts.mkdocsConfigFileName,\n    deprecatedFlag: '--mkdocs-config-file-name',\n  });\n  const siteName = opts.siteName;\n\n  const { path: mkdocsYmlPath, configIsTemporary } = await getMkdocsYml('./', {\n    name: siteName,\n    mkdocsConfigFileName: configFileName,\n  });\n\n  const serveConfigPath = await prepareServeConfig(\n    engineConfig,\n    mkdocsYmlPath,\n    logger,\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 docsServerHasStarted = false;\n  const docsLogFunc: RunOnOutput = data => {\n    const logLines = data.toString().split('\\n');\n    const logPrefix = opts.docker ? `[docker/${engine}]` : `[${engine}]`;\n    logLines.forEach(line => {\n      if (line === '') {\n        return;\n      }\n\n      logger.verbose(`${logPrefix} ${line}`);\n\n      if (!docsServerHasStarted && engineConfig.startupLogPattern.test(line)) {\n        docsServerHasStarted = true;\n      }\n    });\n  };\n  logger.info(`Starting ${engine} server.`);\n  const docsChildProcess = runEngineServer({\n    port: enginePort,\n    dockerImage: opts.dockerImage ?? engineConfig.defaultImage,\n    dockerEntrypoint: opts.dockerEntrypoint,\n    dockerOptions: opts.dockerOption,\n    useDocker: opts.docker,\n    onStdout: docsLogFunc,\n    onStderr: docsLogFunc,\n    engineBinary: engineConfig.binary,\n    engineServeArgs: engineConfig.serveArgs(enginePort, {\n      configFile: serveConfigPath,\n      clean: opts.parameterClean || opts.mkdocsParameterClean,\n      dirtyReload: opts.parameterDirtyreload || opts.mkdocsParameterDirtyreload,\n      strict: opts.parameterStrict || opts.mkdocsParameterStrict,\n      useDocker: opts.docker,\n    }),\n  });\n\n  for (let attempt = 0; attempt < 30; attempt++) {\n    await new Promise(r => setTimeout(r, 3000));\n    if (docsServerHasStarted) {\n      break;\n    }\n    logger.info(`Waiting for ${engine} server to start...`);\n  }\n\n  if (!docsServerHasStarted) {\n    logger.error(\n      `${engine} 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    engineExpectedDevAddr,\n    opts.verbose,\n    engineConfig,\n  );\n\n  httpServer\n    .serve()\n    .catch(err => {\n      logger.error('Failed to start HTTP server', err);\n      docsChildProcess.kill();\n      process.exit(1);\n    })\n    .then(() => {\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 docsChildProcess.waitForExit();\n\n  if (configIsTemporary) {\n    process.on('exit', async () => {\n      fs.rmSync(mkdocsYmlPath, {});\n    });\n  }\n}\n"],"names":["path","findOwnPaths","createLogger","resolveEngine","getEngineConfig","resolveDeprecatedOption","getMkdocsYml","prepareServeConfig","checkIfDockerIsOperational","runEngineServer","httpServer","HTTPServer","openBrowser","fs"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AA8BA,SAAS,qBAAA,GAAgC;AACvC,EAAA,IAAI;AACF,IAAA,OAAOA,qBAAA,CAAK,IAAA;AAAA,MACVA,qBAAA,CAAK,OAAA,CAAQ,OAAA,CAAQ,OAAA,CAAQ,wCAAwC,CAAC,CAAA;AAAA,MACtE;AAAA,KACF;AAAA,EACF,CAAA,CAAA,MAAQ;AASN,IAAA,OAAOC,sBAAA,CAAa,SAAS,CAAA,CAAE,OAAA,CAAQ,mBAAmB,CAAA;AAAA,EAC5D;AACF;AAEA,SAAS,kBAAkB,IAAA,EAA4B;AACrD,EAAA,OAAO,IAAA,CAAK,wBAAwB,qBAAA,EAAsB;AAC5D;AAEA,eAA8B,MAAM,IAAA,EAAoB;AACtD,EAAA,MAAM,SAASC,oBAAA,CAAa,EAAE,OAAA,EAAS,IAAA,CAAK,SAAS,CAAA;AAErD,EAAA,MAAM,EAAE,MAAA,EAAQ,MAAA,EAAQ,YAAA,KAAiB,MAAMC,2BAAA;AAAA,IAC7C,QAAQ,GAAA,EAAI;AAAA,IACZ,IAAA,CAAK,MAAA;AAAA,IACL;AAAA,GACF;AACA,EAAA,MAAM,YAAA,GAAeC,wBAAA,CAAgB,MAAA,EAAQ,YAAY,CAAA;AAKzD,EAAA,MAAM,SAAA,GAAY,OAAO,IAAA,CAAK,OAAA,CAAQ,GAAG,CAAA,CAAE,QAAA,CAAS,uBAAuB,CAAA,GACvE,IAAA,GACA,KAAA;AAEJ,EAAA,MAAM,oBAAA,GAAuB,IAAA;AAE7B,EAAA,MAAM,UAAA,GACJC,8BAAwB,MAAA,EAAQ;AAAA,IAC9B,OAAO,IAAA,CAAK,UAAA;AAAA,IACZ,IAAA,EAAM,eAAA;AAAA,IACN,iBAAiB,IAAA,CAAK,UAAA;AAAA,IACtB,cAAA,EAAgB;AAAA,GACjB,CAAA,IAAK,MAAA;AACR,EAAA,KAAA,MAAW,IAAA,IAAQ,CAAC,OAAA,EAAS,aAAA,EAAe,QAAQ,CAAA,EAAG;AACrD,IAAA,IAAI,IAAA,CAAK,CAAA,eAAA,EAAkB,IAAI,CAAA,CAAE,CAAA,EAAG;AAClC,MAAA,MAAA,CAAO,IAAA;AAAA,QACL,sBAAsB,IAAA,CAAK,WAAA,EAAa,CAAA,wEAAA,EAA2E,IAAA,CAAK,aAAa,CAAA,SAAA;AAAA,OACvI;AAAA,IACF;AAAA,EACF;AAEA,EAAA,MAAM,gBAAA,GAAmB,kBAAkB,UAAU,CAAA,CAAA;AACrD,EAAA,MAAM,eAAA,GAAkB,oBAAoB,UAAU,CAAA,CAAA;AACtD,EAAA,MAAM,qBAAA,GAAwB,IAAA,CAAK,MAAA,GAC/B,gBAAA,GACA,eAAA;AAEJ,EAAA,MAAM,cAAA,GAAiBA,8BAAwB,MAAA,EAAQ;AAAA,IACrD,OAAO,IAAA,CAAK,cAAA;AAAA,IACZ,IAAA,EAAM,oBAAA;AAAA,IACN,iBAAiB,IAAA,CAAK,oBAAA;AAAA,IACtB,cAAA,EAAgB;AAAA,GACjB,CAAA;AACD,EAAA,MAAM,WAAW,IAAA,CAAK,QAAA;AAEtB,EAAA,MAAM,EAAE,IAAA,EAAM,aAAA,EAAe,mBAAkB,GAAI,MAAMC,gCAAa,IAAA,EAAM;AAAA,IAC1E,IAAA,EAAM,QAAA;AAAA,IACN,oBAAA,EAAsB;AAAA,GACvB,CAAA;AAED,EAAA,MAAM,kBAAkB,MAAMC,qCAAA;AAAA,IAC5B,YAAA;AAAA,IACA,aAAA;AAAA,IACA;AAAA,GACF;AAGA,EAAA,IAAI,KAAK,MAAA,EAAQ;AACf,IAAA,MAAM,mBAAA,GAAsB,MAAMC,gCAAA,CAA2B,MAAM,CAAA;AACnE,IAAA,IAAI,CAAC,mBAAA,EAAqB;AACxB,MAAA;AAAA,IACF;AAAA,EACF;AAEA,EAAA,IAAI,oBAAA,GAAuB,KAAA;AAC3B,EAAA,MAAM,cAA2B,CAAA,IAAA,KAAQ;AACvC,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,QAAA,EAAS,CAAE,MAAM,IAAI,CAAA;AAC3C,IAAA,MAAM,YAAY,IAAA,CAAK,MAAA,GAAS,WAAW,MAAM,CAAA,CAAA,CAAA,GAAM,IAAI,MAAM,CAAA,CAAA,CAAA;AACjE,IAAA,QAAA,CAAS,QAAQ,CAAA,IAAA,KAAQ;AACvB,MAAA,IAAI,SAAS,EAAA,EAAI;AACf,QAAA;AAAA,MACF;AAEA,MAAA,MAAA,CAAO,OAAA,CAAQ,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,IAAI,CAAA,CAAE,CAAA;AAErC,MAAA,IAAI,CAAC,oBAAA,IAAwB,YAAA,CAAa,iBAAA,CAAkB,IAAA,CAAK,IAAI,CAAA,EAAG;AACtE,QAAA,oBAAA,GAAuB,IAAA;AAAA,MACzB;AAAA,IACF,CAAC,CAAA;AAAA,EACH,CAAA;AACA,EAAA,MAAA,CAAO,IAAA,CAAK,CAAA,SAAA,EAAY,MAAM,CAAA,QAAA,CAAU,CAAA;AACxC,EAAA,MAAM,mBAAmBC,sBAAA,CAAgB;AAAA,IACvC,IAAA,EAAM,UAAA;AAAA,IACN,WAAA,EAAa,IAAA,CAAK,WAAA,IAAe,YAAA,CAAa,YAAA;AAAA,IAC9C,kBAAkB,IAAA,CAAK,gBAAA;AAAA,IACvB,eAAe,IAAA,CAAK,YAAA;AAAA,IACpB,WAAW,IAAA,CAAK,MAAA;AAAA,IAChB,QAAA,EAAU,WAAA;AAAA,IACV,QAAA,EAAU,WAAA;AAAA,IACV,cAAc,YAAA,CAAa,MAAA;AAAA,IAC3B,eAAA,EAAiB,YAAA,CAAa,SAAA,CAAU,UAAA,EAAY;AAAA,MAClD,UAAA,EAAY,eAAA;AAAA,MACZ,KAAA,EAAO,IAAA,CAAK,cAAA,IAAkB,IAAA,CAAK,oBAAA;AAAA,MACnC,WAAA,EAAa,IAAA,CAAK,oBAAA,IAAwB,IAAA,CAAK,0BAAA;AAAA,MAC/C,MAAA,EAAQ,IAAA,CAAK,eAAA,IAAmB,IAAA,CAAK,qBAAA;AAAA,MACrC,WAAW,IAAA,CAAK;AAAA,KACjB;AAAA,GACF,CAAA;AAED,EAAA,KAAA,IAAS,OAAA,GAAU,CAAA,EAAG,OAAA,GAAU,EAAA,EAAI,OAAA,EAAA,EAAW;AAC7C,IAAA,MAAM,IAAI,OAAA,CAAQ,CAAA,CAAA,KAAK,UAAA,CAAW,CAAA,EAAG,GAAI,CAAC,CAAA;AAC1C,IAAA,IAAI,oBAAA,EAAsB;AACxB,MAAA;AAAA,IACF;AACA,IAAA,MAAA,CAAO,IAAA,CAAK,CAAA,YAAA,EAAe,MAAM,CAAA,mBAAA,CAAqB,CAAA;AAAA,EACxD;AAEA,EAAA,IAAI,CAAC,oBAAA,EAAsB;AACzB,IAAA,MAAA,CAAO,KAAA;AAAA,MACL,GAAG,MAAM,CAAA,uFAAA;AAAA,KACX;AAAA,EACF;AAEA,EAAA,MAAM,IAAA,GAAO,SAAA,GAAY,oBAAA,GAAuB,IAAA,CAAK,cAAA;AACrD,EAAA,MAAM,cAAA,GAAiB,kBAAkB,IAAI,CAAA;AAC7C,EAAA,MAAMC,eAAa,IAAIC,kBAAA;AAAA,IACrB,cAAA;AAAA,IACA,IAAA;AAAA,IACA,qBAAA;AAAA,IACA,IAAA,CAAK,OAAA;AAAA,IACL;AAAA,GACF;AAEA,EAAAD,YAAA,CACG,KAAA,EAAM,CACN,KAAA,CAAM,CAAA,GAAA,KAAO;AACZ,IAAA,MAAA,CAAO,KAAA,CAAM,+BAA+B,GAAG,CAAA;AAC/C,IAAA,gBAAA,CAAiB,IAAA,EAAK;AACtB,IAAA,OAAA,CAAQ,KAAK,CAAC,CAAA;AAAA,EAChB,CAAC,CAAA,CACA,IAAA,CAAK,MAAM;AACV,IAAAE,4BAAA,CAAY,CAAA,iBAAA,EAAoB,IAAI,CAAA,8BAAA,CAAgC,CAAA;AACpE,IAAA,MAAA,CAAO,IAAA;AAAA,MACL,iDAAiD,IAAI,CAAA;AAAA,gBAAA;AAAA,KACvD;AAAA,EACF,CAAC,CAAA;AAEH,EAAA,MAAM,iBAAiB,WAAA,EAAY;AAEnC,EAAA,IAAI,iBAAA,EAAmB;AACrB,IAAA,OAAA,CAAQ,EAAA,CAAG,QAAQ,YAAY;AAC7B,MAAAC,mBAAA,CAAG,MAAA,CAAO,aAAA,EAAe,EAAE,CAAA;AAAA,IAC7B,CAAC,CAAA;AAAA,EACH;AACF;;"}