RBAC Generator CLI

rbac-generator est une CLI Node.js qui genere un squelette RBAC frontend/backend a partir d'un modele declaratif defini dans access-model.config.mjs.

Installation

Installation globale recommandee pour la commande de creation de projet :

npm install -g rbac-generator

Ou comme dependance de developpement dans un projet existant :

npm install -D rbac-generator

Ou sans installation globale :

npx rbac-generator generate

Quick Start

1. Initialisez un projet RBAC minimal
2. Completez access-model.config.mjs
3. Lancez la generation

npx rbac-generator init mon-projet

Puis :

cd mon-projet
npx rbac-generator generate

Exemple de configuration

export default {
  appName: "SimpleApp",
  chemins: {
    backend: "backend",
    frontend: "frontend",
  },
  roles: {
    ETUDIANT: {
      label: "Etudiant",
      dbRole: "app_student",
      defaultFrontendRoute: "/student",
    },
    ENSEIGNANT: {
      label: "Enseignant",
      dbRole: "app_teacher",
      defaultFrontendRoute: "/teacher",
    },
  },
  frontend: {
    publicRoutes: ["/login"],
    routeRules: [
      {
        key: "studentHome",
        path: "/student",
        match: "prefix",
        allow: ["ETUDIANT"],
        description: "Espace etudiant",
      },
      {
        key: "teacherHome",
        path: "/teacher",
        match: "prefix",
        allow: ["ENSEIGNANT"],
        description: "Espace enseignant",
      },
    ],
  },
  backend: {
    resources: [
      {
        key: "grades",
        basePath: "/grades",
        description: "Gestion des notes",
        operations: [
          {
            key: "list",
            method: "get",
            path: "/",
            allow: ["ENSEIGNANT"],
            description: "Lister les notes",
          },
          {
            key: "readOwn",
            method: "get",
            path: "/me",
            allow: ["ETUDIANT"],
            description: "Lire ses propres notes",
          },
        ],
      },
    ],
  },
};

Commandes

Initialiser un projet RBAC avec un package.json minimal et un access-model.config.mjs :

rbac-generator init mon-projet

Cette commande cree implicitement la base du projet, comme un npm init non interactif, avec un package.json minimal adapte au generateur RBAC.

Alias court :

rbac-generator i mon-projet

Generer les fichiers :

rbac-generator generate

Si access-model.config.mjs n'existe pas encore, la commande cree automatiquement un fichier de configuration minimal. Completez-le puis relancez generate.

Verifier si les fichiers generes sont a jour :

rbac-generator generate --check

Voir les changements sans ecrire sur disque :

rbac-generator generate --dry-run

Supprimer les fichiers generes :

rbac-generator clean

Voir ce qui serait supprime :

rbac-generator clean --dry-run

Options

Par defaut, la CLI lit access-model.config.mjs dans le repertoire courant.

Vous pouvez cibler un autre projet ou un autre fichier de configuration :

rbac-generator generate --cwd ./mon-projet --config ./config/access-model.config.mjs

Vous pouvez aussi initialiser un autre dossier projet :

rbac-generator init --cwd ./mon-projet

Ou bien fournir directement le nom du projet :

rbac-generator init mon-projet

Fichiers generes

La CLI genere notamment :

• access-scaffold.generated.md
• backend/access/generated/rbac.generated.js
• backend/scaffold/generated/...
• frontend/lib/access.generated.ts
• frontend/scaffold/generated/...

Les chemins backend/frontend dependent des valeurs definies dans chemins.

Lors de l'initialisation, la CLI peut aussi creer :

• package.json
• access-model.config.mjs
• le dossier du projet cible s'il n'existe pas encore

Cas d'usage

Cette CLI est utile si vous voulez :

• centraliser les roles et permissions dans un seul modele
• generer une base coherente pour le backend et le frontend
• eviter les ecarts entre permissions backend et affichage frontend
• accelerer le scaffolding d'un systeme RBAC

Notes

• Le fichier de configuration doit exporter un objet par defaut
• Les roles references dans les routes et permissions doivent exister
• Chaque role doit avoir une route frontend par defaut protegee par une regle compatible
• init et i creent une base minimale pour commencer rapidement
• init se comporte comme un bootstrap de projet et initialise implicitement le package.json
• generate peut creer automatiquement la configuration si elle n'existe pas encore