@backstage/config - npm Package Compare versions

Comparing version 0.1.12 to 0.1.13-next.0

CHANGELOG.md

 # @backstage/config
 
+## 0.1.13-next.0
+
+### Patch Changes
+
+- f685e1398f: Loading of app configurations now reference the `@deprecated` construct from
+  JSDoc to determine if a property in-use has been deprecated. Users are notified
+  of deprecated keys in the format:
+
+  ```txt
+  The configuration key 'catalog.processors.githubOrg' of app-config.yaml is deprecated and may be removed soon. Configure a GitHub integration instead.
+  ```
+
+  When the `withDeprecatedKeys` option is set to `true` in the `process` method
+  of `loadConfigSchema`, the user will be notified that deprecated keys have been
+  identified in their app configuration.
+
+  The `backend-common` and `plugin-app-backend` packages have been updated to set
+  `withDeprecatedKeys` to true so that users are notified of deprecated settings
+  by default.
+
 ## 0.1.12
@@ -4,0 +24,0 @@

dist/index.cjs.js

@@ -55,5 +55,10 @@ 'use strict';
     }
-    return configs.reduce((previousReader, { data, context, filteredKeys }) => {
+    return configs.reduce((previousReader, { data, context, filteredKeys, deprecatedKeys }) => {
       const reader = new ConfigReader(data, context, previousReader);
       reader.filteredKeys = filteredKeys;
+      if (deprecatedKeys) {
+        for (const { key, description } of deprecatedKeys) {
+          console.warn(`The configuration key '${key}' of ${context} is deprecated and may be removed soon. ${description || ""}`);
+        }
+      }
       return reader;
@@ -60,0 +65,0 @@ }, void 0);

dist/index.d.ts

@@ -52,2 +52,11 @@ import { JsonPrimitive as JsonPrimitive$1, JsonObject as JsonObject$1, JsonArray as JsonArray$1, JsonValue as JsonValue$1 } from '@backstage/types';
     filteredKeys?: string[];
+    /**
+     * A list of deprecated keys that were found in the  configuration when it was loaded.
+     *
+     * This can be used to warn the user if they are using deprecated properties.
+     */
+    deprecatedKeys?: {
+        key: string;
+        description: string;
+    }[];
 };
@@ -54,0 +63,0 @@ /**

dist/index.esm.js

@@ -46,5 +46,10 @@ import cloneDeep from 'lodash/cloneDeep';
     }
-    return configs.reduce((previousReader, { data, context, filteredKeys }) => {
+    return configs.reduce((previousReader, { data, context, filteredKeys, deprecatedKeys }) => {
       const reader = new ConfigReader(data, context, previousReader);
       reader.filteredKeys = filteredKeys;
+      if (deprecatedKeys) {
+        for (const { key, description } of deprecatedKeys) {
+          console.warn(`The configuration key '${key}' of ${context} is deprecated and may be removed soon. ${description || ""}`);
+        }
+      }
       return reader;
@@ -51,0 +56,0 @@ }, void 0);

package.json

 {
   "name": "@backstage/config",
   "description": "Config API used by Backstage core, backend, and CLI",
-  "version": "0.1.12",
+  "version": "0.1.13-next.0",
   "private": false,
@@ -37,3 +37,3 @@ "publishConfig": {
   "devDependencies": {
-    "@backstage/test-utils": "^0.2.2",
+    "@backstage/test-utils": "^0.2.3-next.0",
     "@types/jest": "^26.0.7",
@@ -45,4 +45,4 @@ "@types/node": "^14.14.32"
   ],
-  "gitHead": "da66c61bdd63cdb3f0f0cd2e26dc9e6454d93c7b",
+  "gitHead": "31184691d5a38cb78b091c8f7ad6db80604519a6",
   "module": "dist/index.esm.js"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

79452

increased by3.39%

Lines of code

729

increased by2.68%

No dependency changes