generator-verdaccio-plugin 7.0.2 → 7.1.0

package/generators/app/index.js

@@ -1,9 +1,16 @@
+// sort-imports-ignore
 import chalk from 'chalk';
 import _ from 'lodash';
 import { resolve } from 'node:path';
 import Generator from 'yeoman-generator';
 import yosay from 'yosay';
 import rootPackageJSON from '../../package.json' with { type: 'json' };
+const pluginCategoryMap = {
+    auth: 'authentication',
+    storage: 'storage',
+    middleware: 'middleware',
+    filter: 'filter',
+};
 export default class PluginGenerator extends Generator {
     props = {};
     projectName = 'verdaccio-';
@@ -109,6 +116,11 @@ export default class PluginGenerator extends Generator {
         if (pluginType === 'middleware') {
             pkg.dependencies['express'] = rootPackageJSON.dependencies['express'];
         }
+        // plugin-verifier
+        pkg.devDependencies['@verdaccio/plugin-verifier'] =
+            rootPackageJSON.devDependencies['@verdaccio/plugin-verifier'];
+        const category = pluginCategoryMap[pluginType];
+        pkg.scripts['verify'] = `verdaccio-plugin-verifier ${this.projectName} --category ${category}`;
         this.fs.writeJSON(this.templatePath(`${pluginType}/_package.json`), pkg);
         this.fs.copyTpl(this.templatePath(`${pluginType}/_package.json`), this.destinationPath(resolve(this.destinationPathName, 'package.json')), this.props);
     }
@@ -117,7 +129,7 @@ export default class PluginGenerator extends Generator {
         this.fs.copy(this.templatePath('common/gitignore'), dest('.gitignore'));
         this.fs.copy(this.templatePath('common/npmignore'), dest('.npmignore'));
         this.fs.copy(this.templatePath('common/nvmrc'), dest('.nvmrc'));
-        this.fs.copyTpl(this.templatePath('common/README.md'), dest('README.md'), this.props);
+        this.fs.copyTpl(this.templatePath(`${this.props.pluginType}/README.md`), dest('README.md'), this.props);
         this.fs.copy(this.templatePath(`${this.props.pluginType}/src`), dest('src'));
         // this.fs.copy(this.templatePath('common/index.ts'), dest('index.ts'));
         this.fs.copy(this.templatePath('common/tsconfig.json'), dest('tsconfig.json'));

package/generators/app/templates/auth/README.md

@@ -0,0 +1,36 @@
+# <%= name %>
+
+<%- (description || '').split('\n').map(function (line) {
+return '> ' + line
+}).join('\n') %>
+
+---
+
+## Usage
+
+Add the plugin to your Verdaccio configuration file (`config.yaml`):
+
+```yaml
+auth:
+  <%= name %>:
+    enabled: true
+```
+
+## Development
+
+See the [verdaccio contributing guide](https://github.com/verdaccio/verdaccio/blob/master/CONTRIBUTING.md) for instructions setting up your development environment.
+Once you have completed that, use the following npm tasks.
+
+- `npm run build`
+
+  Build a distributable archive
+
+- `npm run test`
+
+  Run unit test
+
+- `npm run verify`
+
+  Verify the plugin can be loaded by Verdaccio. This runs [`@verdaccio/plugin-verifier`](https://www.npmjs.com/package/@verdaccio/plugin-verifier) which checks that the plugin exports the correct interface and can be instantiated as an **authentication** plugin.
+
+For more information about any of these commands run `npm run ${task} -- --help`.

package/generators/app/templates/auth/_package.json

@@ -13,6 +13,7 @@
     "debug": "4.4.3"
   },
   "devDependencies": {
+    "@verdaccio/plugin-verifier": "1.0.0-next-9.1",
     "@types/node": "25.0.9",
     "@types/express": "4.17.25",
     "@types/debug": "4.1.12",
@@ -29,6 +30,7 @@
   "author": "<%= authorName %> <<%= authorEmail %>>",
   "scripts": {
     "build": "tsc",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "verify": "verdaccio-plugin-verifier verdaccio-my-plugin --category authentication"
   }
 }

package/generators/app/templates/filter/README.md

@@ -0,0 +1,36 @@
+# <%= name %>
+
+<%- (description || '').split('\n').map(function (line) {
+return '> ' + line
+}).join('\n') %>
+
+---
+
+## Usage
+
+Add the plugin to your Verdaccio configuration file (`config.yaml`):
+
+```yaml
+filters:
+  <%= name %>:
+    enabled: true
+```
+
+## Development
+
+See the [verdaccio contributing guide](https://github.com/verdaccio/verdaccio/blob/master/CONTRIBUTING.md) for instructions setting up your development environment.
+Once you have completed that, use the following npm tasks.
+
+- `npm run build`
+
+  Build a distributable archive
+
+- `npm run test`
+
+  Run unit test
+
+- `npm run verify`
+
+  Verify the plugin can be loaded by Verdaccio. This runs [`@verdaccio/plugin-verifier`](https://www.npmjs.com/package/@verdaccio/plugin-verifier) which checks that the plugin exports the correct interface and can be instantiated as a **filter** plugin.
+
+For more information about any of these commands run `npm run ${task} -- --help`.

package/generators/app/templates/filter/_package.json

@@ -13,6 +13,7 @@
     "debug": "4.4.3"
   },
   "devDependencies": {
+    "@verdaccio/plugin-verifier": "1.0.0-next-9.1",
     "@types/node": "25.0.9",
     "@types/express": "4.17.25",
     "@types/debug": "4.1.12",
@@ -28,6 +29,7 @@
   "author": "<%= authorName %> <<%= authorEmail %>>",
   "scripts": {
     "build": "tsc",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "verify": "verdaccio-plugin-verifier verdaccio-my-plugin --category filter"
   }
 }

package/generators/app/templates/middleware/README.md

@@ -0,0 +1,36 @@
+# <%= name %>
+
+<%- (description || '').split('\n').map(function (line) {
+return '> ' + line
+}).join('\n') %>
+
+---
+
+## Usage
+
+Add the plugin to your Verdaccio configuration file (`config.yaml`):
+
+```yaml
+middlewares:
+  <%= name %>:
+    enabled: true
+```
+
+## Development
+
+See the [verdaccio contributing guide](https://github.com/verdaccio/verdaccio/blob/master/CONTRIBUTING.md) for instructions setting up your development environment.
+Once you have completed that, use the following npm tasks.
+
+- `npm run build`
+
+  Build a distributable archive
+
+- `npm run test`
+
+  Run unit test
+
+- `npm run verify`
+
+  Verify the plugin can be loaded by Verdaccio. This runs [`@verdaccio/plugin-verifier`](https://www.npmjs.com/package/@verdaccio/plugin-verifier) which checks that the plugin exports the correct interface and can be instantiated as a **middleware** plugin.
+
+For more information about any of these commands run `npm run ${task} -- --help`.

package/generators/app/templates/middleware/_package.json

@@ -13,6 +13,7 @@
     "debug": "4.4.3"
   },
   "devDependencies": {
+    "@verdaccio/plugin-verifier": "1.0.0-next-9.1",
     "@types/node": "25.0.9",
     "@types/express": "4.17.25",
     "@types/debug": "4.1.12",
@@ -29,6 +30,7 @@
   "author": "<%= authorName %> <<%= authorEmail %>>",
   "scripts": {
     "build": "tsc",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "verify": "verdaccio-plugin-verifier verdaccio-my-plugin --category middleware"
   }
 }

package/generators/app/templates/storage/README.md

@@ -0,0 +1,36 @@
+# <%= name %>
+
+<%- (description || '').split('\n').map(function (line) {
+return '> ' + line
+}).join('\n') %>
+
+---
+
+## Usage
+
+Add the plugin to your Verdaccio configuration file (`config.yaml`):
+
+```yaml
+store:
+  <%= name %>:
+    enabled: true
+```
+
+## Development
+
+See the [verdaccio contributing guide](https://github.com/verdaccio/verdaccio/blob/master/CONTRIBUTING.md) for instructions setting up your development environment.
+Once you have completed that, use the following npm tasks.
+
+- `npm run build`
+
+  Build a distributable archive
+
+- `npm run test`
+
+  Run unit test
+
+- `npm run verify`
+
+  Verify the plugin can be loaded by Verdaccio. This runs [`@verdaccio/plugin-verifier`](https://www.npmjs.com/package/@verdaccio/plugin-verifier) which checks that the plugin exports the correct interface and can be instantiated as a **storage** plugin.
+
+For more information about any of these commands run `npm run ${task} -- --help`.

package/generators/app/templates/storage/_package.json

@@ -14,6 +14,7 @@
     "debug": "4.4.3"
   },
   "devDependencies": {
+    "@verdaccio/plugin-verifier": "1.0.0-next-9.1",
     "@types/node": "25.0.9",
     "@types/express": "4.17.25",
     "@types/debug": "4.1.12",
@@ -29,6 +30,7 @@
   "author": "<%= authorName %> <<%= authorEmail %>>",
   "scripts": {
     "build": "tsc",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "verify": "verdaccio-plugin-verifier verdaccio-my-plugin --category storage"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generator-verdaccio-plugin",
-  "version": "7.0.2",
+  "version": "7.1.0",
   "description": "plugin generator for verdaccio",
   "homepage": "https://github.com/verdaccio",
   "author": {
@@ -50,6 +50,7 @@
     "typescript": "5.9.3",
     "vitepress": "1.6.4",
     "vitest": "4.0.18",
+    "@verdaccio/plugin-verifier": "1.0.0-next-9.1",
     "yeoman-test": "11.2.0"
   },
   "engines": {