paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: update ConfigSources options to match process.env typings

Browse Source 
Signed-off-by: Tim Klever <tim.v.klever@aexp.com>
This commit is contained in:
Tim Klever
2024-06-29 11:29:38 -07:00
parent a293a26991
commit 1edd6c27ee
3 changed files with 30 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/neat-bears-divide.md
+28
View File
@@ -0,0 +1,28 @@
---
'@backstage/config-loader': major
---
**BREAKING** The `env` property on the `ConfigSourcesDefaultOptions` interface allows for undefined members.
This change makes `ConfigSourcesDefaultOptions.env` consistent with other parts of this package and the wider
`node` ecosystem. Specifically, with this update `ConfigSourcesDefaultOptions.env`'s types match:
#### EnvConfigSource
- [`EnvConfigSource.constructor`](https://github.com/backstage/backstage/blob/c780320418b7775f18fc0d2cc279ee7db9c7cb25/packages/config-loader/src/sources/EnvConfigSource.ts#L68)
- [`EnvConfigSourceOptions`](https://github.com/backstage/backstage/blob/c780320418b7775f18fc0d2cc279ee7db9c7cb25/packages/config-loader/src/sources/EnvConfigSource.ts#L31)
- [`readEnvConfig`](https://github.com/backstage/backstage/blob/c780320418b7775f18fc0d2cc279ee7db9c7cb25/packages/config-loader/src/sources/EnvConfigSource.ts#L114)
#### NodeJS process.env
- [`ProcessEnv`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/aa121ee3a7a3caa16433b66c1103df5904f612ea/types/node/v18/process.d.ts#L137)
which extends [`Dict`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/aa121ee3a7a3caa16433b66c1103df5904f612ea/types/node/v18/globals.d.ts#L333-L335)
While this is a somewhat trivial change, it does loosen typings on a public interface, so by definition it's a breaking
change and a major version bump.
You may meed to update your backstage instance if you have built an implementation of `ConfigSources` or any other
functionality that relies on `ConfigSourcesDefaultOptions`. This change means you'll have to update that code to account
for the possibility of `undefined` values inside `ConfigSourcesDefaultOptions.env`, although it is very likely already
accounted for as the typings for [`process.env`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/aa121ee3a7a3caa16433b66c1103df5904f612ea/types/node/v18/process.d.ts#L137)
already include the possibility of [`undefined`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/aa121ee3a7a3caa16433b66c1103df5904f612ea/types/node/v18/globals.d.ts#L333-L335).
packages/config-loader/api-report.md
+1 -1
View File
@@ -87,7 +87,7 @@ export interface ConfigSourcesDefaultOptions extends BaseConfigSourcesOptions {
// (undocumented)
argv?: string[];
// (undocumented)
env?: Record<string, string>;
env?: Record<string, string | undefined>;
}
// @public
packages/config-loader/src/sources/ConfigSources.ts
+1 -1
View File
@@ -102,7 +102,7 @@ export interface ConfigSourcesDefaultForTargetsOptions
*/
export interface ConfigSourcesDefaultOptions extends BaseConfigSourcesOptions {
argv?: string[];
env?: Record<string, string>;
env?: Record<string, string | undefined>;
}
/**