@midgar/midgar

En développement ne pas utiliser en production

Midgar

Qu'est ce que Midgar

Midgar est un framework nodejs utilisant le pattern Model View-Controller Service (MVCS). Il se base sur un système de plugin pour permetre de réaliser rapidement des applications web complexes de manière claire et structuré.

npm

Installation

$ npm install -g @midgar/midgar

Utilisation

Le moyen le plus rapide de démarrer avec Midgar est d'utiliser le CLI pour générer la structure d'un projet.

$ midgar init ~/my-project/
$ cd ~/my-project/
$ npm i

En soit Midgar ne fait que charger des plugins, sans plugin, il ne fait donc rien de concret ! L'étape suivante est donc d'installer des plugins. L'installation des plugins se fait via npm ou yarn. L'utilisation des scripts de npm permet l'activation automatique des plugins sur le projet.

Vous pouvez voir la structure du project générer par la commande init ici.

Documentation

documentation Api.

Plugins officiel

Nom	Description
service	Système de services avec injection de dépendances.
express	Service Express.
controller	Système de controller avec injection de service pour la gestion des routes d'express.
migrate	Service de migration
mongo	Service Mongoose avec chargement des models et migrations.
apollo-server	Service Apollo server avec chargement des schémas et resolvers. Resolvers avec injection de service.

Cli

Voici les commandes de base du cli

init:

$ midgar run init ./mon-project

Initialise un nouveau projet midgar.

add:

$ midgar add monplugin

Ajoute un plugin au fichier plugins.json contenu dans le dossier de configuration du projet.

rm:

$ midgar rm @migar/service

Supprime le plugin @migar/service du fichier plugins.json.

enable:

$ midgar enable @migar/service

Active un plugin présent dans le fichier plugins.json. Si le plugin n'est pas présen, il n'est pas ajouté et un avertisement est affiché.

disable:

$ midgar disable @migar/service

Désactive le plugin @migar/service dans le fichier plugins.json. Si le plugin n'est pas présent, il n'est pas ajouté et un avertisement est affiché.

Paramètre optionnel:

$ midgar add @migar/service --config ~/mon-projet/src/config

Vous pouvez ajouter le chemin de la configuration du projet au cli. Par defaut, le cli cherche un fichier .midrc contenant le chemin de la configuration. S'il ne trouve pas ce fichier il cherche dans ./config.

Vous pouvez voir un exemple de fichier .midrc ici

Créer un plugin

Fichier plugin

Voici un exemple de fichier plugin:

import { Plugin } from '@midgar/midgar'

/**
 * TestPlugin
 */
class TestPlugin extends Plugin {
  init () {
    // Listen @midgar/midgar:afterInit event
    this.mid.on('@midgar/midgar:afterLoadPlugins', async () => {
      // Ceci est exécuté une fois que tous les plugins ont été chargés
    })
  }
}

export default TestPlugin

Vous pouvez retouver la liste des évènements dans la documentation.

Package npm

Un plugin est en premier lieu un package npm et doit etre forcement accompagné d'un fichier package.json. Le main du package.json doit pointer sur le fichier plugin.

Pour fonctionner il doit aussi etre déclarré dans le fichier plugins.json contenu dans le dossier de configuration du projet. Les scripts postinstall et preuninstall peuvent être utiliser pour ajouter/supprimer automatiquement les plugins du fichier plugins.json.

Configuration du plugin

Vous pouvez ajouter un fichier plugin-config.js dans le même dossier que le fichier plugin.

Ce fichier est charger avant le chargement des plugins et est injecté dans le membre .config de l'instance du plugin.

Importer

Le système de plugin comprend un importer de fichier. Vous pouvez déclarrer un nouveau dossier a importer dans la methode init de votre plugin:

this.pm.addPluginDir('mon-dossier', 'mondossier')

@see: https://midgarjs.github.io/midgar/PluginManager.html#addPluginDir__anchor

Pour importer les fichiers contenu de ce dossier:

const files = await this.mid.pm.importDir('mon-dossier')

@see: https://midgarjs.github.io/midgar/PluginManager.html#importDir__anchor

La méthode importDir importe tous les fichiers du dossier mon-dossier pour tous les plugins. Le chemin du dossier mon-dossier est par défaut ./mondossier/ relativement par rapport au dossier du fichier plugin.

La méthode importDir renvoit un tableau d'object:

[
  {
    path: '~/mon-projet/src/plugins/test-plugin/mondossier/fichier.js',
    export: ... // La valeur export default du fichier
    plugin: 'test-plugin',
    relativePath: 'fichier.js'
  },
  ...
}

Le chemin du dossier mon-dossier peut etre configurer pour chaque plugin dans le fichier plugin-config.js:

export default {
{
  dirs: {
      'mon-dossier': 'monnouveaudossier',
  }
}

Réecriture

Si un plugin ne fait pas axactement ce dont vous avez besoin ou si vous voulez enrichir les fonctionnalitées d'un plugin, vous pouvez utiliser le système de réecture. Le fichier plugin ainsi que les fichiers importer via le système de dossier sont réecrivable.

Plugin

Pour réecrire un fichier plugin, ajouter ceci dans le fichier plugin-config.js.

export default {
    rewritePlugin: '@midgar/service',
  }
}

Lors du chargement des plugins, ce plugin sera chargé à la place du plugin @midgar/service.

Le plugin devrait ressember à ceci:

import ServicePlugin from '@midgar/service'

class RewritePlugin extends ServicePlugin {
  async init () {
    await super.init()
    ....
  }
}

export default RewritePlugin

Fichier

Pour réecrir un fichier import via le système de dossier, ajouter ceci dans le fichier plugin-config.js.

export default {
  rewriteFile: {
    "midgar-mongoose-models": {
      "@midgar/graphql-auth": {
        'user.js': './rewrite/models/user.js'
      }
    }
  }
}

Lors de l'import des fichers, le fichier ./rewrite/models/user.js sera chargé à la place du fichier user.js contenu dans le dossier midgar-mongoose-models et pour le plugin @midgar/graphql-auth