@techdocs/cli 1.1.4-next.1 → 1.2.0-next.2

package/dist/index.cjs.js

@@ -139,10 +139,13 @@ function registerCommands(program) {
   ).option(
     "--docker-entrypoint <DOCKER_ENTRYPOINT>",
     "Override the image entrypoint"
+  ).option(
+    "--docker-option <DOCKER_OPTION...>",
+    '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 `mkdocs serve` in current user environment."
-  ).option("-p, --port <PORT>", "Port to serve documentation locally", "8000").option("-v --verbose", "Enable verbose output.", false).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/mkdocs-1961b6ea.cjs.js'); }).then((m) => m.default)));
+  ).option("-p, --port <PORT>", "Port to serve documentation locally", "8000").option("-v --verbose", "Enable verbose output.", false).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/mkdocs-1501e940.cjs.js'); }).then((m) => m.default)));
   program.command("serve").description(
     "Serve a documentation project locally in a Backstage app-like environment"
   ).option(
@@ -152,10 +155,13 @@ function registerCommands(program) {
   ).option(
     "--docker-entrypoint <DOCKER_ENTRYPOINT>",
     "Override the image entrypoint"
+  ).option(
+    "--docker-option <DOCKER_OPTION...>",
+    '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."
-  ).option("--mkdocs-port <PORT>", "Port for MkDocs server to use", "8000").option("-v --verbose", "Enable verbose output.", false).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/serve-0818dbae.cjs.js'); }).then((m) => m.default)));
+  ).option("--mkdocs-port <PORT>", "Port for MkDocs server to use", "8000").option("-v --verbose", "Enable verbose output.", false).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/serve-176119a3.cjs.js'); }).then((m) => m.default)));
 }
 function lazy(getActionFunc) {
   return async (...args) => {
@@ -170,7 +176,7 @@ function lazy(getActionFunc) {
   };
 }
 
-var version = "1.1.4-next.1";
+var version = "1.2.0-next.2";
 
 const main = (argv) => {
   commander.program.name("techdocs-cli").version(version);

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/commands/index.ts","../src/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;\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    )\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    .alias('build')\n    .action(lazy(() => import('./generate/generate').then(m => m.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      '--awsBucketRootPath',\n      'Optional sub-directory to store files in Amazon S3',\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').then(m => m.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('--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      '--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',\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    .action(lazy(() => import('./publish/publish').then(m => m.default)));\n\n  program\n    .command('serve:mkdocs')\n    .description('Serve a documentation project locally using MkDocs serve.')\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      '--no-docker',\n      'Do not use Docker, run `mkdocs serve` in current user environment.',\n    )\n    .option('-p, --port <PORT>', 'Port to serve documentation locally', '8000')\n    .option('-v --verbose', 'Enable verbose output.', false)\n    .action(lazy(() => import('./serve/mkdocs').then(m => m.default)));\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      '--no-docker',\n      'Do not use Docker, use MkDocs executable in current user environment.',\n    )\n    .option('--mkdocs-port <PORT>', 'Port for MkDocs server to use', '8000')\n    .option('-v --verbose', 'Enable verbose output.', false)\n    .action(lazy(() => import('./serve/serve').then(m => m.default)));\n}\n\n// Wraps an action function so that it always exits and handles errors\n// Humbly taken from backstage-cli's registerCommands\nfunction lazy(\n  getActionFunc: () => Promise<(...args: any[]) => Promise<void>>,\n): (...args: any[]) => Promise<never> {\n  return async (...args: any[]) => {\n    try {\n      const actionFunc = await getActionFunc();\n      await actionFunc(...args);\n      process.exit(0);\n    } catch (error) {\n      // eslint-disable-next-line no-console\n      console.error(error.message);\n      process.exit(1);\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 { program } from 'commander';\nimport { registerCommands } from './commands';\nimport { version } from '../package.json';\n\nconst main = (argv: string[]) => {\n  program.name('techdocs-cli').version(version);\n\n  registerCommands(program);\n\n  program.parse(argv);\n};\n\nmain(process.argv);\n"],"names":["TechdocsGenerator","program"],"mappings":";;;;;AACA,MAAM,kBAAkB,GAAGA,oCAAiB,CAAC,kBAAkB,CAAC;AACzD,SAAS,gBAAgB,CAAC,OAAO,EAAE;AAC1C,EAAE,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,WAAW,CAAC,oDAAoD,CAAC,CAAC,MAAM;AACtG,IAAI,qBAAqB;AACzB,IAAI,6DAA6D;AACjE,IAAI,GAAG;AACP,GAAG,CAAC,MAAM;AACV,IAAI,qBAAqB;AACzB,IAAI,sDAAsD;AAC1D,IAAI,SAAS;AACb,GAAG,CAAC,MAAM;AACV,IAAI,+BAA+B;AACnC,IAAI,oCAAoC;AACxC,IAAI,kBAAkB;AACtB,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,qCAAqC,CAAC,CAAC,MAAM;AACrE,IAAI,aAAa;AACjB,IAAI,mFAAmF;AACvF,GAAG,CAAC,MAAM;AACV,IAAI,gCAAgC;AACpC,IAAI,sTAAsT;AAC1T,GAAG,CAAC,MAAM;AACV,IAAI,eAAe;AACnB,IAAI,qHAAqH;AACzH,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,wBAAwB,EAAE,KAAK,CAAC,CAAC,MAAM;AAClE,IAAI,gCAAgC;AACpC,IAAI,kEAAkE;AACtE,IAAI,KAAK;AACT,GAAG,CAAC,MAAM;AACV,IAAI,+BAA+B;AACnC,IAAI,qJAAqJ;AACzJ,IAAI,KAAK;AACT,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,oDAAO,gCAAqB,KAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAC5F,EAAE,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,WAAW;AACxC,IAAI,6EAA6E;AACjF,GAAG,CAAC,cAAc;AAClB,IAAI,yBAAyB;AAC7B,IAAI,wIAAwI;AAC5I,GAAG,CAAC,cAAc;AAClB,IAAI,wCAAwC;AAC5C,IAAI,+IAA+I;AACnJ,GAAG,CAAC,MAAM;AACV,IAAI,yCAAyC;AAC7C,IAAI,qEAAqE;AACzE,GAAG,CAAC,MAAM;AACV,IAAI,uCAAuC;AAC3C,IAAI,sKAAsK;AAC1K,GAAG,CAAC,MAAM;AACV,IAAI,6BAA6B;AACjC,IAAI,yCAAyC;AAC7C,GAAG,CAAC,MAAM;AACV,IAAI,8BAA8B;AAClC,IAAI,4CAA4C;AAChD,GAAG,CAAC,MAAM;AACV,IAAI,uBAAuB;AAC3B,IAAI,6CAA6C;AACjD,GAAG,CAAC,MAAM;AACV,IAAI,qBAAqB;AACzB,IAAI,oDAAoD;AACxD,GAAG,CAAC,MAAM;AACV,IAAI,8DAA8D;AAClE,IAAI,uEAAuE;AAC3E,GAAG,CAAC,MAAM;AACV,IAAI,4DAA4D;AAChE,IAAI,uEAAuE;AAC3E,GAAG,CAAC,MAAM;AACV,IAAI,uCAAuC;AAC3C,IAAI,uEAAuE;AAC3E,GAAG,CAAC,MAAM;AACV,IAAI,yCAAyC;AAC7C,IAAI,uEAAuE;AAC3E,GAAG,CAAC,MAAM;AACV,IAAI,kBAAkB;AACtB,IAAI,wFAAwF;AAC5F,IAAI,KAAK;AACT,GAAG,CAAC,MAAM;AACV,IAAI,qCAAqC;AACzC,IAAI,sFAAsF;AAC1F,IAAI,IAAI;AACR,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,wBAAwB,EAAE,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,oDAAO,+BAAmB,KAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AACnI,EAAE,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,WAAW;AACxC,IAAI,iFAAiF;AACrF,GAAG,CAAC,cAAc;AAClB,IAAI,yBAAyB;AAC7B,IAAI,wIAAwI;AAC5I,GAAG,CAAC,cAAc;AAClB,IAAI,wCAAwC;AAC5C,IAAI,+IAA+I;AACnJ,GAAG,CAAC,cAAc;AAClB,IAAI,gCAAgC;AACpC,IAAI,iIAAiI;AACrI,GAAG,CAAC,MAAM;AACV,IAAI,sCAAsC;AAC1C,IAAI,uJAAuJ;AAC3J,IAAI,KAAK;AACT,GAAG,CAAC,MAAM;AACV,IAAI,yCAAyC;AAC7C,IAAI,qEAAqE;AACzE,GAAG,CAAC,MAAM;AACV,IAAI,uCAAuC;AAC3C,IAAI,sKAAsK;AAC1K,GAAG,CAAC,MAAM;AACV,IAAI,6BAA6B;AACjC,IAAI,yCAAyC;AAC7C,GAAG,CAAC,MAAM;AACV,IAAI,8BAA8B;AAClC,IAAI,4CAA4C;AAChD,GAAG,CAAC,MAAM,CAAC,sBAAsB,EAAE,yCAAyC,CAAC,CAAC,MAAM;AACpF,IAAI,uBAAuB;AAC3B,IAAI,6CAA6C;AACjD,GAAG,CAAC,MAAM;AACV,IAAI,8DAA8D;AAClE,IAAI,uEAAuE;AAC3E,GAAG,CAAC,MAAM;AACV,IAAI,4DAA4D;AAChE,IAAI,uEAAuE;AAC3E,GAAG,CAAC,MAAM;AACV,IAAI,uCAAuC;AAC3C,IAAI,uEAAuE;AAC3E,GAAG,CAAC,MAAM;AACV,IAAI,yCAAyC;AAC7C,IAAI,uEAAuE;AAC3E,GAAG,CAAC,MAAM;AACV,IAAI,qBAAqB;AACzB,IAAI,+DAA+D;AACnE,GAAG,CAAC,MAAM;AACV,IAAI,oBAAoB;AACxB,IAAI,6DAA6D;AACjE,IAAI,SAAS;AACb,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,oDAAO,+BAAmB,KAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAC3E,EAAE,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,WAAW,CAAC,2DAA2D,CAAC,CAAC,MAAM;AACjH,IAAI,mCAAmC;AACvC,IAAI,oCAAoC;AACxC,IAAI,kBAAkB;AACtB,GAAG,CAAC,MAAM;AACV,IAAI,yCAAyC;AAC7C,IAAI,+BAA+B;AACnC,GAAG,CAAC,MAAM;AACV,IAAI,aAAa;AACjB,IAAI,oEAAoE;AACxE,GAAG,CAAC,MAAM,CAAC,mBAAmB,EAAE,qCAAqC,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,cAAc,EAAE,wBAAwB,EAAE,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,oDAAO,8BAAgB,KAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAC3M,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,WAAW;AACtC,IAAI,2EAA2E;AAC/E,GAAG,CAAC,MAAM;AACV,IAAI,mCAAmC;AACvC,IAAI,oCAAoC;AACxC,IAAI,kBAAkB;AACtB,GAAG,CAAC,MAAM;AACV,IAAI,yCAAyC;AAC7C,IAAI,+BAA+B;AACnC,GAAG,CAAC,MAAM;AACV,IAAI,aAAa;AACjB,IAAI,uEAAuE;AAC3E,GAAG,CAAC,MAAM,CAAC,sBAAsB,EAAE,+BAA+B,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,cAAc,EAAE,wBAAwB,EAAE,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,oDAAO,6BAAe,KAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AACvM,CAAC;AACD,SAAS,IAAI,CAAC,aAAa,EAAE;AAC7B,EAAE,OAAO,OAAO,GAAG,IAAI,KAAK;AAC5B,IAAI,IAAI;AACR,MAAM,MAAM,UAAU,GAAG,MAAM,aAAa,EAAE,CAAC;AAC/C,MAAM,MAAM,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;AAChC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACtB,KAAK,CAAC,OAAO,KAAK,EAAE;AACpB,MAAM,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AACnC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACtB,KAAK;AACL,GAAG,CAAC;AACJ;;;;ACnKA,MAAM,IAAI,GAAG,CAAC,IAAI,KAAK;AACvB,EAAEC,iBAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AAChD,EAAE,gBAAgB,CAACA,iBAAO,CAAC,CAAC;AAC5B,EAAEA,iBAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACtB,CAAC,CAAC;AACF,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/commands/index.ts","../src/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;\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    )\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    .alias('build')\n    .action(lazy(() => import('./generate/generate').then(m => m.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      '--awsBucketRootPath',\n      'Optional sub-directory to store files in Amazon S3',\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').then(m => m.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('--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      '--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',\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    .action(lazy(() => import('./publish/publish').then(m => m.default)));\n\n  program\n    .command('serve:mkdocs')\n    .description('Serve a documentation project locally using MkDocs serve.')\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('-p, --port <PORT>', 'Port to serve documentation locally', '8000')\n    .option('-v --verbose', 'Enable verbose output.', false)\n    .action(lazy(() => import('./serve/mkdocs').then(m => m.default)));\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('--mkdocs-port <PORT>', 'Port for MkDocs server to use', '8000')\n    .option('-v --verbose', 'Enable verbose output.', false)\n    .action(lazy(() => import('./serve/serve').then(m => m.default)));\n}\n\n// Wraps an action function so that it always exits and handles errors\n// Humbly taken from backstage-cli's registerCommands\nfunction lazy(\n  getActionFunc: () => Promise<(...args: any[]) => Promise<void>>,\n): (...args: any[]) => Promise<never> {\n  return async (...args: any[]) => {\n    try {\n      const actionFunc = await getActionFunc();\n      await actionFunc(...args);\n      process.exit(0);\n    } catch (error) {\n      // eslint-disable-next-line no-console\n      console.error(error.message);\n      process.exit(1);\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 { program } from 'commander';\nimport { registerCommands } from './commands';\nimport { version } from '../package.json';\n\nconst main = (argv: string[]) => {\n  program.name('techdocs-cli').version(version);\n\n  registerCommands(program);\n\n  program.parse(argv);\n};\n\nmain(process.argv);\n"],"names":["TechdocsGenerator","program"],"mappings":";;;;;AACA,MAAM,kBAAkB,GAAGA,oCAAiB,CAAC,kBAAkB,CAAC;AACzD,SAAS,gBAAgB,CAAC,OAAO,EAAE;AAC1C,EAAE,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,WAAW,CAAC,oDAAoD,CAAC,CAAC,MAAM;AACtG,IAAI,qBAAqB;AACzB,IAAI,6DAA6D;AACjE,IAAI,GAAG;AACP,GAAG,CAAC,MAAM;AACV,IAAI,qBAAqB;AACzB,IAAI,sDAAsD;AAC1D,IAAI,SAAS;AACb,GAAG,CAAC,MAAM;AACV,IAAI,+BAA+B;AACnC,IAAI,oCAAoC;AACxC,IAAI,kBAAkB;AACtB,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,qCAAqC,CAAC,CAAC,MAAM;AACrE,IAAI,aAAa;AACjB,IAAI,mFAAmF;AACvF,GAAG,CAAC,MAAM;AACV,IAAI,gCAAgC;AACpC,IAAI,sTAAsT;AAC1T,GAAG,CAAC,MAAM;AACV,IAAI,eAAe;AACnB,IAAI,qHAAqH;AACzH,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,wBAAwB,EAAE,KAAK,CAAC,CAAC,MAAM;AAClE,IAAI,gCAAgC;AACpC,IAAI,kEAAkE;AACtE,IAAI,KAAK;AACT,GAAG,CAAC,MAAM;AACV,IAAI,+BAA+B;AACnC,IAAI,qJAAqJ;AACzJ,IAAI,KAAK;AACT,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,oDAAO,gCAAqB,KAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAC5F,EAAE,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,WAAW;AACxC,IAAI,6EAA6E;AACjF,GAAG,CAAC,cAAc;AAClB,IAAI,yBAAyB;AAC7B,IAAI,wIAAwI;AAC5I,GAAG,CAAC,cAAc;AAClB,IAAI,wCAAwC;AAC5C,IAAI,+IAA+I;AACnJ,GAAG,CAAC,MAAM;AACV,IAAI,yCAAyC;AAC7C,IAAI,qEAAqE;AACzE,GAAG,CAAC,MAAM;AACV,IAAI,uCAAuC;AAC3C,IAAI,sKAAsK;AAC1K,GAAG,CAAC,MAAM;AACV,IAAI,6BAA6B;AACjC,IAAI,yCAAyC;AAC7C,GAAG,CAAC,MAAM;AACV,IAAI,8BAA8B;AAClC,IAAI,4CAA4C;AAChD,GAAG,CAAC,MAAM;AACV,IAAI,uBAAuB;AAC3B,IAAI,6CAA6C;AACjD,GAAG,CAAC,MAAM;AACV,IAAI,qBAAqB;AACzB,IAAI,oDAAoD;AACxD,GAAG,CAAC,MAAM;AACV,IAAI,8DAA8D;AAClE,IAAI,uEAAuE;AAC3E,GAAG,CAAC,MAAM;AACV,IAAI,4DAA4D;AAChE,IAAI,uEAAuE;AAC3E,GAAG,CAAC,MAAM;AACV,IAAI,uCAAuC;AAC3C,IAAI,uEAAuE;AAC3E,GAAG,CAAC,MAAM;AACV,IAAI,yCAAyC;AAC7C,IAAI,uEAAuE;AAC3E,GAAG,CAAC,MAAM;AACV,IAAI,kBAAkB;AACtB,IAAI,wFAAwF;AAC5F,IAAI,KAAK;AACT,GAAG,CAAC,MAAM;AACV,IAAI,qCAAqC;AACzC,IAAI,sFAAsF;AAC1F,IAAI,IAAI;AACR,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,wBAAwB,EAAE,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,oDAAO,+BAAmB,KAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AACnI,EAAE,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,WAAW;AACxC,IAAI,iFAAiF;AACrF,GAAG,CAAC,cAAc;AAClB,IAAI,yBAAyB;AAC7B,IAAI,wIAAwI;AAC5I,GAAG,CAAC,cAAc;AAClB,IAAI,wCAAwC;AAC5C,IAAI,+IAA+I;AACnJ,GAAG,CAAC,cAAc;AAClB,IAAI,gCAAgC;AACpC,IAAI,iIAAiI;AACrI,GAAG,CAAC,MAAM;AACV,IAAI,sCAAsC;AAC1C,IAAI,uJAAuJ;AAC3J,IAAI,KAAK;AACT,GAAG,CAAC,MAAM;AACV,IAAI,yCAAyC;AAC7C,IAAI,qEAAqE;AACzE,GAAG,CAAC,MAAM;AACV,IAAI,uCAAuC;AAC3C,IAAI,sKAAsK;AAC1K,GAAG,CAAC,MAAM;AACV,IAAI,6BAA6B;AACjC,IAAI,yCAAyC;AAC7C,GAAG,CAAC,MAAM;AACV,IAAI,8BAA8B;AAClC,IAAI,4CAA4C;AAChD,GAAG,CAAC,MAAM,CAAC,sBAAsB,EAAE,yCAAyC,CAAC,CAAC,MAAM;AACpF,IAAI,uBAAuB;AAC3B,IAAI,6CAA6C;AACjD,GAAG,CAAC,MAAM;AACV,IAAI,8DAA8D;AAClE,IAAI,uEAAuE;AAC3E,GAAG,CAAC,MAAM;AACV,IAAI,4DAA4D;AAChE,IAAI,uEAAuE;AAC3E,GAAG,CAAC,MAAM;AACV,IAAI,uCAAuC;AAC3C,IAAI,uEAAuE;AAC3E,GAAG,CAAC,MAAM;AACV,IAAI,yCAAyC;AAC7C,IAAI,uEAAuE;AAC3E,GAAG,CAAC,MAAM;AACV,IAAI,qBAAqB;AACzB,IAAI,+DAA+D;AACnE,GAAG,CAAC,MAAM;AACV,IAAI,oBAAoB;AACxB,IAAI,6DAA6D;AACjE,IAAI,SAAS;AACb,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,oDAAO,+BAAmB,KAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAC3E,EAAE,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,WAAW,CAAC,2DAA2D,CAAC,CAAC,MAAM;AACjH,IAAI,mCAAmC;AACvC,IAAI,oCAAoC;AACxC,IAAI,kBAAkB;AACtB,GAAG,CAAC,MAAM;AACV,IAAI,yCAAyC;AAC7C,IAAI,+BAA+B;AACnC,GAAG,CAAC,MAAM;AACV,IAAI,oCAAoC;AACxC,IAAI,+HAA+H;AACnI,GAAG,CAAC,MAAM;AACV,IAAI,aAAa;AACjB,IAAI,oEAAoE;AACxE,GAAG,CAAC,MAAM,CAAC,mBAAmB,EAAE,qCAAqC,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,cAAc,EAAE,wBAAwB,EAAE,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,oDAAO,8BAAgB,KAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAC3M,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,WAAW;AACtC,IAAI,2EAA2E;AAC/E,GAAG,CAAC,MAAM;AACV,IAAI,mCAAmC;AACvC,IAAI,oCAAoC;AACxC,IAAI,kBAAkB;AACtB,GAAG,CAAC,MAAM;AACV,IAAI,yCAAyC;AAC7C,IAAI,+BAA+B;AACnC,GAAG,CAAC,MAAM;AACV,IAAI,oCAAoC;AACxC,IAAI,+HAA+H;AACnI,GAAG,CAAC,MAAM;AACV,IAAI,aAAa;AACjB,IAAI,uEAAuE;AAC3E,GAAG,CAAC,MAAM,CAAC,sBAAsB,EAAE,+BAA+B,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,cAAc,EAAE,wBAAwB,EAAE,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,oDAAO,6BAAe,KAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AACvM,CAAC;AACD,SAAS,IAAI,CAAC,aAAa,EAAE;AAC7B,EAAE,OAAO,OAAO,GAAG,IAAI,KAAK;AAC5B,IAAI,IAAI;AACR,MAAM,MAAM,UAAU,GAAG,MAAM,aAAa,EAAE,CAAC;AAC/C,MAAM,MAAM,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;AAChC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACtB,KAAK,CAAC,OAAO,KAAK,EAAE;AACpB,MAAM,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AACnC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACtB,KAAK;AACL,GAAG,CAAC;AACJ;;;;ACzKA,MAAM,IAAI,GAAG,CAAC,IAAI,KAAK;AACvB,EAAEC,iBAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AAChD,EAAE,gBAAgB,CAACA,iBAAO,CAAC,CAAC;AAC5B,EAAEA,iBAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACtB,CAAC,CAAC;AACF,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;;"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@techdocs/cli",
   "description": "Utility CLI for managing TechDocs sites in Backstage.",
-  "version": "1.1.4-next.1",
+  "version": "1.2.0-next.2",
   "private": false,
   "publishConfig": {
     "access": "public"
@@ -37,7 +37,7 @@
     "techdocs-cli": "bin/techdocs-cli"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.18.1-next.0",
+    "@backstage/cli": "^0.18.1-next.1",
     "@types/commander": "^2.12.2",
     "@types/fs-extra": "^9.0.6",
     "@types/http-proxy": "^1.17.4",
@@ -49,7 +49,7 @@
     "cypress-plugin-snapshots": "^1.4.4",
     "find-process": "^1.4.5",
     "nodemon": "^2.0.2",
-    "techdocs-cli-embedded-app": "^0.2.73-next.0",
+    "techdocs-cli-embedded-app": "^0.2.73-next.1",
     "ts-node": "^10.0.0"
   },
   "files": [
@@ -62,7 +62,7 @@
     "ext": "ts"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.15.0-next.1",
+    "@backstage/backend-common": "^0.15.0-next.2",
     "@backstage/catalog-model": "^1.1.0",
     "@backstage/cli-common": "^0.1.9",
     "@backstage/config": "^1.0.1",
@@ -76,5 +76,5 @@
     "serve-handler": "^6.1.3",
     "winston": "^3.2.1"
   },
-  "gitHead": "62bee85ae500414d27d7828288786de8f4816ef8"
+  "gitHead": "9b7d23351cdbe29fb16060f6f9e8442932d3fa29"
 }

package/dist/cjs/mkdocsServer-f7081578.cjs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"mkdocsServer-f7081578.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;AACjB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,KAAK;AACvC,QAAQ,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3C,QAAQ,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC3C,OAAO,CAAC;AACR,KAAK,CAAC;AACN,GAAG,CAAC,CAAC;AACL,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AAC9B;;AClDY,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;AACpB,MAAM,QAAQ;AACd,MAAM;AACN,QAAQ,KAAK;AACb,QAAQ,MAAM;AACd,QAAQ,IAAI;AACZ,QAAQ,UAAU;AAClB,QAAQ,IAAI;AACZ,QAAQ,CAAC,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC;AACnC,QAAQ,IAAI;AACZ,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;AACzB,QAAQ,KAAK;AACb,QAAQ,GAAG,OAAO,CAAC,gBAAgB,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,EAAE;AACrF,QAAQ,WAAW;AACnB,QAAQ,OAAO;AACf,QAAQ,YAAY;AACpB,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AACzB,OAAO;AACP,MAAM;AACN,QAAQ,aAAa,EAAE,OAAO,CAAC,aAAa;AAC5C,QAAQ,aAAa,EAAE,OAAO,CAAC,aAAa;AAC5C,OAAO;AACP,KAAK,CAAC;AACN,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;;;;;"}