Verdaccio

Verdaccio

  • Docs
  • Blog
  • Twitter
  • Help
  • GitHub
  • Contributors
  • Sponsor Us
  • Languages iconFrançais
    • English
    • Español
    • 中文
    • Russian
    • Yoruba
    • Aidez à traduire

›Dev Guides

Introduction

  • C'est quoi Verdaccio?
  • Installation
  • Outil de ligne de commande
  • Using a private registry
  • Who is using Verdaccio?
  • Security Policy
  • Logotype
  • Uses Cases

    • End to End testing
    • Caching strategies
    • GitHub Actions
    • Linking a Remote Registry

    Talks & Articles

    • Articles
    • Talks

Features

  • Fichier de configuration
  • Uplinks
  • Paquet d'accès
  • Authentication
  • Notifications
  • Enregistreur
  • Interface d'Utilisateur Web

Server

  • Configuration du serveur
  • Configuration du proxy inverse
  • Configurez les Certificats SSL
  • Installation en tant que service Windows
  • Installation sur le serveur IIS

Development

  • Plugins
  • Développement des Plugins
  • Dev Guides

    • Plugin Generator
    • Plugin d’authentification
    • Plugin Middleware
    • Plugin de stockage
  • Node API

DevOps

  • Docker
  • Kubernetes
  • Intégration Continue
  • Cloud

    • Amazon Web Services

    Tools

    • Ansible
    • Puppet
    • Chef Cookbook

Guides

  • Best Practices
  • Protection des paquets
  • Amazon Web Services
Translate

Plugin Generator

Installing the Yeoman Generator

Verdaccio is a pluggable application, with the objective to help developers to generate new plugins, we have a custom generator based in Yeoman for generate all sort of plugins.

To install the generator, as first step you must install the yeoman command yo.

npm install -g yo

then, install the custom generator running the following in your terminal.

npm i -g generator-verdaccio-plugin

Using the generator

Use yeoman is quite straighforward, you can read more infomation about it here.

After a success install, run yo verdaccio-plugin in your terminal and follow the steps.

➜ yo verdaccio-plugin

Just found a `.yo-rc.json` in a parent directory.
Setting the project root at: /Users/user/verdaccio_yo_generator

     _-----_     ╭──────────────────────────╮
    |       |    │        Welcome to        │
    |--(o)--|    │ generator-verdaccio-plug │
   `---------´   │   in plugin generator!   │
    ( _´U`_ )    ╰──────────────────────────╯
    /___A___\   /
     |  ~  |
   __'.___.'__
 ´   `  |° ´ Y `

? What is the name of your plugin? (customname)

Best practices

  • We recommend using Typescript for developing new plugins, we provide an extense support of Types which help you along the development.
? What is the name of your plugin? my-plugin
? Select Language (Use arrow keys)
❯ typescript
  javascript
  • On describe your plugin, be brief and explicit, remember a good description will increase your chances your pluing to be used.
? Please, describe your plugin (An amazing verdaccio plugin)
  • Don't hesitate to include meaningful keywords, as verdaccio, plugin or your plugin type. Good keywords will help us to find you and future improvement in our collect information about all plugins.
? Key your keywords (comma to split) verdaccio,plugin,storage,minio,verdaccio-plugin
  • Keep your generator updated, don't miss any bug-fixes and performance improvements.

Contributing

Help us to improve the generator, you can contribute in the following repository.

https://github.com/verdaccio/generator-verdaccio-plugin

← Développement des PluginsPlugin d’authentification →
  • Installing the Yeoman Generator
  • Using the generator
    • Best practices
    • Contributing
Verdaccio
Docs
Getting StartedDockerConfigurationLogos
Community
User ShowcaseStack OverflowProject ChatFollow Verdaccio on Twitter
More
BlogGitHubStar