@techdocs/cli 1.0.1-next.0 → 1.1.1-next.0

package/CHANGELOG.md

@@ -1,5 +1,56 @@
 # @techdocs/cli
 
+## 1.1.1-next.0
+
+### Patch Changes
+
+- 344ea56acc: Bump `commander` to version 9.1.0
+- Updated dependencies
+  - @backstage/backend-common@0.13.3-next.0
+  - @backstage/plugin-techdocs-node@1.1.1-next.0
+
+## 1.1.0
+
+### Minor Changes
+
+- 733187987b: Removed an undocumented, broken behavior where `README.md` files would be copied to `index.md` if it did not exist, leading to broken links in the TechDocs UI.
+
+  **WARNING**: If you notice 404s in TechDocs after updating, check to make sure that all markdown files referenced in your `mkdocs.yml`s' `nav` sections exist. The following flag may be passed to the `generate` command to temporarily revert to the broken behavior.
+
+  ```sh
+  techdocs-cli generate --legacyCopyReadmeMdToIndexMd
+  ```
+
+### Patch Changes
+
+- 230ad0826f: Bump to using `@types/node` v16
+- eb470ea54c: Adds a new flag to override the entrypoint when using a custom docker image. It could be used to reuse existing images with different entrypoints.
+- Updated dependencies
+  - @backstage/catalog-model@1.0.1
+  - @backstage/backend-common@0.13.2
+  - @backstage/plugin-techdocs-node@1.1.0
+
+## 1.1.0-next.1
+
+### Minor Changes
+
+- bcf1a2496c: BREAKING: The default Techdocs behavior will no longer attempt to copy `docs/README.md` or `README.md` to `docs/index.md` (if not found). To retain this behavior in your instance, you can set the following config in your `app-config.yaml`:
+
+  ```yaml
+  techdocs:
+    generator:
+      mkdocs:
+        legacyCopyReadmeMdToIndexMd: true
+  ```
+
+### Patch Changes
+
+- 230ad0826f: Bump to using `@types/node` v16
+- eb470ea54c: Adds a new flag to override the entrypoint when using a custom docker image. It could be used to reuse existing images with different entrypoints.
+- Updated dependencies
+  - @backstage/backend-common@0.13.2-next.2
+  - @backstage/plugin-techdocs-node@1.1.0-next.2
+
 ## 1.0.1-next.0
 
 ### Patch Changes

package/dist/cjs/{PublisherConfig-162efac5.cjs.js → PublisherConfig-7a0dc71c.cjs.js}

@@ -3,10 +3,10 @@
 var config = require('@backstage/config');
 
 const _PublisherConfig = class {
-  static getValidConfig(cmd) {
-    const publisherType = cmd.publisherType;
+  static getValidConfig(opts) {
+    const publisherType = opts.publisherType;
     if (!_PublisherConfig.isKnownPublisher(publisherType)) {
-      throw new Error(`Unknown publisher type ${cmd.publisherType}`);
+      throw new Error(`Unknown publisher type ${opts.publisherType}`);
     }
     return new config.ConfigReader({
       backend: {
@@ -16,71 +16,75 @@ const _PublisherConfig = class {
         }
       },
       techdocs: {
-        publisher: _PublisherConfig.configFactories[publisherType](cmd),
-        legacyUseCaseSensitiveTripletPaths: cmd.legacyUseCaseSensitiveTripletPaths
+        publisher: _PublisherConfig.configFactories[publisherType](opts),
+        legacyUseCaseSensitiveTripletPaths: opts.legacyUseCaseSensitiveTripletPaths
       }
     });
   }
   static isKnownPublisher(type) {
     return _PublisherConfig.configFactories.hasOwnProperty(type);
   }
-  static getValidAwsS3Config(cmd) {
+  static getValidAwsS3Config(opts) {
     return {
       type: "awsS3",
       awsS3: {
-        bucketName: cmd.storageName,
-        ...cmd.awsBucketRootPath && { bucketRootPath: cmd.awsBucketRootPath },
-        ...cmd.awsRoleArn && { credentials: { roleArn: cmd.awsRoleArn } },
-        ...cmd.awsEndpoint && { endpoint: cmd.awsEndpoint },
-        ...cmd.awsS3ForcePathStyle && { s3ForcePathStyle: true },
-        ...cmd.awsS3sse && { sse: cmd.awsS3sse }
+        bucketName: opts.storageName,
+        ...opts.awsBucketRootPath && {
+          bucketRootPath: opts.awsBucketRootPath
+        },
+        ...opts.awsRoleArn && { credentials: { roleArn: opts.awsRoleArn } },
+        ...opts.awsEndpoint && { endpoint: opts.awsEndpoint },
+        ...opts.awsS3ForcePathStyle && { s3ForcePathStyle: true },
+        ...opts.awsS3sse && { sse: opts.awsS3sse }
       }
     };
   }
-  static getValidAzureConfig(cmd) {
-    if (!cmd.azureAccountName) {
+  static getValidAzureConfig(opts) {
+    if (!opts.azureAccountName) {
       throw new Error(`azureBlobStorage requires --azureAccountName to be specified`);
     }
     return {
       type: "azureBlobStorage",
       azureBlobStorage: {
-        containerName: cmd.storageName,
+        containerName: opts.storageName,
         credentials: {
-          accountName: cmd.azureAccountName,
-          accountKey: cmd.azureAccountKey
+          accountName: opts.azureAccountName,
+          accountKey: opts.azureAccountKey
         }
       }
     };
   }
-  static getValidGoogleGcsConfig(cmd) {
+  static getValidGoogleGcsConfig(opts) {
     return {
       type: "googleGcs",
       googleGcs: {
-        bucketName: cmd.storageName,
-        ...cmd.gcsBucketRootPath && { bucketRootPath: cmd.gcsBucketRootPath }
+        bucketName: opts.storageName,
+        ...opts.gcsBucketRootPath && {
+          bucketRootPath: opts.gcsBucketRootPath
+        }
       }
     };
   }
-  static getValidOpenStackSwiftConfig(cmd) {
+  static getValidOpenStackSwiftConfig(opts) {
     const missingParams = [
       "osCredentialId",
       "osSecret",
       "osAuthUrl",
       "osSwiftUrl"
-    ].filter((param) => !cmd[param]);
+    ].filter((param) => !opts[param]);
     if (missingParams.length) {
       throw new Error(`openStackSwift requires the following params to be specified: ${missingParams.join(", ")}`);
     }
     return {
       type: "openStackSwift",
       openStackSwift: {
-        containerName: cmd.storageName,
+        containerName: opts.storageName,
         credentials: {
-          id: cmd.osCredentialId,
-          secret: cmd.osSecret
+          id: opts.osCredentialId,
+          secret: opts.osSecret
         },
-        authUrl: cmd.osAuthUrl,
-        swiftUrl: cmd.osSwiftUrl
+        authUrl: opts.osAuthUrl,
+        swiftUrl: opts.osSwiftUrl
       }
     };
   }
@@ -94,4 +98,4 @@ PublisherConfig.configFactories = {
 };
 
 exports.PublisherConfig = PublisherConfig;
-//# sourceMappingURL=PublisherConfig-162efac5.cjs.js.map
+//# sourceMappingURL=PublisherConfig-7a0dc71c.cjs.js.map

package/dist/cjs/PublisherConfig-7a0dc71c.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PublisherConfig-7a0dc71c.cjs.js","sources":["../../src/lib/PublisherConfig.ts"],"sourcesContent":["/*\n * Copyright 2021 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 { ConfigReader } from '@backstage/config';\nimport { OptionValues } from 'commander';\n\ntype Publisher = keyof typeof PublisherConfig['configFactories'];\ntype PublisherConfiguration = {\n  [p in Publisher]?: any;\n} & {\n  type: Publisher;\n};\n\n/**\n * Helper when working with publisher-related configurations.\n */\nexport class PublisherConfig {\n  /**\n   * Maps publisher-specific config keys to config getters.\n   */\n  private static configFactories = {\n    awsS3: PublisherConfig.getValidAwsS3Config,\n    azureBlobStorage: PublisherConfig.getValidAzureConfig,\n    googleGcs: PublisherConfig.getValidGoogleGcsConfig,\n    openStackSwift: PublisherConfig.getValidOpenStackSwiftConfig,\n  };\n\n  /**\n   * Returns Backstage config suitable for use when instantiating a Publisher. If\n   * there are any missing or invalid options provided, an error is thrown.\n   *\n   * Note: This assumes that proper credentials are set in Environment\n   * variables for the respective GCS/AWS clients to work.\n   */\n  static getValidConfig(opts: OptionValues): ConfigReader {\n    const publisherType = opts.publisherType;\n\n    if (!PublisherConfig.isKnownPublisher(publisherType)) {\n      throw new Error(`Unknown publisher type ${opts.publisherType}`);\n    }\n\n    return new ConfigReader({\n      // This backend config is not used at all. Just something needed a create a mock discovery instance.\n      backend: {\n        baseUrl: 'http://localhost:7007',\n        listen: {\n          port: 7007,\n        },\n      },\n      techdocs: {\n        publisher: PublisherConfig.configFactories[publisherType](opts),\n        legacyUseCaseSensitiveTripletPaths:\n          opts.legacyUseCaseSensitiveTripletPaths,\n      },\n    });\n  }\n\n  /**\n   * Typeguard to ensure the publisher has a known config getter.\n   */\n  private static isKnownPublisher(\n    type: string,\n  ): type is keyof typeof PublisherConfig['configFactories'] {\n    return PublisherConfig.configFactories.hasOwnProperty(type);\n  }\n\n  /**\n   * Retrieve valid AWS S3 configuration based on the command.\n   */\n  private static getValidAwsS3Config(\n    opts: OptionValues,\n  ): PublisherConfiguration {\n    return {\n      type: 'awsS3',\n      awsS3: {\n        bucketName: opts.storageName,\n        ...(opts.awsBucketRootPath && {\n          bucketRootPath: opts.awsBucketRootPath,\n        }),\n        ...(opts.awsRoleArn && { credentials: { roleArn: opts.awsRoleArn } }),\n        ...(opts.awsEndpoint && { endpoint: opts.awsEndpoint }),\n        ...(opts.awsS3ForcePathStyle && { s3ForcePathStyle: true }),\n        ...(opts.awsS3sse && { sse: opts.awsS3sse }),\n      },\n    };\n  }\n\n  /**\n   * Retrieve valid Azure Blob Storage configuration based on the command.\n   */\n  private static getValidAzureConfig(\n    opts: OptionValues,\n  ): PublisherConfiguration {\n    if (!opts.azureAccountName) {\n      throw new Error(\n        `azureBlobStorage requires --azureAccountName to be specified`,\n      );\n    }\n\n    return {\n      type: 'azureBlobStorage',\n      azureBlobStorage: {\n        containerName: opts.storageName,\n        credentials: {\n          accountName: opts.azureAccountName,\n          accountKey: opts.azureAccountKey,\n        },\n      },\n    };\n  }\n\n  /**\n   * Retrieve valid GCS configuration based on the command.\n   */\n  private static getValidGoogleGcsConfig(\n    opts: OptionValues,\n  ): PublisherConfiguration {\n    return {\n      type: 'googleGcs',\n      googleGcs: {\n        bucketName: opts.storageName,\n        ...(opts.gcsBucketRootPath && {\n          bucketRootPath: opts.gcsBucketRootPath,\n        }),\n      },\n    };\n  }\n\n  /**\n   * Retrieves valid OpenStack Swift configuration based on the command.\n   */\n  private static getValidOpenStackSwiftConfig(\n    opts: OptionValues,\n  ): PublisherConfiguration {\n    const missingParams = [\n      'osCredentialId',\n      'osSecret',\n      'osAuthUrl',\n      'osSwiftUrl',\n    ].filter((param: string) => !opts[param]);\n\n    if (missingParams.length) {\n      throw new Error(\n        `openStackSwift requires the following params to be specified: ${missingParams.join(\n          ', ',\n        )}`,\n      );\n    }\n\n    return {\n      type: 'openStackSwift',\n      openStackSwift: {\n        containerName: opts.storageName,\n        credentials: {\n          id: opts.osCredentialId,\n          secret: opts.osSecret,\n        },\n        authUrl: opts.osAuthUrl,\n        swiftUrl: opts.osSwiftUrl,\n      },\n    };\n  }\n}\n"],"names":["ConfigReader"],"mappings":";;;;AACA,MAAM,gBAAgB,GAAG,MAAM;AAC/B,EAAE,OAAO,cAAc,CAAC,IAAI,EAAE;AAC9B,IAAI,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;AAC7C,IAAI,IAAI,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,aAAa,CAAC,EAAE;AAC3D,MAAM,MAAM,IAAI,KAAK,CAAC,CAAC,uBAAuB,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;AACtE,KAAK;AACL,IAAI,OAAO,IAAIA,mBAAY,CAAC;AAC5B,MAAM,OAAO,EAAE;AACf,QAAQ,OAAO,EAAE,uBAAuB;AACxC,QAAQ,MAAM,EAAE;AAChB,UAAU,IAAI,EAAE,IAAI;AACpB,SAAS;AACT,OAAO;AACP,MAAM,QAAQ,EAAE;AAChB,QAAQ,SAAS,EAAE,gBAAgB,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC;AACxE,QAAQ,kCAAkC,EAAE,IAAI,CAAC,kCAAkC;AACnF,OAAO;AACP,KAAK,CAAC,CAAC;AACP,GAAG;AACH,EAAE,OAAO,gBAAgB,CAAC,IAAI,EAAE;AAChC,IAAI,OAAO,gBAAgB,CAAC,eAAe,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;AACjE,GAAG;AACH,EAAE,OAAO,mBAAmB,CAAC,IAAI,EAAE;AACnC,IAAI,OAAO;AACX,MAAM,IAAI,EAAE,OAAO;AACnB,MAAM,KAAK,EAAE;AACb,QAAQ,UAAU,EAAE,IAAI,CAAC,WAAW;AACpC,QAAQ,GAAG,IAAI,CAAC,iBAAiB,IAAI;AACrC,UAAU,cAAc,EAAE,IAAI,CAAC,iBAAiB;AAChD,SAAS;AACT,QAAQ,GAAG,IAAI,CAAC,UAAU,IAAI,EAAE,WAAW,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,EAAE;AAC3E,QAAQ,GAAG,IAAI,CAAC,WAAW,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,WAAW,EAAE;AAC7D,QAAQ,GAAG,IAAI,CAAC,mBAAmB,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE;AACjE,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE;AAClD,OAAO;AACP,KAAK,CAAC;AACN,GAAG;AACH,EAAE,OAAO,mBAAmB,CAAC,IAAI,EAAE;AACnC,IAAI,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE;AAChC,MAAM,MAAM,IAAI,KAAK,CAAC,CAAC,4DAA4D,CAAC,CAAC,CAAC;AACtF,KAAK;AACL,IAAI,OAAO;AACX,MAAM,IAAI,EAAE,kBAAkB;AAC9B,MAAM,gBAAgB,EAAE;AACxB,QAAQ,aAAa,EAAE,IAAI,CAAC,WAAW;AACvC,QAAQ,WAAW,EAAE;AACrB,UAAU,WAAW,EAAE,IAAI,CAAC,gBAAgB;AAC5C,UAAU,UAAU,EAAE,IAAI,CAAC,eAAe;AAC1C,SAAS;AACT,OAAO;AACP,KAAK,CAAC;AACN,GAAG;AACH,EAAE,OAAO,uBAAuB,CAAC,IAAI,EAAE;AACvC,IAAI,OAAO;AACX,MAAM,IAAI,EAAE,WAAW;AACvB,MAAM,SAAS,EAAE;AACjB,QAAQ,UAAU,EAAE,IAAI,CAAC,WAAW;AACpC,QAAQ,GAAG,IAAI,CAAC,iBAAiB,IAAI;AACrC,UAAU,cAAc,EAAE,IAAI,CAAC,iBAAiB;AAChD,SAAS;AACT,OAAO;AACP,KAAK,CAAC;AACN,GAAG;AACH,EAAE,OAAO,4BAA4B,CAAC,IAAI,EAAE;AAC5C,IAAI,MAAM,aAAa,GAAG;AAC1B,MAAM,gBAAgB;AACtB,MAAM,UAAU;AAChB,MAAM,WAAW;AACjB,MAAM,YAAY;AAClB,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;AACtC,IAAI,IAAI,aAAa,CAAC,MAAM,EAAE;AAC9B,MAAM,MAAM,IAAI,KAAK,CAAC,CAAC,8DAA8D,EAAE,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AACnH,KAAK;AACL,IAAI,OAAO;AACX,MAAM,IAAI,EAAE,gBAAgB;AAC5B,MAAM,cAAc,EAAE;AACtB,QAAQ,aAAa,EAAE,IAAI,CAAC,WAAW;AACvC,QAAQ,WAAW,EAAE;AACrB,UAAU,EAAE,EAAE,IAAI,CAAC,cAAc;AACjC,UAAU,MAAM,EAAE,IAAI,CAAC,QAAQ;AAC/B,SAAS;AACT,QAAQ,OAAO,EAAE,IAAI,CAAC,SAAS;AAC/B,QAAQ,QAAQ,EAAE,IAAI,CAAC,UAAU;AACjC,OAAO;AACP,KAAK,CAAC;AACN,GAAG;AACH,CAAC,CAAC;AACQ,IAAC,eAAe,GAAG,iBAAiB;AAC9C,eAAe,CAAC,eAAe,GAAG;AAClC,EAAE,KAAK,EAAE,gBAAgB,CAAC,mBAAmB;AAC7C,EAAE,gBAAgB,EAAE,gBAAgB,CAAC,mBAAmB;AACxD,EAAE,SAAS,EAAE,gBAAgB,CAAC,uBAAuB;AACrD,EAAE,cAAc,EAAE,gBAAgB,CAAC,4BAA4B;AAC/D,CAAC;;;;"}

package/dist/cjs/{generate-143a6de3.cjs.js → generate-b637bb78.cjs.js}

@@ -15,13 +15,14 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
 var Docker__default = /*#__PURE__*/_interopDefaultLegacy(Docker);
 
-async function generate(cmd) {
-  const logger = utility.createLogger({ verbose: cmd.verbose });
-  const sourceDir = path.resolve(cmd.sourceDir);
-  const outputDir = path.resolve(cmd.outputDir);
-  const omitTechdocsCorePlugin = cmd.omitTechdocsCoreMkdocsPlugin;
-  const dockerImage = cmd.dockerImage;
-  const pullImage = cmd.pull;
+async function generate(opts) {
+  const logger = utility.createLogger({ verbose: opts.verbose });
+  const sourceDir = path.resolve(opts.sourceDir);
+  const outputDir = path.resolve(opts.outputDir);
+  const omitTechdocsCorePlugin = opts.omitTechdocsCoreMkdocsPlugin;
+  const dockerImage = opts.dockerImage;
+  const pullImage = opts.pull;
+  const legacyCopyReadmeMdToIndexMd = opts.legacyCopyReadmeMdToIndexMd;
   logger.info(`Using source dir ${sourceDir}`);
   logger.info(`Will output generated files in ${outputDir}`);
   logger.verbose("Creating output directory if it does not exist.");
@@ -29,9 +30,10 @@ async function generate(cmd) {
   const config$1 = new config.ConfigReader({
     techdocs: {
       generator: {
-        runIn: cmd.docker ? "docker" : "local",
+        runIn: opts.docker ? "docker" : "local",
         dockerImage,
         pullImage,
+        legacyCopyReadmeMdToIndexMd,
         mkdocs: {
           omitTechdocsCorePlugin
         }
@@ -41,9 +43,9 @@ async function generate(cmd) {
   const dockerClient = new Docker__default["default"]();
   const containerRunner = new backendCommon.DockerContainerRunner({ dockerClient });
   let parsedLocationAnnotation = {};
-  if (cmd.techdocsRef) {
+  if (opts.techdocsRef) {
     try {
-      parsedLocationAnnotation = utility.convertTechDocsRefToLocationAnnotation(cmd.techdocsRef);
+      parsedLocationAnnotation = utility.convertTechDocsRefToLocationAnnotation(opts.techdocsRef);
     } catch (err) {
       logger.error(err.message);
     }
@@ -56,15 +58,15 @@ async function generate(cmd) {
   await techdocsGenerator.run({
     inputDir: sourceDir,
     outputDir,
-    ...cmd.techdocsRef ? {
+    ...opts.techdocsRef ? {
       parsedLocationAnnotation
     } : {},
     logger,
-    etag: cmd.etag,
+    etag: opts.etag,
     ...process.env.LOG_LEVEL === "debug" ? { logStream: process$1.stdout } : {}
   });
   logger.info("Done!");
 }
 
 exports["default"] = generate;
-//# sourceMappingURL=generate-143a6de3.cjs.js.map
+//# sourceMappingURL=generate-b637bb78.cjs.js.map

package/dist/cjs/generate-b637bb78.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-b637bb78.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 { resolve } from 'path';\nimport { OptionValues } from 'commander';\nimport fs from 'fs-extra';\nimport Docker from 'dockerode';\nimport {\n  TechdocsGenerator,\n  ParsedLocationAnnotation,\n} from '@backstage/plugin-techdocs-node';\nimport { DockerContainerRunner } from '@backstage/backend-common';\nimport { ConfigReader } from '@backstage/config';\nimport {\n  convertTechDocsRefToLocationAnnotation,\n  createLogger,\n} from '../../lib/utility';\nimport { stdout } from 'process';\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\n  const sourceDir = resolve(opts.sourceDir);\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\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 config = new ConfigReader({\n    techdocs: {\n      generator: {\n        runIn: opts.docker ? 'docker' : 'local',\n        dockerImage,\n        pullImage,\n        legacyCopyReadmeMdToIndexMd,\n        mkdocs: {\n          omitTechdocsCorePlugin,\n        },\n      },\n    },\n  });\n\n  // Docker client (conditionally) used by the generators, based on techdocs.generators config.\n  const dockerClient = new Docker();\n  const containerRunner = new DockerContainerRunner({ dockerClient });\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  // Generate docs using @backstage/plugin-techdocs-node\n  const techdocsGenerator = await TechdocsGenerator.fromConfig(config, {\n    logger,\n    containerRunner,\n  });\n\n  logger.info('Generating documentation...');\n\n  await techdocsGenerator.run({\n    inputDir: sourceDir,\n    outputDir,\n    ...(opts.techdocsRef\n      ? {\n          parsedLocationAnnotation,\n        }\n      : {}),\n    logger,\n    etag: opts.etag,\n    ...(process.env.LOG_LEVEL === 'debug' ? { logStream: stdout } : {}),\n  });\n\n  logger.info('Done!');\n}\n"],"names":["createLogger","resolve","fs","config","ConfigReader","Docker","DockerContainerRunner","convertTechDocsRefToLocationAnnotation","TechdocsGenerator","stdout"],"mappings":";;;;;;;;;;;;;;;;;AAae,eAAe,QAAQ,CAAC,IAAI,EAAE;AAC7C,EAAE,MAAM,MAAM,GAAGA,oBAAY,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;AACzD,EAAE,MAAM,SAAS,GAAGC,YAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AAC5C,EAAE,MAAM,SAAS,GAAGA,YAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AAC5C,EAAE,MAAM,sBAAsB,GAAG,IAAI,CAAC,4BAA4B,CAAC;AACnE,EAAE,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;AACvC,EAAE,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC;AAC9B,EAAE,MAAM,2BAA2B,GAAG,IAAI,CAAC,2BAA2B,CAAC;AACvE,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;AAC/C,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,+BAA+B,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;AAC7D,EAAE,MAAM,CAAC,OAAO,CAAC,iDAAiD,CAAC,CAAC;AACpE,EAAE,MAAMC,sBAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;AAChC,EAAE,MAAMC,QAAM,GAAG,IAAIC,mBAAY,CAAC;AAClC,IAAI,QAAQ,EAAE;AACd,MAAM,SAAS,EAAE;AACjB,QAAQ,KAAK,EAAE,IAAI,CAAC,MAAM,GAAG,QAAQ,GAAG,OAAO;AAC/C,QAAQ,WAAW;AACnB,QAAQ,SAAS;AACjB,QAAQ,2BAA2B;AACnC,QAAQ,MAAM,EAAE;AAChB,UAAU,sBAAsB;AAChC,SAAS;AACT,OAAO;AACP,KAAK;AACL,GAAG,CAAC,CAAC;AACL,EAAE,MAAM,YAAY,GAAG,IAAIC,0BAAM,EAAE,CAAC;AACpC,EAAE,MAAM,eAAe,GAAG,IAAIC,mCAAqB,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;AACtE,EAAE,IAAI,wBAAwB,GAAG,EAAE,CAAC;AACpC,EAAE,IAAI,IAAI,CAAC,WAAW,EAAE;AACxB,IAAI,IAAI;AACR,MAAM,wBAAwB,GAAGC,8CAAsC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC1F,KAAK,CAAC,OAAO,GAAG,EAAE;AAClB,MAAM,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AAChC,KAAK;AACL,GAAG;AACH,EAAE,MAAM,iBAAiB,GAAG,MAAMC,oCAAiB,CAAC,UAAU,CAACL,QAAM,EAAE;AACvE,IAAI,MAAM;AACV,IAAI,eAAe;AACnB,GAAG,CAAC,CAAC;AACL,EAAE,MAAM,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;AAC7C,EAAE,MAAM,iBAAiB,CAAC,GAAG,CAAC;AAC9B,IAAI,QAAQ,EAAE,SAAS;AACvB,IAAI,SAAS;AACb,IAAI,GAAG,IAAI,CAAC,WAAW,GAAG;AAC1B,MAAM,wBAAwB;AAC9B,KAAK,GAAG,EAAE;AACV,IAAI,MAAM;AACV,IAAI,IAAI,EAAE,IAAI,CAAC,IAAI;AACnB,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,KAAK,OAAO,GAAG,EAAE,SAAS,EAAEM,gBAAM,EAAE,GAAG,EAAE;AACrE,GAAG,CAAC,CAAC;AACL,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AACvB;;;;"}

package/dist/cjs/{migrate-181e95f5.cjs.js → migrate-122ec4bf.cjs.js}

@@ -3,26 +3,26 @@
 var backendCommon = require('@backstage/backend-common');
 var pluginTechdocsNode = require('@backstage/plugin-techdocs-node');
 var utility = require('./utility-51f4a306.cjs.js');
-var PublisherConfig = require('./PublisherConfig-162efac5.cjs.js');
+var PublisherConfig = require('./PublisherConfig-7a0dc71c.cjs.js');
 require('winston');
 require('@backstage/config');
 
-async function migrate(cmd) {
-  const logger = utility.createLogger({ verbose: cmd.verbose });
-  const config = PublisherConfig.PublisherConfig.getValidConfig(cmd);
+async function migrate(opts) {
+  const logger = utility.createLogger({ verbose: opts.verbose });
+  const config = PublisherConfig.PublisherConfig.getValidConfig(opts);
   const discovery = backendCommon.SingleHostDiscovery.fromConfig(config);
   const publisher = await pluginTechdocsNode.Publisher.fromConfig(config, { logger, discovery });
   if (!publisher.migrateDocsCase) {
-    throw new Error(`Migration not implemented for ${cmd.publisherType}`);
+    throw new Error(`Migration not implemented for ${opts.publisherType}`);
   }
   const { isAvailable } = await publisher.getReadiness();
   if (!isAvailable) {
     throw new Error("");
   }
-  const removeOriginal = cmd.removeOriginal;
-  const numericConcurrency = parseInt(cmd.concurrency, 10);
+  const removeOriginal = opts.removeOriginal;
+  const numericConcurrency = parseInt(opts.concurrency, 10);
   if (!Number.isInteger(numericConcurrency) || numericConcurrency <= 0) {
-    throw new Error(`Concurrency must be a number greater than 1. ${cmd.concurrency} provided.`);
+    throw new Error(`Concurrency must be a number greater than 1. ${opts.concurrency} provided.`);
   }
   await publisher.migrateDocsCase({
     concurrency: numericConcurrency,
@@ -31,4 +31,4 @@ async function migrate(cmd) {
 }
 
 exports["default"] = migrate;
-//# sourceMappingURL=migrate-181e95f5.cjs.js.map
+//# sourceMappingURL=migrate-122ec4bf.cjs.js.map

package/dist/cjs/migrate-122ec4bf.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrate-122ec4bf.cjs.js","sources":["../../src/commands/migrate/migrate.ts"],"sourcesContent":["/*\n * Copyright 2021 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 { SingleHostDiscovery } from '@backstage/backend-common';\nimport { Publisher } from '@backstage/plugin-techdocs-node';\nimport { OptionValues } from 'commander';\nimport { createLogger } from '../../lib/utility';\nimport { PublisherConfig } from '../../lib/PublisherConfig';\n\nexport default async function migrate(opts: OptionValues) {\n  const logger = createLogger({ verbose: opts.verbose });\n\n  const config = PublisherConfig.getValidConfig(opts);\n  const discovery = SingleHostDiscovery.fromConfig(config);\n  const publisher = await Publisher.fromConfig(config, { logger, discovery });\n\n  if (!publisher.migrateDocsCase) {\n    throw new Error(`Migration not implemented for ${opts.publisherType}`);\n  }\n\n  // Check that the publisher's underlying storage is ready and available.\n  const { isAvailable } = await publisher.getReadiness();\n  if (!isAvailable) {\n    // Error messages printed in getReadiness() call. This ensures exit code 1.\n    throw new Error('');\n  }\n\n  // Validate and parse migration arguments.\n  const removeOriginal = opts.removeOriginal;\n  const numericConcurrency = parseInt(opts.concurrency, 10);\n\n  if (!Number.isInteger(numericConcurrency) || numericConcurrency <= 0) {\n    throw new Error(\n      `Concurrency must be a number greater than 1. ${opts.concurrency} provided.`,\n    );\n  }\n\n  await publisher.migrateDocsCase({\n    concurrency: numericConcurrency,\n    removeOriginal,\n  });\n}\n"],"names":["createLogger","PublisherConfig","SingleHostDiscovery","Publisher"],"mappings":";;;;;;;;;AAIe,eAAe,OAAO,CAAC,IAAI,EAAE;AAC5C,EAAE,MAAM,MAAM,GAAGA,oBAAY,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;AACzD,EAAE,MAAM,MAAM,GAAGC,+BAAe,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;AACtD,EAAE,MAAM,SAAS,GAAGC,iCAAmB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;AAC3D,EAAE,MAAM,SAAS,GAAG,MAAMC,4BAAS,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;AAC9E,EAAE,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE;AAClC,IAAI,MAAM,IAAI,KAAK,CAAC,CAAC,8BAA8B,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;AAC3E,GAAG;AACH,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,SAAS,CAAC,YAAY,EAAE,CAAC;AACzD,EAAE,IAAI,CAAC,WAAW,EAAE;AACpB,IAAI,MAAM,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC;AACxB,GAAG;AACH,EAAE,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;AAC7C,EAAE,MAAM,kBAAkB,GAAG,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;AAC5D,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,kBAAkB,IAAI,CAAC,EAAE;AACxE,IAAI,MAAM,IAAI,KAAK,CAAC,CAAC,6CAA6C,EAAE,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC;AAClG,GAAG;AACH,EAAE,MAAM,SAAS,CAAC,eAAe,CAAC;AAClC,IAAI,WAAW,EAAE,kBAAkB;AACnC,IAAI,cAAc;AAClB,GAAG,CAAC,CAAC;AACL;;;;"}

package/dist/cjs/{mkdocs-30f530ff.cjs.js → mkdocs-3c3898e8.cjs.js}

@@ -2,7 +2,7 @@
 
 var openBrowser = require('react-dev-utils/openBrowser');
 var utility = require('./utility-51f4a306.cjs.js');
-var mkdocsServer = require('./mkdocsServer-758a3ae9.cjs.js');
+var mkdocsServer = require('./mkdocsServer-0af6527d.cjs.js');
 require('winston');
 require('child_process');
 
@@ -10,15 +10,15 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 
 var openBrowser__default = /*#__PURE__*/_interopDefaultLegacy(openBrowser);
 
-async function serveMkdocs(cmd) {
-  const logger = utility.createLogger({ verbose: cmd.verbose });
-  const dockerAddr = `http://0.0.0.0:${cmd.port}`;
-  const localAddr = `http://127.0.0.1:${cmd.port}`;
-  const expectedDevAddr = cmd.docker ? dockerAddr : localAddr;
+async function serveMkdocs(opts) {
+  const logger = utility.createLogger({ verbose: opts.verbose });
+  const dockerAddr = `http://0.0.0.0:${opts.port}`;
+  const localAddr = `http://127.0.0.1:${opts.port}`;
+  const expectedDevAddr = opts.docker ? dockerAddr : localAddr;
   let boolOpenBrowserTriggered = false;
   const logFunc = (data) => {
     const logLines = data.toString().split("\n");
-    const logPrefix = cmd.docker ? "[docker/mkdocs]" : "[mkdocs]";
+    const logPrefix = opts.docker ? "[docker/mkdocs]" : "[mkdocs]";
     logLines.forEach((line) => {
       if (line === "") {
         return;
@@ -34,9 +34,10 @@ Starting mkdocs server on ${localAddr}
     });
   };
   const childProcess = await mkdocsServer.runMkdocsServer({
-    port: cmd.port,
-    dockerImage: cmd.dockerImage,
-    useDocker: cmd.docker,
+    port: opts.port,
+    dockerImage: opts.dockerImage,
+    dockerEntrypoint: opts.dockerEntrypoint,
+    useDocker: opts.docker,
     stdoutLogFunc: logFunc,
     stderrLogFunc: logFunc
   });
@@ -44,4 +45,4 @@ Starting mkdocs server on ${localAddr}
 }
 
 exports["default"] = serveMkdocs;
-//# sourceMappingURL=mkdocs-30f530ff.cjs.js.map
+//# sourceMappingURL=mkdocs-3c3898e8.cjs.js.map

package/dist/cjs/mkdocs-3c3898e8.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mkdocs-3c3898e8.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 { runMkdocsServer } from '../../lib/mkdocsServer';\nimport { LogFunc, waitForSignal } from '../../lib/run';\n\nexport default async function serveMkdocs(opts: OptionValues) {\n  const logger = createLogger({ verbose: opts.verbose });\n\n  const dockerAddr = `http://0.0.0.0:${opts.port}`;\n  const localAddr = `http://127.0.0.1:${opts.port}`;\n  const expectedDevAddr = opts.docker ? dockerAddr : localAddr;\n  // We want to open browser only once based on a log.\n  let boolOpenBrowserTriggered = false;\n\n  const logFunc: LogFunc = 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/mkdocs]' : '[mkdocs]';\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(`Serving on ${expectedDevAddr}`)\n      ) {\n        // Always open the local address, since 0.0.0.0 belongs to docker\n        logger.info(`\\nStarting mkdocs server on ${localAddr}\\n`);\n        openBrowser(localAddr);\n        boolOpenBrowserTriggered = true;\n      }\n    });\n  };\n  // mkdocs writes all of its logs to stderr by default, and not stdout.\n  // https://github.com/mkdocs/mkdocs/issues/879#issuecomment-203536006\n  // Had me questioning this whole implementation for half an hour.\n\n  // Commander stores --no-docker in cmd.docker variable\n  const childProcess = await runMkdocsServer({\n    port: opts.port,\n    dockerImage: opts.dockerImage,\n    dockerEntrypoint: opts.dockerEntrypoint,\n    useDocker: opts.docker,\n    stdoutLogFunc: logFunc,\n    stderrLogFunc: logFunc,\n  });\n\n  // Keep waiting for user to cancel the process\n  await waitForSignal([childProcess]);\n}\n"],"names":["createLogger","openBrowser","runMkdocsServer","waitForSignal"],"mappings":";;;;;;;;;;;;AAIe,eAAe,WAAW,CAAC,IAAI,EAAE;AAChD,EAAE,MAAM,MAAM,GAAGA,oBAAY,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;AACzD,EAAE,MAAM,UAAU,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AACnD,EAAE,MAAM,SAAS,GAAG,CAAC,iBAAiB,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AACpD,EAAE,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;AAC/D,EAAE,IAAI,wBAAwB,GAAG,KAAK,CAAC;AACvC,EAAE,MAAM,OAAO,GAAG,CAAC,IAAI,KAAK;AAC5B,IAAI,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACjD,IAAI,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,GAAG,iBAAiB,GAAG,UAAU,CAAC;AACnE,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,KAAK;AAC/B,MAAM,IAAI,IAAI,KAAK,EAAE,EAAE;AACvB,QAAQ,OAAO;AACf,OAAO;AACP,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AAC7C,MAAM,IAAI,CAAC,wBAAwB,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE;AACvF,QAAQ,MAAM,CAAC,IAAI,CAAC,CAAC;AACrB,0BAA0B,EAAE,SAAS,CAAC;AACtC,CAAC,CAAC,CAAC;AACH,QAAQC,+BAAW,CAAC,SAAS,CAAC,CAAC;AAC/B,QAAQ,wBAAwB,GAAG,IAAI,CAAC;AACxC,OAAO;AACP,KAAK,CAAC,CAAC;AACP,GAAG,CAAC;AACJ,EAAE,MAAM,YAAY,GAAG,MAAMC,4BAAe,CAAC;AAC7C,IAAI,IAAI,EAAE,IAAI,CAAC,IAAI;AACnB,IAAI,WAAW,EAAE,IAAI,CAAC,WAAW;AACjC,IAAI,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;AAC3C,IAAI,SAAS,EAAE,IAAI,CAAC,MAAM;AAC1B,IAAI,aAAa,EAAE,OAAO;AAC1B,IAAI,aAAa,EAAE,OAAO;AAC1B,GAAG,CAAC,CAAC;AACL,EAAE,MAAMC,0BAAa,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC;AACtC;;;;"}

package/dist/cjs/{mkdocsServer-758a3ae9.cjs.js → mkdocsServer-0af6527d.cjs.js}

@@ -68,6 +68,7 @@ const runMkdocsServer = async (options) => {
       "-p",
       `${port}:${port}`,
       "-it",
+      ...options.dockerEntrypoint ? ["--entrypoint", options.dockerEntrypoint] : [],
       dockerImage,
       "serve",
       "--dev-addr",
@@ -85,4 +86,4 @@ const runMkdocsServer = async (options) => {
 
 exports.runMkdocsServer = runMkdocsServer;
 exports.waitForSignal = waitForSignal;
-//# sourceMappingURL=mkdocsServer-758a3ae9.cjs.js.map
+//# sourceMappingURL=mkdocsServer-0af6527d.cjs.js.map

package/dist/cjs/mkdocsServer-0af6527d.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mkdocsServer-0af6527d.cjs.js","sources":["../../src/lib/run.ts","../../src/lib/mkdocsServer.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 */\nimport { spawn, SpawnOptions, ChildProcess } from 'child_process';\n\nexport type LogFunc = (data: Buffer | string) => void;\ntype SpawnOptionsPartialEnv = Omit<SpawnOptions, 'env'> & {\n  env?: Partial<NodeJS.ProcessEnv>;\n  // Pipe stdout to this log function\n  stdoutLogFunc?: LogFunc;\n  // Pipe stderr to this log function\n  stderrLogFunc?: LogFunc;\n};\n\n// TODO: Accept log functions to pipe logs with.\n// Runs a child command, returning the child process instance.\n// Use it along with waitForSignal to run a long running process e.g. mkdocs serve\nexport const run = async (\n  name: string,\n  args: string[] = [],\n  options: SpawnOptionsPartialEnv = {},\n): Promise<ChildProcess> => {\n  const { stdoutLogFunc, stderrLogFunc } = options;\n\n  const env: NodeJS.ProcessEnv = {\n    ...process.env,\n    FORCE_COLOR: 'true',\n    ...(options.env ?? {}),\n  };\n\n  // Refer: https://nodejs.org/api/child_process.html#child_process_subprocess_stdio\n  const stdio = [\n    'inherit',\n    stdoutLogFunc ? 'pipe' : 'inherit',\n    stderrLogFunc ? 'pipe' : 'inherit',\n  ] as ('inherit' | 'pipe')[];\n\n  const childProcess = spawn(name, args, {\n    stdio: stdio,\n    ...options,\n    env,\n  });\n\n  if (stdoutLogFunc && childProcess.stdout) {\n    childProcess.stdout.on('data', stdoutLogFunc);\n  }\n  if (stderrLogFunc && childProcess.stderr) {\n    childProcess.stderr.on('data', stderrLogFunc);\n  }\n\n  return childProcess;\n};\n\n// Block indefinitely and wait for a signal to kill the child process(es)\n// Throw error if any child process errors\n// Resolves only when all processes exit with status code 0\nexport async function waitForSignal(\n  childProcesses: Array<ChildProcess>,\n): Promise<void> {\n  const promises: Array<Promise<void>> = [];\n\n  for (const signal of ['SIGINT', 'SIGTERM'] as const) {\n    process.on(signal, () => {\n      childProcesses.forEach(childProcess => {\n        childProcess.kill();\n      });\n    });\n  }\n\n  childProcesses.forEach(childProcess => {\n    if (typeof childProcess.exitCode === 'number') {\n      if (childProcess.exitCode) {\n        throw new Error(`Non zero exit code from child process`);\n      }\n      return;\n    }\n\n    promises.push(\n      new Promise<void>((resolve, reject) => {\n        childProcess.once('error', reject);\n        childProcess.once('exit', resolve);\n      }),\n    );\n  });\n\n  await Promise.all(promises);\n}\n","/*\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 { ChildProcess } from 'child_process';\nimport { run, LogFunc } from './run';\n\nexport const runMkdocsServer = async (options: {\n  port?: string;\n  useDocker?: boolean;\n  dockerImage?: string;\n  dockerEntrypoint?: string;\n  stdoutLogFunc?: LogFunc;\n  stderrLogFunc?: LogFunc;\n}): Promise<ChildProcess> => {\n  const port = options.port ?? '8000';\n  const useDocker = options.useDocker ?? true;\n  const dockerImage = options.dockerImage ?? 'spotify/techdocs';\n\n  if (useDocker) {\n    return await run(\n      'docker',\n      [\n        'run',\n        '--rm',\n        '-w',\n        '/content',\n        '-v',\n        `${process.cwd()}:/content`,\n        '-p',\n        `${port}:${port}`,\n        '-it',\n        ...(options.dockerEntrypoint\n          ? ['--entrypoint', options.dockerEntrypoint]\n          : []),\n        dockerImage,\n        'serve',\n        '--dev-addr',\n        `0.0.0.0:${port}`,\n      ],\n      {\n        stdoutLogFunc: options.stdoutLogFunc,\n        stderrLogFunc: options.stderrLogFunc,\n      },\n    );\n  }\n\n  return await run('mkdocs', ['serve', '--dev-addr', `127.0.0.1:${port}`], {\n    stdoutLogFunc: options.stdoutLogFunc,\n    stderrLogFunc: options.stderrLogFunc,\n  });\n};\n"],"names":["spawn"],"mappings":";;;;AACO,MAAM,GAAG,GAAG,OAAO,IAAI,EAAE,IAAI,GAAG,EAAE,EAAE,OAAO,GAAG,EAAE,KAAK;AAC5D,EAAE,IAAI,EAAE,CAAC;AACT,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;AACnD,EAAE,MAAM,GAAG,GAAG;AACd,IAAI,GAAG,OAAO,CAAC,GAAG;AAClB,IAAI,WAAW,EAAE,MAAM;AACvB,IAAI,GAAG,CAAC,EAAE,GAAG,OAAO,CAAC,GAAG,KAAK,IAAI,GAAG,EAAE,GAAG,EAAE;AAC3C,GAAG,CAAC;AACJ,EAAE,MAAM,KAAK,GAAG;AAChB,IAAI,SAAS;AACb,IAAI,aAAa,GAAG,MAAM,GAAG,SAAS;AACtC,IAAI,aAAa,GAAG,MAAM,GAAG,SAAS;AACtC,GAAG,CAAC;AACJ,EAAE,MAAM,YAAY,GAAGA,mBAAK,CAAC,IAAI,EAAE,IAAI,EAAE;AACzC,IAAI,KAAK;AACT,IAAI,GAAG,OAAO;AACd,IAAI,GAAG;AACP,GAAG,CAAC,CAAC;AACL,EAAE,IAAI,aAAa,IAAI,YAAY,CAAC,MAAM,EAAE;AAC5C,IAAI,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AAClD,GAAG;AACH,EAAE,IAAI,aAAa,IAAI,YAAY,CAAC,MAAM,EAAE;AAC5C,IAAI,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AAClD,GAAG;AACH,EAAE,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC;AACK,eAAe,aAAa,CAAC,cAAc,EAAE;AACpD,EAAE,MAAM,QAAQ,GAAG,EAAE,CAAC;AACtB,EAAE,KAAK,MAAM,MAAM,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,EAAE;AAC9C,IAAI,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM;AAC7B,MAAM,cAAc,CAAC,OAAO,CAAC,CAAC,YAAY,KAAK;AAC/C,QAAQ,YAAY,CAAC,IAAI,EAAE,CAAC;AAC5B,OAAO,CAAC,CAAC;AACT,KAAK,CAAC,CAAC;AACP,GAAG;AACH,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC,YAAY,KAAK;AAC3C,IAAI,IAAI,OAAO,YAAY,CAAC,QAAQ,KAAK,QAAQ,EAAE;AACnD,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE;AACjC,QAAQ,MAAM,IAAI,KAAK,CAAC,CAAC,qCAAqC,CAAC,CAAC,CAAC;AACjE,OAAO;AACP,MAAM,OAAO;AACb,KAAK;AACL,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,KAAK;AACnD,MAAM,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;AACzC,MAAM,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACzC,KAAK,CAAC,CAAC,CAAC;AACR,GAAG,CAAC,CAAC;AACL,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AAC9B;;AChDY,MAAC,eAAe,GAAG,OAAO,OAAO,KAAK;AAClD,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;AACjB,EAAE,MAAM,IAAI,GAAG,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,KAAK,IAAI,GAAG,EAAE,GAAG,MAAM,CAAC;AACzD,EAAE,MAAM,SAAS,GAAG,CAAC,EAAE,GAAG,OAAO,CAAC,SAAS,KAAK,IAAI,GAAG,EAAE,GAAG,IAAI,CAAC;AACjE,EAAE,MAAM,WAAW,GAAG,CAAC,EAAE,GAAG,OAAO,CAAC,WAAW,KAAK,IAAI,GAAG,EAAE,GAAG,kBAAkB,CAAC;AACnF,EAAE,IAAI,SAAS,EAAE;AACjB,IAAI,OAAO,MAAM,GAAG,CAAC,QAAQ,EAAE;AAC/B,MAAM,KAAK;AACX,MAAM,MAAM;AACZ,MAAM,IAAI;AACV,MAAM,UAAU;AAChB,MAAM,IAAI;AACV,MAAM,CAAC,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC;AACjC,MAAM,IAAI;AACV,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;AACvB,MAAM,KAAK;AACX,MAAM,GAAG,OAAO,CAAC,gBAAgB,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,EAAE;AACnF,MAAM,WAAW;AACjB,MAAM,OAAO;AACb,MAAM,YAAY;AAClB,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AACvB,KAAK,EAAE;AACP,MAAM,aAAa,EAAE,OAAO,CAAC,aAAa;AAC1C,MAAM,aAAa,EAAE,OAAO,CAAC,aAAa;AAC1C,KAAK,CAAC,CAAC;AACP,GAAG;AACH,EAAE,OAAO,MAAM,GAAG,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,YAAY,EAAE,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE;AAC3E,IAAI,aAAa,EAAE,OAAO,CAAC,aAAa;AACxC,IAAI,aAAa,EAAE,OAAO,CAAC,aAAa;AACxC,GAAG,CAAC,CAAC;AACL;;;;;"}

package/dist/cjs/{publish-7bf1e5f7.cjs.js → publish-efa348a5.cjs.js}

@@ -4,20 +4,20 @@ var path = require('path');
 var utility = require('./utility-51f4a306.cjs.js');
 var backendCommon = require('@backstage/backend-common');
 var pluginTechdocsNode = require('@backstage/plugin-techdocs-node');
-var PublisherConfig = require('./PublisherConfig-162efac5.cjs.js');
+var PublisherConfig = require('./PublisherConfig-7a0dc71c.cjs.js');
 require('winston');
 require('@backstage/config');
 
-async function publish(cmd) {
-  const logger = utility.createLogger({ verbose: cmd.verbose });
-  const config = PublisherConfig.PublisherConfig.getValidConfig(cmd);
+async function publish(opts) {
+  const logger = utility.createLogger({ verbose: opts.verbose });
+  const config = PublisherConfig.PublisherConfig.getValidConfig(opts);
   const discovery = backendCommon.SingleHostDiscovery.fromConfig(config);
   const publisher = await pluginTechdocsNode.Publisher.fromConfig(config, { logger, discovery });
   const { isAvailable } = await publisher.getReadiness();
   if (!isAvailable) {
     return Promise.reject(new Error(""));
   }
-  const [namespace, kind, name] = cmd.entity.split("/");
+  const [namespace, kind, name] = opts.entity.split("/");
   const entity = {
     kind,
     metadata: {
@@ -25,10 +25,10 @@ async function publish(cmd) {
       name
     }
   };
-  const directory = path.resolve(cmd.directory);
+  const directory = path.resolve(opts.directory);
   await publisher.publish({ entity, directory });
   return true;
 }
 
 exports["default"] = publish;
-//# sourceMappingURL=publish-7bf1e5f7.cjs.js.map
+//# sourceMappingURL=publish-efa348a5.cjs.js.map

package/dist/cjs/publish-efa348a5.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"publish-efa348a5.cjs.js","sources":["../../src/commands/publish/publish.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 { resolve } from 'path';\nimport { OptionValues } from 'commander';\nimport { createLogger } from '../../lib/utility';\nimport { SingleHostDiscovery } from '@backstage/backend-common';\nimport { Publisher } from '@backstage/plugin-techdocs-node';\nimport { Entity } from '@backstage/catalog-model';\nimport { PublisherConfig } from '../../lib/PublisherConfig';\n\nexport default async function publish(opts: OptionValues): Promise<any> {\n  const logger = createLogger({ verbose: opts.verbose });\n\n  const config = PublisherConfig.getValidConfig(opts);\n  const discovery = SingleHostDiscovery.fromConfig(config);\n  const publisher = await Publisher.fromConfig(config, { logger, discovery });\n\n  // Check that the publisher's underlying storage is ready and available.\n  const { isAvailable } = await publisher.getReadiness();\n  if (!isAvailable) {\n    // Error messages printed in getReadiness() call. This ensures exit code 1.\n    return Promise.reject(new Error(''));\n  }\n\n  const [namespace, kind, name] = opts.entity.split('/');\n  const entity = {\n    kind,\n    metadata: {\n      namespace,\n      name,\n    },\n  } as Entity;\n\n  const directory = resolve(opts.directory);\n  await publisher.publish({ entity, directory });\n\n  return true;\n}\n"],"names":["createLogger","PublisherConfig","SingleHostDiscovery","Publisher","resolve"],"mappings":";;;;;;;;;;AAKe,eAAe,OAAO,CAAC,IAAI,EAAE;AAC5C,EAAE,MAAM,MAAM,GAAGA,oBAAY,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;AACzD,EAAE,MAAM,MAAM,GAAGC,+BAAe,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;AACtD,EAAE,MAAM,SAAS,GAAGC,iCAAmB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;AAC3D,EAAE,MAAM,SAAS,GAAG,MAAMC,4BAAS,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;AAC9E,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,SAAS,CAAC,YAAY,EAAE,CAAC;AACzD,EAAE,IAAI,CAAC,WAAW,EAAE;AACpB,IAAI,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;AACzC,GAAG;AACH,EAAE,MAAM,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACzD,EAAE,MAAM,MAAM,GAAG;AACjB,IAAI,IAAI;AACR,IAAI,QAAQ,EAAE;AACd,MAAM,SAAS;AACf,MAAM,IAAI;AACV,KAAK;AACL,GAAG,CAAC;AACJ,EAAE,MAAM,SAAS,GAAGC,YAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AAC5C,EAAE,MAAM,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;AACjD,EAAE,OAAO,IAAI,CAAC;AACd;;;;"}

package/dist/cjs/{serve-21d1e885.cjs.js → serve-aa1ff626.cjs.js}

@@ -7,7 +7,7 @@ var serveHandler = require('serve-handler');
 var http = require('http');
 var httpProxy = require('http-proxy');
 var utility = require('./utility-51f4a306.cjs.js');
-var mkdocsServer = require('./mkdocsServer-758a3ae9.cjs.js');
+var mkdocsServer = require('./mkdocsServer-0af6527d.cjs.js');
 require('winston');
 require('child_process');
 
@@ -86,18 +86,18 @@ function findPreviewBundlePath() {
     return cliCommon.findPaths(__dirname).resolveOwn("dist/embedded-app");
   }
 }
-async function serve(cmd) {
-  const logger = utility.createLogger({ verbose: cmd.verbose });
+async function serve(opts) {
+  const logger = utility.createLogger({ verbose: opts.verbose });
   const isDevMode = Object.keys(process.env).includes("TECHDOCS_CLI_DEV_MODE") ? true : false;
   const backstagePort = 3e3;
   const backstageBackendPort = 7007;
-  const mkdocsDockerAddr = `http://0.0.0.0:${cmd.mkdocsPort}`;
-  const mkdocsLocalAddr = `http://127.0.0.1:${cmd.mkdocsPort}`;
-  const mkdocsExpectedDevAddr = cmd.docker ? mkdocsDockerAddr : mkdocsLocalAddr;
+  const mkdocsDockerAddr = `http://0.0.0.0:${opts.mkdocsPort}`;
+  const mkdocsLocalAddr = `http://127.0.0.1:${opts.mkdocsPort}`;
+  const mkdocsExpectedDevAddr = opts.docker ? mkdocsDockerAddr : mkdocsLocalAddr;
   let mkdocsServerHasStarted = false;
   const mkdocsLogFunc = (data) => {
     const logLines = data.toString().split("\n");
-    const logPrefix = cmd.docker ? "[docker/mkdocs]" : "[mkdocs]";
+    const logPrefix = opts.docker ? "[docker/mkdocs]" : "[mkdocs]";
     logLines.forEach((line) => {
       if (line === "") {
         return;
@@ -110,9 +110,10 @@ async function serve(cmd) {
   };
   logger.info("Starting mkdocs server.");
   const mkdocsChildProcess = await mkdocsServer.runMkdocsServer({
-    port: cmd.mkdocsPort,
-    dockerImage: cmd.dockerImage,
-    useDocker: cmd.docker,
+    port: opts.mkdocsPort,
+    dockerImage: opts.dockerImage,
+    dockerEntrypoint: opts.dockerEntrypoint,
+    useDocker: opts.docker,
     stdoutLogFunc: mkdocsLogFunc,
     stderrLogFunc: mkdocsLogFunc
   });
@@ -127,7 +128,7 @@ async function serve(cmd) {
     logger.error("mkdocs server did not start. Exiting. Try re-running command with -v option for more details.");
   }
   const port = isDevMode ? backstageBackendPort : backstagePort;
-  const httpServer = new HTTPServer(findPreviewBundlePath(), port, cmd.mkdocsPort, cmd.verbose);
+  const httpServer = new HTTPServer(findPreviewBundlePath(), port, opts.mkdocsPort, opts.verbose);
   httpServer.serve().catch((err) => {
     logger.error(err);
     mkdocsChildProcess.kill();
@@ -141,4 +142,4 @@ Opening browser.`);
 }
 
 exports["default"] = serve;
-//# sourceMappingURL=serve-21d1e885.cjs.js.map
+//# sourceMappingURL=serve-aa1ff626.cjs.js.map

package/dist/cjs/serve-aa1ff626.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serve-aa1ff626.cjs.js","sources":["../../src/lib/httpServer.ts","../../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 serveHandler from 'serve-handler';\nimport http from 'http';\nimport httpProxy from 'http-proxy';\nimport { createLogger } from './utility';\n\nexport default class HTTPServer {\n  private readonly proxyEndpoint: string;\n  private readonly backstageBundleDir: string;\n  private readonly backstagePort: number;\n  private readonly mkdocsPort: number;\n  private readonly verbose: boolean;\n\n  constructor(\n    backstageBundleDir: string,\n    backstagePort: number,\n    mkdocsPort: number,\n    verbose: boolean,\n  ) {\n    this.proxyEndpoint = '/api/';\n    this.backstageBundleDir = backstageBundleDir;\n    this.backstagePort = backstagePort;\n    this.mkdocsPort = mkdocsPort;\n    this.verbose = verbose;\n  }\n\n  // Create a Proxy for mkdocs server\n  private createProxy() {\n    const proxy = httpProxy.createProxyServer({\n      target: `http://localhost:${this.mkdocsPort}`,\n    });\n\n    return (request: http.IncomingMessage): [httpProxy, string] => {\n      // If the request goes to /api/ we want to remove /api/ from the prefix of the request URL.\n      // e.g. ['/', 'api', pathChunks]\n      const [, , ...pathChunks] = request.url?.split('/') ?? [];\n      const forwardPath = pathChunks.join('/');\n\n      return [proxy, forwardPath];\n    };\n  }\n\n  public async serve(): Promise<http.Server> {\n    return new Promise<http.Server>((resolve, reject) => {\n      const proxyHandler = this.createProxy();\n      const server = http.createServer(\n        (request: http.IncomingMessage, response: http.ServerResponse) => {\n          if (request.url?.startsWith(this.proxyEndpoint)) {\n            const [proxy, forwardPath] = proxyHandler(request);\n\n            proxy.on('error', (error: Error) => {\n              reject(error);\n            });\n\n            response.setHeader('Access-Control-Allow-Origin', '*');\n            response.setHeader('Access-Control-Allow-Methods', 'GET, OPTIONS');\n\n            request.url = forwardPath;\n            proxy.web(request, response);\n            return;\n          }\n\n          // This endpoint is used by the frontend to detect where the backend is running.\n          if (request.url === '/.detect') {\n            response.setHeader('Content-Type', 'text/plain');\n            response.end('techdocs-cli-server');\n            return;\n          }\n\n          serveHandler(request, response, {\n            public: this.backstageBundleDir,\n            trailingSlash: true,\n            rewrites: [{ source: '**', destination: 'index.html' }],\n          });\n        },\n      );\n\n      const logger = createLogger({ verbose: false });\n      server.listen(this.backstagePort, () => {\n        if (this.verbose) {\n          logger.info(\n            `[techdocs-preview-bundle] Running local version of Backstage at http://localhost:${this.backstagePort}`,\n          );\n        }\n        resolve(server);\n      });\n\n      server.on('error', (error: Error) => {\n        reject(error);\n      });\n    });\n  }\n}\n","/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { OptionValues } from 'commander';\nimport path from 'path';\nimport openBrowser from 'react-dev-utils/openBrowser';\nimport { findPaths } from '@backstage/cli-common';\nimport HTTPServer from '../../lib/httpServer';\nimport { runMkdocsServer } from '../../lib/mkdocsServer';\nimport { LogFunc, waitForSignal } from '../../lib/run';\nimport { createLogger } from '../../lib/utility';\n\nfunction findPreviewBundlePath(): string {\n  try {\n    return path.join(\n      path.dirname(require.resolve('techdocs-cli-embedded-app/package.json')),\n      'dist',\n    );\n  } catch {\n    // If the techdocs-cli-embedded-app package is not available it means we're\n    // running a published package. For published packages the preview bundle is\n    // copied to dist/embedded-app be the prepack script.\n    //\n    // This can be tested by running `yarn pack` and extracting the resulting tarball into a directory.\n    // Within the extracted directory, run `npm install --only=prod`.\n    // Once that's done you can test the CLI in any directory using `node <tmp-dir>/package <command>`.\n    // eslint-disable-next-line no-restricted-syntax\n    return findPaths(__dirname).resolveOwn('dist/embedded-app');\n  }\n}\n\nexport default async function serve(opts: OptionValues) {\n  const logger = createLogger({ verbose: opts.verbose });\n\n  // Determine if we want to run in local dev mode or not\n  // This will run the backstage http server on a different port and only used\n  // for proxying mkdocs to the backstage app running locally (e.g. with webpack-dev-server)\n  const isDevMode = Object.keys(process.env).includes('TECHDOCS_CLI_DEV_MODE')\n    ? true\n    : false;\n\n  // TODO: Backstage app port should also be configurable as a CLI option. However, since we bundle\n  // a backstage app, we define app.baseUrl in the app-config.yaml.\n  // Hence, it is complicated to make this configurable.\n  const backstagePort = 3000;\n  const backstageBackendPort = 7007;\n\n  const mkdocsDockerAddr = `http://0.0.0.0:${opts.mkdocsPort}`;\n  const mkdocsLocalAddr = `http://127.0.0.1:${opts.mkdocsPort}`;\n  const mkdocsExpectedDevAddr = opts.docker\n    ? mkdocsDockerAddr\n    : mkdocsLocalAddr;\n\n  let mkdocsServerHasStarted = false;\n  const mkdocsLogFunc: LogFunc = data => {\n    // Sometimes the lines contain an unnecessary extra new line\n    const logLines = data.toString().split('\\n');\n    const logPrefix = opts.docker ? '[docker/mkdocs]' : '[mkdocs]';\n    logLines.forEach(line => {\n      if (line === '') {\n        return;\n      }\n\n      logger.verbose(`${logPrefix} ${line}`);\n\n      // When the server has started, open a new browser tab for the user.\n      if (\n        !mkdocsServerHasStarted &&\n        line.includes(`Serving on ${mkdocsExpectedDevAddr}`)\n      ) {\n        mkdocsServerHasStarted = true;\n      }\n    });\n  };\n  // mkdocs writes all of its logs to stderr by default, and not stdout.\n  // https://github.com/mkdocs/mkdocs/issues/879#issuecomment-203536006\n  // Had me questioning this whole implementation for half an hour.\n  logger.info('Starting mkdocs server.');\n  const mkdocsChildProcess = await runMkdocsServer({\n    port: opts.mkdocsPort,\n    dockerImage: opts.dockerImage,\n    dockerEntrypoint: opts.dockerEntrypoint,\n    useDocker: opts.docker,\n    stdoutLogFunc: mkdocsLogFunc,\n    stderrLogFunc: mkdocsLogFunc,\n  });\n\n  // Wait until mkdocs server has started so that Backstage starts with docs loaded\n  // Takes 1-5 seconds\n  for (let attempt = 0; attempt < 30; attempt++) {\n    await new Promise(r => setTimeout(r, 3000));\n    if (mkdocsServerHasStarted) {\n      break;\n    }\n    logger.info('Waiting for mkdocs server to start...');\n  }\n\n  if (!mkdocsServerHasStarted) {\n    logger.error(\n      'mkdocs server did not start. Exiting. Try re-running command with -v option for more details.',\n    );\n  }\n\n  const port = isDevMode ? backstageBackendPort : backstagePort;\n  const httpServer = new HTTPServer(\n    findPreviewBundlePath(),\n    port,\n    opts.mkdocsPort,\n    opts.verbose,\n  );\n\n  httpServer\n    .serve()\n    .catch(err => {\n      logger.error(err);\n      mkdocsChildProcess.kill();\n      process.exit(1);\n    })\n    .then(() => {\n      // The last three things default/component/local/ don't matter. They can be anything.\n      openBrowser(`http://localhost:${port}/docs/default/component/local/`);\n      logger.info(\n        `Serving docs in Backstage at http://localhost:${port}/docs/default/component/local/\\nOpening browser.`,\n      );\n    });\n\n  await waitForSignal([mkdocsChildProcess]);\n}\n"],"names":["httpProxy","http","serveHandler","createLogger","path","findPaths","runMkdocsServer","openBrowser","waitForSignal"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAIe,MAAM,UAAU,CAAC;AAChC,EAAE,WAAW,CAAC,kBAAkB,EAAE,aAAa,EAAE,UAAU,EAAE,OAAO,EAAE;AACtE,IAAI,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC;AACjC,IAAI,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;AACjD,IAAI,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;AACvC,IAAI,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;AACjC,IAAI,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;AAC3B,GAAG;AACH,EAAE,WAAW,GAAG;AAChB,IAAI,MAAM,KAAK,GAAGA,6BAAS,CAAC,iBAAiB,CAAC;AAC9C,MAAM,MAAM,EAAE,CAAC,iBAAiB,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;AACnD,KAAK,CAAC,CAAC;AACP,IAAI,OAAO,CAAC,OAAO,KAAK;AACxB,MAAM,IAAI,EAAE,EAAE,EAAE,CAAC;AACjB,MAAM,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,EAAE,GAAG,OAAO,CAAC,GAAG,KAAK,IAAI,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,IAAI,GAAG,EAAE,GAAG,EAAE,CAAC;AAC/G,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC/C,MAAM,OAAO,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;AAClC,KAAK,CAAC;AACN,GAAG;AACH,EAAE,MAAM,KAAK,GAAG;AAChB,IAAI,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,KAAK;AAC5C,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;AAC9C,MAAM,MAAM,MAAM,GAAGC,wBAAI,CAAC,YAAY,CAAC,CAAC,OAAO,EAAE,QAAQ,KAAK;AAC9D,QAAQ,IAAI,EAAE,CAAC;AACf,QAAQ,IAAI,CAAC,EAAE,GAAG,OAAO,CAAC,GAAG,KAAK,IAAI,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE;AACrF,UAAU,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;AAC7D,UAAU,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,KAAK;AACvC,YAAY,MAAM,CAAC,KAAK,CAAC,CAAC;AAC1B,WAAW,CAAC,CAAC;AACb,UAAU,QAAQ,CAAC,SAAS,CAAC,6BAA6B,EAAE,GAAG,CAAC,CAAC;AACjE,UAAU,QAAQ,CAAC,SAAS,CAAC,8BAA8B,EAAE,cAAc,CAAC,CAAC;AAC7E,UAAU,OAAO,CAAC,GAAG,GAAG,WAAW,CAAC;AACpC,UAAU,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AACvC,UAAU,OAAO;AACjB,SAAS;AACT,QAAQ,IAAI,OAAO,CAAC,GAAG,KAAK,UAAU,EAAE;AACxC,UAAU,QAAQ,CAAC,SAAS,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;AAC3D,UAAU,QAAQ,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;AAC9C,UAAU,OAAO;AACjB,SAAS;AACT,QAAQC,gCAAY,CAAC,OAAO,EAAE,QAAQ,EAAE;AACxC,UAAU,MAAM,EAAE,IAAI,CAAC,kBAAkB;AACzC,UAAU,aAAa,EAAE,IAAI;AAC7B,UAAU,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC;AACjE,SAAS,CAAC,CAAC;AACX,OAAO,CAAC,CAAC;AACT,MAAM,MAAM,MAAM,GAAGC,oBAAY,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;AACtD,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM;AAC9C,QAAQ,IAAI,IAAI,CAAC,OAAO,EAAE;AAC1B,UAAU,MAAM,CAAC,IAAI,CAAC,CAAC,iFAAiF,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;AAChI,SAAS;AACT,QAAQ,OAAO,CAAC,MAAM,CAAC,CAAC;AACxB,OAAO,CAAC,CAAC;AACT,MAAM,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,KAAK;AACpC,QAAQ,MAAM,CAAC,KAAK,CAAC,CAAC;AACtB,OAAO,CAAC,CAAC;AACT,KAAK,CAAC,CAAC;AACP,GAAG;AACH;;ACvDA,SAAS,qBAAqB,GAAG;AACjC,EAAE,IAAI;AACN,IAAI,OAAOC,wBAAI,CAAC,IAAI,CAACA,wBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,wCAAwC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AACtG,GAAG,CAAC,MAAM;AACV,IAAI,OAAOC,mBAAS,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAChE,GAAG;AACH,CAAC;AACc,eAAe,KAAK,CAAC,IAAI,EAAE;AAC1C,EAAE,MAAM,MAAM,GAAGF,oBAAY,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;AACzD,EAAE,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,uBAAuB,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAC9F,EAAE,MAAM,aAAa,GAAG,GAAG,CAAC;AAC5B,EAAE,MAAM,oBAAoB,GAAG,IAAI,CAAC;AACpC,EAAE,MAAM,gBAAgB,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;AAC/D,EAAE,MAAM,eAAe,GAAG,CAAC,iBAAiB,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;AAChE,EAAE,MAAM,qBAAqB,GAAG,IAAI,CAAC,MAAM,GAAG,gBAAgB,GAAG,eAAe,CAAC;AACjF,EAAE,IAAI,sBAAsB,GAAG,KAAK,CAAC;AACrC,EAAE,MAAM,aAAa,GAAG,CAAC,IAAI,KAAK;AAClC,IAAI,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACjD,IAAI,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,GAAG,iBAAiB,GAAG,UAAU,CAAC;AACnE,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,KAAK;AAC/B,MAAM,IAAI,IAAI,KAAK,EAAE,EAAE;AACvB,QAAQ,OAAO;AACf,OAAO;AACP,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AAC7C,MAAM,IAAI,CAAC,sBAAsB,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,qBAAqB,CAAC,CAAC,CAAC,EAAE;AAC3F,QAAQ,sBAAsB,GAAG,IAAI,CAAC;AACtC,OAAO;AACP,KAAK,CAAC,CAAC;AACP,GAAG,CAAC;AACJ,EAAE,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;AACzC,EAAE,MAAM,kBAAkB,GAAG,MAAMG,4BAAe,CAAC;AACnD,IAAI,IAAI,EAAE,IAAI,CAAC,UAAU;AACzB,IAAI,WAAW,EAAE,IAAI,CAAC,WAAW;AACjC,IAAI,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;AAC3C,IAAI,SAAS,EAAE,IAAI,CAAC,MAAM;AAC1B,IAAI,aAAa,EAAE,aAAa;AAChC,IAAI,aAAa,EAAE,aAAa;AAChC,GAAG,CAAC,CAAC;AACL,EAAE,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,GAAG,EAAE,EAAE,OAAO,EAAE,EAAE;AACjD,IAAI,MAAM,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;AACjD,IAAI,IAAI,sBAAsB,EAAE;AAChC,MAAM,MAAM;AACZ,KAAK;AACL,IAAI,MAAM,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC;AACzD,GAAG;AACH,EAAE,IAAI,CAAC,sBAAsB,EAAE;AAC/B,IAAI,MAAM,CAAC,KAAK,CAAC,+FAA+F,CAAC,CAAC;AAClH,GAAG;AACH,EAAE,MAAM,IAAI,GAAG,SAAS,GAAG,oBAAoB,GAAG,aAAa,CAAC;AAChE,EAAE,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;AAClG,EAAE,UAAU,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,KAAK;AACpC,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACtB,IAAI,kBAAkB,CAAC,IAAI,EAAE,CAAC;AAC9B,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACpB,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM;AAChB,IAAIC,+BAAW,CAAC,CAAC,iBAAiB,EAAE,IAAI,CAAC,8BAA8B,CAAC,CAAC,CAAC;AAC1E,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,8CAA8C,EAAE,IAAI,CAAC;AACtE,gBAAgB,CAAC,CAAC,CAAC;AACnB,GAAG,CAAC,CAAC;AACL,EAAE,MAAMC,0BAAa,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC;AAC5C;;;;"}

package/dist/cjs/utility-51f4a306.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"utility-51f4a306.cjs.js","sources":["../../src/lib/utility.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 */\nimport {\n  RemoteProtocol,\n  ParsedLocationAnnotation,\n} from '@backstage/plugin-techdocs-node';\nimport * as winston from 'winston';\n\nexport const convertTechDocsRefToLocationAnnotation = (\n  techdocsRef: string,\n): ParsedLocationAnnotation => {\n  // Split on the first colon for the protocol and the rest after the first split\n  // is the location.\n  const [type, target] = techdocsRef.split(/:(.+)/) as [\n    RemoteProtocol?,\n    string?,\n  ];\n\n  if (!type || !target) {\n    throw new Error(\n      `Can not parse --techdocs-ref ${techdocsRef}. Should be of type HOST:URL.`,\n    );\n  }\n\n  return { type, target };\n};\n\nexport const createLogger = ({\n  verbose = false,\n}: {\n  verbose: boolean;\n}): winston.Logger => {\n  const logger = winston.createLogger({\n    level: verbose ? 'verbose' : 'info',\n    transports: [\n      new winston.transports.Console({ format: winston.format.simple() }),\n    ],\n  });\n\n  return logger;\n};\n"],"names":["winston"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAqBa,MAAA,sCAAA,GAAyC,CACpD,WAC6B,KAAA;AAG7B,EAAA,MAAM,CAAC,IAAA,EAAM,MAAU,CAAA,GAAA,WAAA,CAAY,MAAM,OAAO,CAAA,CAAA;AAKhD,EAAI,IAAA,CAAC,IAAQ,IAAA,CAAC,MAAQ,EAAA;AACpB,IAAM,MAAA,IAAI,KACR,CAAA,CAAA,6BAAA,EAAgC,WAClC,CAAA,6BAAA,CAAA,CAAA,CAAA;AAAA,GACF;AAEA,EAAO,OAAA,EAAE,MAAM,MAAO,EAAA,CAAA;AACxB,EAAA;AAEO,MAAM,eAAe,CAAC;AAAA,EAC3B,OAAU,GAAA,KAAA;AAAA,CAGU,KAAA;AACpB,EAAM,MAAA,MAAA,GAASA,mBAAQ,YAAa,CAAA;AAAA,IAClC,KAAA,EAAO,UAAU,SAAY,GAAA,MAAA;AAAA,IAC7B,UAAY,EAAA;AAAA,MACV,IAAIA,kBAAQ,CAAA,UAAA,CAAW,OAAQ,CAAA,EAAE,QAAQA,kBAAQ,CAAA,MAAA,CAAO,MAAO,EAAA,EAAG,CAAA;AAAA,KACpE;AAAA,GACD,CAAA,CAAA;AAED,EAAO,OAAA,MAAA,CAAA;AACT;;;;;"}
+{"version":3,"file":"utility-51f4a306.cjs.js","sources":["../../src/lib/utility.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 */\nimport {\n  RemoteProtocol,\n  ParsedLocationAnnotation,\n} from '@backstage/plugin-techdocs-node';\nimport * as winston from 'winston';\n\nexport const convertTechDocsRefToLocationAnnotation = (\n  techdocsRef: string,\n): ParsedLocationAnnotation => {\n  // Split on the first colon for the protocol and the rest after the first split\n  // is the location.\n  const [type, target] = techdocsRef.split(/:(.+)/) as [\n    RemoteProtocol?,\n    string?,\n  ];\n\n  if (!type || !target) {\n    throw new Error(\n      `Can not parse --techdocs-ref ${techdocsRef}. Should be of type HOST:URL.`,\n    );\n  }\n\n  return { type, target };\n};\n\nexport const createLogger = ({\n  verbose = false,\n}: {\n  verbose: boolean;\n}): winston.Logger => {\n  const logger = winston.createLogger({\n    level: verbose ? 'verbose' : 'info',\n    transports: [\n      new winston.transports.Console({ format: winston.format.simple() }),\n    ],\n  });\n\n  return logger;\n};\n"],"names":["winston"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AACY,MAAC,sCAAsC,GAAG,CAAC,WAAW,KAAK;AACvE,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AACpD,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE;AACxB,IAAI,MAAM,IAAI,KAAK,CAAC,CAAC,6BAA6B,EAAE,WAAW,CAAC,6BAA6B,CAAC,CAAC,CAAC;AAChG,GAAG;AACH,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AAC1B,EAAE;AACU,MAAC,YAAY,GAAG,CAAC;AAC7B,EAAE,OAAO,GAAG,KAAK;AACjB,CAAC,KAAK;AACN,EAAE,MAAM,MAAM,GAAGA,kBAAO,CAAC,YAAY,CAAC;AACtC,IAAI,KAAK,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM;AACvC,IAAI,UAAU,EAAE;AAChB,MAAM,IAAIA,kBAAO,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,MAAM,EAAEA,kBAAO,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;AACzE,KAAK;AACL,GAAG,CAAC,CAAC;AACL,EAAE,OAAO,MAAM,CAAC;AAChB;;;;;"}