@backstage-community/plugin-npm-common 1.16.0 → 1.18.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @backstage-community/plugin-npm-common
 
+## 1.18.0
+
+### Minor Changes
+
+- 3f67411: Backstage version bump to v1.48.1
+
+## 1.17.0
+
+### Minor Changes
+
+- c235037: Backstage version bump to v1.47.2
+
 ## 1.16.0
 
 ### Minor Changes

package/README.md

@@ -91,6 +91,70 @@ you must install also the backend plugin and [configure it](./registries.md).
 
 ### Frontend plugin
 
+### Load plugin via the new frontend system (alpha)
+
+For early adaopters of the new frontend system.
+
+Your Backstage frontend app must use that new frontend system which isn't the default at the moment.
+
+1. Install the frontend dependency:
+
+   ```sh
+   yarn workspace app-next add @backstage-community/plugin-npm
+   ```
+
+2. Add the package to your `packages/app-next/src/App.tsx`.
+
+   ```tsx
+   import npmPlugin from '@backstage-community/plugin-npm/alpha';
+   ```
+
+   And extend your createApp:
+
+   ```tsx
+   export const app = createApp({
+     features: [
+       // ...other plugins
+       npmPlugin,
+     ],
+   });
+   ```
+
+3. Optional enable translation via the `TranslationBlueprint` extension:
+
+   ```tsx
+   import { TranslationBlueprint } from '@backstage/plugin-app-react';
+
+   import npmPlugin, {
+     npmTranslations,
+   } from '@backstage-community/plugin-npm/alpha';
+   ```
+
+   ```tsx
+   const npmTranslation = TranslationBlueprint.make({
+     name: 'npmTranslation',
+     params: {
+       resource: npmTranslations,
+     },
+   });
+
+   export default createApp({
+     features: [
+       createFrontendModule({
+         pluginId: 'app',
+         extensions: [
+           // ...other extensions
+           npmTranslation,
+         ],
+       }),
+       // ...other plugins
+       npmPlugin,
+     ],
+   });
+   ```
+
+### Manual wiring the frontend plugin ("Old Frontend System")
+
 1. Install the frontend dependency:
 
    ```sh
@@ -140,44 +204,12 @@ you must install also the backend plugin and [configure it](./registries.md).
    </EntityLayout.Route>
    ```
 
-### Alternative: Use the new frontend system (alpha)
-
-For early adaopters of the new frontend system.
-
-Your Backstage frontend app must use that new frontend system which isn't the default at the moment.
-
-1. Install the frontend dependency:
-
-   ```sh
-   yarn workspace app-next add @backstage-community/plugin-npm
-   ```
-
-2. Add the package to your `packages/app[-next]/src/App.tsx`.
-
-   ```tsx
-   import npmPlugin from '@backstage-community/plugin-npm/alpha';
-   ```
-
-   And extend your createApp:
-
-   ```tsx
-   export const app = createApp({
-     features: [
-       catalogPlugin,
-       catalogImportPlugin,
-       userSettingsPlugin,
-       npmPlugin,
-       // ...
-     ],
-   });
-   ```
-
 ### Optional: Backend plugin (req. for private packages or alternative registries)
 
 1. Install the backend plugin:
 
    ```sh
-   yarn workspace backend add @backstage-community/plugin-npm
+   yarn workspace backend add @backstage-community/plugin-npm-backend
    ```
 
 2. Add it to `packages/backend/src/index.ts`:

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage-community/plugin-npm-common",
   "description": "Common functionalities for the npm plugin",
-  "version": "1.16.0",
+  "version": "1.18.0",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -39,7 +39,7 @@
     "@backstage/errors": "^1.2.7"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.35.1"
+    "@backstage/cli": "^0.35.4"
   },
   "files": [
     "dist"