@backstage/cli-module-config 0.1.4-next.1 → 0.1.5

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @backstage/cli-module-config
 
+## 0.1.5
+
+### Patch Changes
+
+- 60d2b50: The `--strict` flag for `config:check` now treats TypeScript configuration schema errors as fatal. The same flag is now also available for `config:schema`.
+- Updated dependencies
+  - @backstage/config-loader@1.11.1
+
+## 0.1.4
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/config-loader@1.11.0
+  - @backstage/cli-common@0.3.0
+  - @backstage/cli-node@0.3.4
+
 ## 0.1.4-next.1
 
 ### Patch Changes

package/dist/commands/schema.cjs.js

@@ -9,7 +9,7 @@ var configLoader = require('@backstage/config-loader');
 
 var schema = async ({ args, info }) => {
   const {
-    flags: { merge, format, package: pkg }
+    flags: { merge, format, package: pkg, strict }
   } = cleye.cli(
     {
       name: info.usage,
@@ -20,6 +20,10 @@ var schema = async ({ args, info }) => {
         merge: {
           type: Boolean,
           description: "Merge all schemas into a single schema"
+        },
+        strict: {
+          type: Boolean,
+          description: "Treat TypeScript configuration schema errors as fatal"
         }
       }
     },
@@ -29,7 +33,8 @@ var schema = async ({ args, info }) => {
   const { schema } = await config.loadCliConfig({
     args: [],
     fromPackage: pkg,
-    mockEnv: true
+    mockEnv: true,
+    strict
   });
   let configSchema;
   if (merge) {

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

@@ -1 +1 @@
-{"version":3,"file":"schema.cjs.js","sources":["../../src/commands/schema.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 { cli } from 'cleye';\nimport type { JSONSchema7 as JSONSchema } from 'json-schema';\nimport { stringify as stringifyYaml } from 'yaml';\nimport { loadCliConfig } from '../lib/config';\nimport { JsonObject } from '@backstage/types';\nimport { mergeConfigSchemas } from '@backstage/config-loader';\nimport type { CliCommandContext } from '@backstage/cli-node';\n\nexport default async ({ args, info }: CliCommandContext) => {\n  const {\n    flags: { merge, format, package: pkg },\n  } = cli(\n    {\n      name: info.usage,\n      booleanFlagNegation: true,\n      flags: {\n        package: { type: String, description: 'Package to print schema for' },\n        format: { type: String, description: 'Output format (yaml or json)' },\n        merge: {\n          type: Boolean,\n          description: 'Merge all schemas into a single schema',\n        },\n      },\n    },\n    undefined,\n    args,\n  );\n\n  const { schema } = await loadCliConfig({\n    args: [],\n    fromPackage: pkg,\n    mockEnv: true,\n  });\n\n  let configSchema: JsonObject | JSONSchema;\n  if (merge) {\n    configSchema = mergeConfigSchemas(\n      (schema.serialize().schemas as JsonObject[]).map(\n        _ => _.value as JSONSchema,\n      ),\n    );\n    configSchema.title = 'Application Configuration Schema';\n    configSchema.description =\n      'This is the schema describing the structure of the app-config.yaml configuration file.';\n  } else {\n    configSchema = schema.serialize();\n  }\n\n  if (format === 'json') {\n    process.stdout.write(`${JSON.stringify(configSchema, null, 2)}\\n`);\n  } else {\n    process.stdout.write(`${stringifyYaml(configSchema)}\\n`);\n  }\n};\n"],"names":["cli","loadCliConfig","mergeConfigSchemas","stringifyYaml"],"mappings":";;;;;;;;;AAwBA,aAAe,OAAO,EAAE,IAAA,EAAM,IAAA,EAAK,KAAyB;AAC1D,EAAA,MAAM;AAAA,IACJ,KAAA,EAAO,EAAE,KAAA,EAAO,MAAA,EAAQ,SAAS,GAAA;AAAI,GACvC,GAAIA,SAAA;AAAA,IACF;AAAA,MACE,MAAM,IAAA,CAAK,KAAA;AAAA,MACX,mBAAA,EAAqB,IAAA;AAAA,MACrB,KAAA,EAAO;AAAA,QACL,OAAA,EAAS,EAAE,IAAA,EAAM,MAAA,EAAQ,aAAa,6BAAA,EAA8B;AAAA,QACpE,MAAA,EAAQ,EAAE,IAAA,EAAM,MAAA,EAAQ,aAAa,8BAAA,EAA+B;AAAA,QACpE,KAAA,EAAO;AAAA,UACL,IAAA,EAAM,OAAA;AAAA,UACN,WAAA,EAAa;AAAA;AACf;AACF,KACF;AAAA,IACA,MAAA;AAAA,IACA;AAAA,GACF;AAEA,EAAA,MAAM,EAAE,MAAA,EAAO,GAAI,MAAMC,oBAAA,CAAc;AAAA,IACrC,MAAM,EAAC;AAAA,IACP,WAAA,EAAa,GAAA;AAAA,IACb,OAAA,EAAS;AAAA,GACV,CAAA;AAED,EAAA,IAAI,YAAA;AACJ,EAAA,IAAI,KAAA,EAAO;AACT,IAAA,YAAA,GAAeC,+BAAA;AAAA,MACZ,MAAA,CAAO,SAAA,EAAU,CAAE,OAAA,CAAyB,GAAA;AAAA,QAC3C,OAAK,CAAA,CAAE;AAAA;AACT,KACF;AACA,IAAA,YAAA,CAAa,KAAA,GAAQ,kCAAA;AACrB,IAAA,YAAA,CAAa,WAAA,GACX,wFAAA;AAAA,EACJ,CAAA,MAAO;AACL,IAAA,YAAA,GAAe,OAAO,SAAA,EAAU;AAAA,EAClC;AAEA,EAAA,IAAI,WAAW,MAAA,EAAQ;AACrB,IAAA,OAAA,CAAQ,MAAA,CAAO,MAAM,CAAA,EAAG,IAAA,CAAK,UAAU,YAAA,EAAc,IAAA,EAAM,CAAC,CAAC;AAAA,CAAI,CAAA;AAAA,EACnE,CAAA,MAAO;AACL,IAAA,OAAA,CAAQ,MAAA,CAAO,KAAA,CAAM,CAAA,EAAGC,cAAA,CAAc,YAAY,CAAC;AAAA,CAAI,CAAA;AAAA,EACzD;AACF,CAAA;;;;"}
+{"version":3,"file":"schema.cjs.js","sources":["../../src/commands/schema.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 { cli } from 'cleye';\nimport type { JSONSchema7 as JSONSchema } from 'json-schema';\nimport { stringify as stringifyYaml } from 'yaml';\nimport { loadCliConfig } from '../lib/config';\nimport { JsonObject } from '@backstage/types';\nimport { mergeConfigSchemas } from '@backstage/config-loader';\nimport type { CliCommandContext } from '@backstage/cli-node';\n\nexport default async ({ args, info }: CliCommandContext) => {\n  const {\n    flags: { merge, format, package: pkg, strict },\n  } = cli(\n    {\n      name: info.usage,\n      booleanFlagNegation: true,\n      flags: {\n        package: { type: String, description: 'Package to print schema for' },\n        format: { type: String, description: 'Output format (yaml or json)' },\n        merge: {\n          type: Boolean,\n          description: 'Merge all schemas into a single schema',\n        },\n        strict: {\n          type: Boolean,\n          description: 'Treat TypeScript configuration schema errors as fatal',\n        },\n      },\n    },\n    undefined,\n    args,\n  );\n\n  const { schema } = await loadCliConfig({\n    args: [],\n    fromPackage: pkg,\n    mockEnv: true,\n    strict,\n  });\n\n  let configSchema: JsonObject | JSONSchema;\n  if (merge) {\n    configSchema = mergeConfigSchemas(\n      (schema.serialize().schemas as JsonObject[]).map(\n        _ => _.value as JSONSchema,\n      ),\n    );\n    configSchema.title = 'Application Configuration Schema';\n    configSchema.description =\n      'This is the schema describing the structure of the app-config.yaml configuration file.';\n  } else {\n    configSchema = schema.serialize();\n  }\n\n  if (format === 'json') {\n    process.stdout.write(`${JSON.stringify(configSchema, null, 2)}\\n`);\n  } else {\n    process.stdout.write(`${stringifyYaml(configSchema)}\\n`);\n  }\n};\n"],"names":["cli","loadCliConfig","mergeConfigSchemas","stringifyYaml"],"mappings":";;;;;;;;;AAwBA,aAAe,OAAO,EAAE,IAAA,EAAM,IAAA,EAAK,KAAyB;AAC1D,EAAA,MAAM;AAAA,IACJ,OAAO,EAAE,KAAA,EAAO,MAAA,EAAQ,OAAA,EAAS,KAAK,MAAA;AAAO,GAC/C,GAAIA,SAAA;AAAA,IACF;AAAA,MACE,MAAM,IAAA,CAAK,KAAA;AAAA,MACX,mBAAA,EAAqB,IAAA;AAAA,MACrB,KAAA,EAAO;AAAA,QACL,OAAA,EAAS,EAAE,IAAA,EAAM,MAAA,EAAQ,aAAa,6BAAA,EAA8B;AAAA,QACpE,MAAA,EAAQ,EAAE,IAAA,EAAM,MAAA,EAAQ,aAAa,8BAAA,EAA+B;AAAA,QACpE,KAAA,EAAO;AAAA,UACL,IAAA,EAAM,OAAA;AAAA,UACN,WAAA,EAAa;AAAA,SACf;AAAA,QACA,MAAA,EAAQ;AAAA,UACN,IAAA,EAAM,OAAA;AAAA,UACN,WAAA,EAAa;AAAA;AACf;AACF,KACF;AAAA,IACA,MAAA;AAAA,IACA;AAAA,GACF;AAEA,EAAA,MAAM,EAAE,MAAA,EAAO,GAAI,MAAMC,oBAAA,CAAc;AAAA,IACrC,MAAM,EAAC;AAAA,IACP,WAAA,EAAa,GAAA;AAAA,IACb,OAAA,EAAS,IAAA;AAAA,IACT;AAAA,GACD,CAAA;AAED,EAAA,IAAI,YAAA;AACJ,EAAA,IAAI,KAAA,EAAO;AACT,IAAA,YAAA,GAAeC,+BAAA;AAAA,MACZ,MAAA,CAAO,SAAA,EAAU,CAAE,OAAA,CAAyB,GAAA;AAAA,QAC3C,OAAK,CAAA,CAAE;AAAA;AACT,KACF;AACA,IAAA,YAAA,CAAa,KAAA,GAAQ,kCAAA;AACrB,IAAA,YAAA,CAAa,WAAA,GACX,wFAAA;AAAA,EACJ,CAAA,MAAO;AACL,IAAA,YAAA,GAAe,OAAO,SAAA,EAAU;AAAA,EAClC;AAEA,EAAA,IAAI,WAAW,MAAA,EAAQ;AACrB,IAAA,OAAA,CAAQ,MAAA,CAAO,MAAM,CAAA,EAAG,IAAA,CAAK,UAAU,YAAA,EAAc,IAAA,EAAM,CAAC,CAAC;AAAA,CAAI,CAAA;AAAA,EACnE,CAAA,MAAO;AACL,IAAA,OAAA,CAAQ,MAAA,CAAO,KAAA,CAAM,CAAA,EAAGC,cAAA,CAAc,YAAY,CAAC;AAAA,CAAI,CAAA;AAAA,EACzD;AACF,CAAA;;;;"}

package/dist/lib/config.cjs.js

@@ -32,7 +32,8 @@ async function loadCliConfig(options) {
     dependencies: localPackageNames,
     // Include the package.json in the project root if it exists
     packagePaths: [cliCommon.targetPaths.resolveRoot("package.json")],
-    noUndeclaredProperties: options.strict
+    noUndeclaredProperties: options.strict,
+    onSchemaError: options.strict ? void 0 : (error) => console.warn(error.message)
   });
   const source = configLoader.ConfigSources.default({
     allowMissingDefaultConfig: true,

package/dist/lib/config.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.cjs.js","sources":["../../src/lib/config.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 { ConfigSources, loadConfigSchema } from '@backstage/config-loader';\nimport { AppConfig, ConfigReader } from '@backstage/config';\nimport { targetPaths } from '@backstage/cli-common';\n\nimport { getPackages } from '@manypkg/get-packages';\nimport { PackageGraph } from '@backstage/cli-node';\nimport { resolve as resolvePath } from 'node:path';\n\ntype Options = {\n  args: string[];\n  targetDir?: string;\n  fromPackage?: string;\n  mockEnv?: boolean;\n  withDeprecatedKeys?: boolean;\n  fullVisibility?: boolean;\n  strict?: boolean;\n};\n\nexport async function loadCliConfig(options: Options) {\n  const targetDir = options.targetDir ?? targetPaths.dir;\n\n  // Consider all packages in the monorepo when loading in config\n  const { packages } = await getPackages(targetDir);\n\n  let localPackageNames;\n  if (options.fromPackage) {\n    if (packages.length) {\n      const graph = PackageGraph.fromPackages(packages);\n      localPackageNames = Array.from(\n        graph.collectPackageNames([options.fromPackage], node => {\n          // Workaround for Backstage main repo only, since the CLI has some artificial devDependencies\n          if (node.name === '@backstage/cli') {\n            return undefined;\n          }\n          return node.localDependencies.keys();\n        }),\n      );\n    } else {\n      // No packages: it means that it's not a monorepo (e.g. standalone plugin)\n      localPackageNames = [options.fromPackage];\n    }\n  } else {\n    localPackageNames = packages.map(p => p.packageJson.name);\n  }\n\n  const schema = await loadConfigSchema({\n    dependencies: localPackageNames,\n    // Include the package.json in the project root if it exists\n    packagePaths: [targetPaths.resolveRoot('package.json')],\n    noUndeclaredProperties: options.strict,\n  });\n\n  const source = ConfigSources.default({\n    allowMissingDefaultConfig: true,\n    substitutionFunc: options.mockEnv\n      ? async name => process.env[name] || 'x'\n      : undefined,\n    rootDir: targetPaths.rootDir,\n    argv: options.args.flatMap(t => ['--config', resolvePath(targetDir, t)]),\n  });\n\n  const appConfigs = await new Promise<AppConfig[]>((resolve, reject) => {\n    async function readConfig() {\n      let loaded = false;\n      try {\n        const abortController = new AbortController();\n        for await (const { configs } of source.readConfigData({\n          signal: abortController.signal,\n        })) {\n          resolve(configs);\n          loaded = true;\n          abortController.abort();\n        }\n      } catch (error) {\n        if (!loaded) {\n          reject(error);\n        }\n      }\n    }\n    readConfig();\n  });\n\n  const configurationLoadedMessage = appConfigs.length\n    ? `Loaded config from ${appConfigs.map(c => c.context).join(', ')}`\n    : `No configuration files found, running without config`;\n\n  // printing to stderr to not clobber stdout in case the cli command\n  // outputs structured data (e.g. as config:schema does)\n  process.stderr.write(`${configurationLoadedMessage}\\n`);\n\n  try {\n    const frontendAppConfigs = schema.process(appConfigs, {\n      visibility: options.fullVisibility\n        ? ['frontend', 'backend', 'secret']\n        : ['frontend'],\n      withDeprecatedKeys: options.withDeprecatedKeys,\n      ignoreSchemaErrors: !options.strict,\n    });\n    const frontendConfig = ConfigReader.fromConfigs(frontendAppConfigs);\n\n    const fullConfig = ConfigReader.fromConfigs(appConfigs);\n\n    return {\n      schema,\n      appConfigs,\n      frontendConfig,\n      frontendAppConfigs,\n      fullConfig,\n    };\n  } catch (error) {\n    const maybeSchemaError = error as Error & { messages?: string[] };\n    if (maybeSchemaError.messages) {\n      const messages = maybeSchemaError.messages.join('\\n  ');\n      throw new Error(`Configuration does not match schema\\n\\n  ${messages}`);\n    }\n    throw error;\n  }\n}\n"],"names":["targetPaths","getPackages","PackageGraph","loadConfigSchema","ConfigSources","resolvePath","ConfigReader"],"mappings":";;;;;;;;;AAkCA,eAAsB,cAAc,OAAA,EAAkB;AACpD,EAAA,MAAM,SAAA,GAAY,OAAA,CAAQ,SAAA,IAAaA,qBAAA,CAAY,GAAA;AAGnD,EAAA,MAAM,EAAE,QAAA,EAAS,GAAI,MAAMC,wBAAY,SAAS,CAAA;AAEhD,EAAA,IAAI,iBAAA;AACJ,EAAA,IAAI,QAAQ,WAAA,EAAa;AACvB,IAAA,IAAI,SAAS,MAAA,EAAQ;AACnB,MAAA,MAAM,KAAA,GAAQC,oBAAA,CAAa,YAAA,CAAa,QAAQ,CAAA;AAChD,MAAA,iBAAA,GAAoB,KAAA,CAAM,IAAA;AAAA,QACxB,MAAM,mBAAA,CAAoB,CAAC,OAAA,CAAQ,WAAW,GAAG,CAAA,IAAA,KAAQ;AAEvD,UAAA,IAAI,IAAA,CAAK,SAAS,gBAAA,EAAkB;AAClC,YAAA,OAAO,MAAA;AAAA,UACT;AACA,UAAA,OAAO,IAAA,CAAK,kBAAkB,IAAA,EAAK;AAAA,QACrC,CAAC;AAAA,OACH;AAAA,IACF,CAAA,MAAO;AAEL,MAAA,iBAAA,GAAoB,CAAC,QAAQ,WAAW,CAAA;AAAA,IAC1C;AAAA,EACF,CAAA,MAAO;AACL,IAAA,iBAAA,GAAoB,QAAA,CAAS,GAAA,CAAI,CAAA,CAAA,KAAK,CAAA,CAAE,YAAY,IAAI,CAAA;AAAA,EAC1D;AAEA,EAAA,MAAM,MAAA,GAAS,MAAMC,6BAAA,CAAiB;AAAA,IACpC,YAAA,EAAc,iBAAA;AAAA;AAAA,IAEd,YAAA,EAAc,CAACH,qBAAA,CAAY,WAAA,CAAY,cAAc,CAAC,CAAA;AAAA,IACtD,wBAAwB,OAAA,CAAQ;AAAA,GACjC,CAAA;AAED,EAAA,MAAM,MAAA,GAASI,2BAAc,OAAA,CAAQ;AAAA,IACnC,yBAAA,EAA2B,IAAA;AAAA,IAC3B,gBAAA,EAAkB,QAAQ,OAAA,GACtB,OAAM,SAAQ,OAAA,CAAQ,GAAA,CAAI,IAAI,CAAA,IAAK,GAAA,GACnC,MAAA;AAAA,IACJ,SAASJ,qBAAA,CAAY,OAAA;AAAA,IACrB,IAAA,EAAM,OAAA,CAAQ,IAAA,CAAK,OAAA,CAAQ,CAAA,CAAA,KAAK,CAAC,UAAA,EAAYK,iBAAA,CAAY,SAAA,EAAW,CAAC,CAAC,CAAC;AAAA,GACxE,CAAA;AAED,EAAA,MAAM,aAAa,MAAM,IAAI,OAAA,CAAqB,CAAC,SAAS,MAAA,KAAW;AACrE,IAAA,eAAe,UAAA,GAAa;AAC1B,MAAA,IAAI,MAAA,GAAS,KAAA;AACb,MAAA,IAAI;AACF,QAAA,MAAM,eAAA,GAAkB,IAAI,eAAA,EAAgB;AAC5C,QAAA,WAAA,MAAiB,EAAE,OAAA,EAAQ,IAAK,MAAA,CAAO,cAAA,CAAe;AAAA,UACpD,QAAQ,eAAA,CAAgB;AAAA,SACzB,CAAA,EAAG;AACF,UAAA,OAAA,CAAQ,OAAO,CAAA;AACf,UAAA,MAAA,GAAS,IAAA;AACT,UAAA,eAAA,CAAgB,KAAA,EAAM;AAAA,QACxB;AAAA,MACF,SAAS,KAAA,EAAO;AACd,QAAA,IAAI,CAAC,MAAA,EAAQ;AACX,UAAA,MAAA,CAAO,KAAK,CAAA;AAAA,QACd;AAAA,MACF;AAAA,IACF;AACA,IAAA,UAAA,EAAW;AAAA,EACb,CAAC,CAAA;AAED,EAAA,MAAM,0BAAA,GAA6B,UAAA,CAAW,MAAA,GAC1C,CAAA,mBAAA,EAAsB,UAAA,CAAW,GAAA,CAAI,CAAA,CAAA,KAAK,CAAA,CAAE,OAAO,CAAA,CAAE,IAAA,CAAK,IAAI,CAAC,CAAA,CAAA,GAC/D,CAAA,oDAAA,CAAA;AAIJ,EAAA,OAAA,CAAQ,MAAA,CAAO,KAAA,CAAM,CAAA,EAAG,0BAA0B;AAAA,CAAI,CAAA;AAEtD,EAAA,IAAI;AACF,IAAA,MAAM,kBAAA,GAAqB,MAAA,CAAO,OAAA,CAAQ,UAAA,EAAY;AAAA,MACpD,UAAA,EAAY,QAAQ,cAAA,GAChB,CAAC,YAAY,SAAA,EAAW,QAAQ,CAAA,GAChC,CAAC,UAAU,CAAA;AAAA,MACf,oBAAoB,OAAA,CAAQ,kBAAA;AAAA,MAC5B,kBAAA,EAAoB,CAAC,OAAA,CAAQ;AAAA,KAC9B,CAAA;AACD,IAAA,MAAM,cAAA,GAAiBC,mBAAA,CAAa,WAAA,CAAY,kBAAkB,CAAA;AAElE,IAAA,MAAM,UAAA,GAAaA,mBAAA,CAAa,WAAA,CAAY,UAAU,CAAA;AAEtD,IAAA,OAAO;AAAA,MACL,MAAA;AAAA,MACA,UAAA;AAAA,MACA,cAAA;AAAA,MACA,kBAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF,SAAS,KAAA,EAAO;AACd,IAAA,MAAM,gBAAA,GAAmB,KAAA;AACzB,IAAA,IAAI,iBAAiB,QAAA,EAAU;AAC7B,MAAA,MAAM,QAAA,GAAW,gBAAA,CAAiB,QAAA,CAAS,IAAA,CAAK,MAAM,CAAA;AACtD,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA;;AAAA,EAAA,EAA4C,QAAQ,CAAA,CAAE,CAAA;AAAA,IACxE;AACA,IAAA,MAAM,KAAA;AAAA,EACR;AACF;;;;"}
+{"version":3,"file":"config.cjs.js","sources":["../../src/lib/config.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 { ConfigSources, loadConfigSchema } from '@backstage/config-loader';\nimport { AppConfig, ConfigReader } from '@backstage/config';\nimport { targetPaths } from '@backstage/cli-common';\n\nimport { getPackages } from '@manypkg/get-packages';\nimport { PackageGraph } from '@backstage/cli-node';\nimport { resolve as resolvePath } from 'node:path';\n\ntype Options = {\n  args: string[];\n  targetDir?: string;\n  fromPackage?: string;\n  mockEnv?: boolean;\n  withDeprecatedKeys?: boolean;\n  fullVisibility?: boolean;\n  strict?: boolean;\n};\n\nexport async function loadCliConfig(options: Options) {\n  const targetDir = options.targetDir ?? targetPaths.dir;\n\n  // Consider all packages in the monorepo when loading in config\n  const { packages } = await getPackages(targetDir);\n\n  let localPackageNames;\n  if (options.fromPackage) {\n    if (packages.length) {\n      const graph = PackageGraph.fromPackages(packages);\n      localPackageNames = Array.from(\n        graph.collectPackageNames([options.fromPackage], node => {\n          // Workaround for Backstage main repo only, since the CLI has some artificial devDependencies\n          if (node.name === '@backstage/cli') {\n            return undefined;\n          }\n          return node.localDependencies.keys();\n        }),\n      );\n    } else {\n      // No packages: it means that it's not a monorepo (e.g. standalone plugin)\n      localPackageNames = [options.fromPackage];\n    }\n  } else {\n    localPackageNames = packages.map(p => p.packageJson.name);\n  }\n\n  const schema = await loadConfigSchema({\n    dependencies: localPackageNames,\n    // Include the package.json in the project root if it exists\n    packagePaths: [targetPaths.resolveRoot('package.json')],\n    noUndeclaredProperties: options.strict,\n    onSchemaError: options.strict\n      ? undefined\n      : error => console.warn(error.message),\n  });\n\n  const source = ConfigSources.default({\n    allowMissingDefaultConfig: true,\n    substitutionFunc: options.mockEnv\n      ? async name => process.env[name] || 'x'\n      : undefined,\n    rootDir: targetPaths.rootDir,\n    argv: options.args.flatMap(t => ['--config', resolvePath(targetDir, t)]),\n  });\n\n  const appConfigs = await new Promise<AppConfig[]>((resolve, reject) => {\n    async function readConfig() {\n      let loaded = false;\n      try {\n        const abortController = new AbortController();\n        for await (const { configs } of source.readConfigData({\n          signal: abortController.signal,\n        })) {\n          resolve(configs);\n          loaded = true;\n          abortController.abort();\n        }\n      } catch (error) {\n        if (!loaded) {\n          reject(error);\n        }\n      }\n    }\n    readConfig();\n  });\n\n  const configurationLoadedMessage = appConfigs.length\n    ? `Loaded config from ${appConfigs.map(c => c.context).join(', ')}`\n    : `No configuration files found, running without config`;\n\n  // printing to stderr to not clobber stdout in case the cli command\n  // outputs structured data (e.g. as config:schema does)\n  process.stderr.write(`${configurationLoadedMessage}\\n`);\n\n  try {\n    const frontendAppConfigs = schema.process(appConfigs, {\n      visibility: options.fullVisibility\n        ? ['frontend', 'backend', 'secret']\n        : ['frontend'],\n      withDeprecatedKeys: options.withDeprecatedKeys,\n      ignoreSchemaErrors: !options.strict,\n    });\n    const frontendConfig = ConfigReader.fromConfigs(frontendAppConfigs);\n\n    const fullConfig = ConfigReader.fromConfigs(appConfigs);\n\n    return {\n      schema,\n      appConfigs,\n      frontendConfig,\n      frontendAppConfigs,\n      fullConfig,\n    };\n  } catch (error) {\n    const maybeSchemaError = error as Error & { messages?: string[] };\n    if (maybeSchemaError.messages) {\n      const messages = maybeSchemaError.messages.join('\\n  ');\n      throw new Error(`Configuration does not match schema\\n\\n  ${messages}`);\n    }\n    throw error;\n  }\n}\n"],"names":["targetPaths","getPackages","PackageGraph","loadConfigSchema","ConfigSources","resolvePath","ConfigReader"],"mappings":";;;;;;;;;AAkCA,eAAsB,cAAc,OAAA,EAAkB;AACpD,EAAA,MAAM,SAAA,GAAY,OAAA,CAAQ,SAAA,IAAaA,qBAAA,CAAY,GAAA;AAGnD,EAAA,MAAM,EAAE,QAAA,EAAS,GAAI,MAAMC,wBAAY,SAAS,CAAA;AAEhD,EAAA,IAAI,iBAAA;AACJ,EAAA,IAAI,QAAQ,WAAA,EAAa;AACvB,IAAA,IAAI,SAAS,MAAA,EAAQ;AACnB,MAAA,MAAM,KAAA,GAAQC,oBAAA,CAAa,YAAA,CAAa,QAAQ,CAAA;AAChD,MAAA,iBAAA,GAAoB,KAAA,CAAM,IAAA;AAAA,QACxB,MAAM,mBAAA,CAAoB,CAAC,OAAA,CAAQ,WAAW,GAAG,CAAA,IAAA,KAAQ;AAEvD,UAAA,IAAI,IAAA,CAAK,SAAS,gBAAA,EAAkB;AAClC,YAAA,OAAO,MAAA;AAAA,UACT;AACA,UAAA,OAAO,IAAA,CAAK,kBAAkB,IAAA,EAAK;AAAA,QACrC,CAAC;AAAA,OACH;AAAA,IACF,CAAA,MAAO;AAEL,MAAA,iBAAA,GAAoB,CAAC,QAAQ,WAAW,CAAA;AAAA,IAC1C;AAAA,EACF,CAAA,MAAO;AACL,IAAA,iBAAA,GAAoB,QAAA,CAAS,GAAA,CAAI,CAAA,CAAA,KAAK,CAAA,CAAE,YAAY,IAAI,CAAA;AAAA,EAC1D;AAEA,EAAA,MAAM,MAAA,GAAS,MAAMC,6BAAA,CAAiB;AAAA,IACpC,YAAA,EAAc,iBAAA;AAAA;AAAA,IAEd,YAAA,EAAc,CAACH,qBAAA,CAAY,WAAA,CAAY,cAAc,CAAC,CAAA;AAAA,IACtD,wBAAwB,OAAA,CAAQ,MAAA;AAAA,IAChC,aAAA,EAAe,QAAQ,MAAA,GACnB,MAAA,GACA,WAAS,OAAA,CAAQ,IAAA,CAAK,MAAM,OAAO;AAAA,GACxC,CAAA;AAED,EAAA,MAAM,MAAA,GAASI,2BAAc,OAAA,CAAQ;AAAA,IACnC,yBAAA,EAA2B,IAAA;AAAA,IAC3B,gBAAA,EAAkB,QAAQ,OAAA,GACtB,OAAM,SAAQ,OAAA,CAAQ,GAAA,CAAI,IAAI,CAAA,IAAK,GAAA,GACnC,MAAA;AAAA,IACJ,SAASJ,qBAAA,CAAY,OAAA;AAAA,IACrB,IAAA,EAAM,OAAA,CAAQ,IAAA,CAAK,OAAA,CAAQ,CAAA,CAAA,KAAK,CAAC,UAAA,EAAYK,iBAAA,CAAY,SAAA,EAAW,CAAC,CAAC,CAAC;AAAA,GACxE,CAAA;AAED,EAAA,MAAM,aAAa,MAAM,IAAI,OAAA,CAAqB,CAAC,SAAS,MAAA,KAAW;AACrE,IAAA,eAAe,UAAA,GAAa;AAC1B,MAAA,IAAI,MAAA,GAAS,KAAA;AACb,MAAA,IAAI;AACF,QAAA,MAAM,eAAA,GAAkB,IAAI,eAAA,EAAgB;AAC5C,QAAA,WAAA,MAAiB,EAAE,OAAA,EAAQ,IAAK,MAAA,CAAO,cAAA,CAAe;AAAA,UACpD,QAAQ,eAAA,CAAgB;AAAA,SACzB,CAAA,EAAG;AACF,UAAA,OAAA,CAAQ,OAAO,CAAA;AACf,UAAA,MAAA,GAAS,IAAA;AACT,UAAA,eAAA,CAAgB,KAAA,EAAM;AAAA,QACxB;AAAA,MACF,SAAS,KAAA,EAAO;AACd,QAAA,IAAI,CAAC,MAAA,EAAQ;AACX,UAAA,MAAA,CAAO,KAAK,CAAA;AAAA,QACd;AAAA,MACF;AAAA,IACF;AACA,IAAA,UAAA,EAAW;AAAA,EACb,CAAC,CAAA;AAED,EAAA,MAAM,0BAAA,GAA6B,UAAA,CAAW,MAAA,GAC1C,CAAA,mBAAA,EAAsB,UAAA,CAAW,GAAA,CAAI,CAAA,CAAA,KAAK,CAAA,CAAE,OAAO,CAAA,CAAE,IAAA,CAAK,IAAI,CAAC,CAAA,CAAA,GAC/D,CAAA,oDAAA,CAAA;AAIJ,EAAA,OAAA,CAAQ,MAAA,CAAO,KAAA,CAAM,CAAA,EAAG,0BAA0B;AAAA,CAAI,CAAA;AAEtD,EAAA,IAAI;AACF,IAAA,MAAM,kBAAA,GAAqB,MAAA,CAAO,OAAA,CAAQ,UAAA,EAAY;AAAA,MACpD,UAAA,EAAY,QAAQ,cAAA,GAChB,CAAC,YAAY,SAAA,EAAW,QAAQ,CAAA,GAChC,CAAC,UAAU,CAAA;AAAA,MACf,oBAAoB,OAAA,CAAQ,kBAAA;AAAA,MAC5B,kBAAA,EAAoB,CAAC,OAAA,CAAQ;AAAA,KAC9B,CAAA;AACD,IAAA,MAAM,cAAA,GAAiBC,mBAAA,CAAa,WAAA,CAAY,kBAAkB,CAAA;AAElE,IAAA,MAAM,UAAA,GAAaA,mBAAA,CAAa,WAAA,CAAY,UAAU,CAAA;AAEtD,IAAA,OAAO;AAAA,MACL,MAAA;AAAA,MACA,UAAA;AAAA,MACA,cAAA;AAAA,MACA,kBAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF,SAAS,KAAA,EAAO;AACd,IAAA,MAAM,gBAAA,GAAmB,KAAA;AACzB,IAAA,IAAI,iBAAiB,QAAA,EAAU;AAC7B,MAAA,MAAM,QAAA,GAAW,gBAAA,CAAiB,QAAA,CAAS,IAAA,CAAK,MAAM,CAAA;AACtD,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA;;AAAA,EAAA,EAA4C,QAAQ,CAAA,CAAE,CAAA;AAAA,IACxE;AACA,IAAA,MAAM,KAAA;AAAA,EACR;AACF;;;;"}

package/dist/package.json.cjs.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var name = "@backstage/cli-module-config";
-var version = "0.1.4-next.1";
+var version = "0.1.5";
 var description = "CLI module for Backstage CLI";
 var backstage = {
 	role: "cli-module"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/cli-module-config",
-  "version": "0.1.4-next.1",
+  "version": "0.1.5",
   "description": "CLI module for Backstage CLI",
   "backstage": {
     "role": "cli-module"
@@ -33,11 +33,11 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/cli-common": "0.3.0-next.0",
-    "@backstage/cli-node": "0.3.4-next.0",
-    "@backstage/config": "1.3.8",
-    "@backstage/config-loader": "1.11.0-next.2",
-    "@backstage/types": "1.2.2",
+    "@backstage/cli-common": "^0.3.0",
+    "@backstage/cli-node": "^0.3.4",
+    "@backstage/config": "^1.3.8",
+    "@backstage/config-loader": "^1.11.1",
+    "@backstage/types": "^1.2.2",
     "@manypkg/get-packages": "^1.1.3",
     "chalk": "^4.0.0",
     "cleye": "^2.6.0",
@@ -45,7 +45,7 @@
     "yaml": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "0.36.4-next.2",
+    "@backstage/cli": "^0.36.4",
     "@types/json-schema": "^7.0.6"
   },
   "typesVersions": {