@arcpkg/initiator 0.0.1-beta.0.1

package/README.md

@@ -0,0 +1,524 @@
+# @arcpkg/initiator
+
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-007ACC)
+![React](https://img.shields.io/badge/React-18+-61DAFB)
+![React Router](https://img.shields.io/badge/React%20Router-6+-CA4245)
+
+**@arcpkg/initiator** est un plugin d'initialisation intelligent pour les applications React avec TypeScript/Javascript. Il génère automatiquement les fichiers de configuration, de routage, d'internationalisation et de providers basés sur la structure de votre projet.
+
+## ✨ Fonctionnalités Principales
+
+### 🗺️ Génération Automatique
+- **Génération automatique des routes** à partir de la structure du système de fichiers
+- **Configuration modulaire** avec détection automatique des modules
+- **Internationalisation automatisée** avec extraction des clés de traduction
+- **Providers React organisés** par module et priorité
+- **Fichiers de configuration** générés dynamiquement
+
+### ⚙️ Initialisation Intelligente
+- **Détection automatique** des fichiers de pages, modules et providers
+- **Génération de fichiers TypeScript** typesafe
+- **Support des layouts hiérarchiques** avec héritage automatique
+- **Organisation automatique des providers** (Context, Redux, Router, etc.)
+- **Configuration minimale** requise
+
+### 📁 Structure de Projet
+- **Organisation modulaire** naturelle
+- **Support des pages spéciales** (layout, error, 404)
+- **Routes dynamiques** avec paramètres
+- **Modules indépendants** avec leur propre configuration et providers
+- **Providers globaux et par module** hiérarchisés
+
+## 📦 Installation
+
+### Installation globale (recommandée)
+```bash
+npm install -g @arcpkg/initiator
+# ou
+yarn global add @arcpkg/initiator
+# ou
+pnpm add -g @arcpkg/initiator
+```
+
+### Installation locale
+```bash
+npm install @arcpkg/initiator
+# ou
+yarn add @arcpkg/initiator
+# ou
+pnpm add @arcpkg/initiator
+```
+
+## 🚀 Utilisation Rapide
+
+### Commande de base
+```bash
+# Depuis la racine de votre projet
+arc-init
+# ou
+npx @arcpkg/initiator
+```
+
+### Options disponibles
+```bash
+# Initialiser avec un répertoire spécifique
+arc-init --dir ./mon-projet
+
+# Forcer la régénération des fichiers
+arc-init --force
+
+# Mode silencieux (moins de logs)
+arc-init --quiet
+
+# Afficher l'aide
+arc-init --help
+```
+
+### Structure de projet générée
+```
+src/
+├── auto-config.ts      # Configuration générée
+├── auto-intl.ts        # Internationalisation générée
+├── auto-routes.tsx     # Routes générées
+├── auto-provider.tsx   # Providers organisés
+├── config.json         # Configuration racine
+├── locales/
+│   ├── en.json         # Traductions anglais
+│   └── fr.json         # Traductions français
+├── providers/          # Providers globaux
+│   ├── RouterProvider.tsx
+│   ├── ReduxProvider.tsx
+│   ├── ThemeProvider.tsx
+│   └── AuthProvider.tsx
+├── pages/
+│   ├── _layout.tsx     # Layout racine
+│   ├── _error.tsx      # Page d'erreur
+│   ├── _404.tsx        # Page 404
+│   └── index.tsx       # Page d'accueil
+└── modules/
+    └── example/
+        ├── config.json # Configuration du module
+        ├── locales/
+        │   ├── en.json # Traductions module
+        │   └── fr.json # Traductions module
+        ├── providers/  # Providers du module
+        │   ├── ReduxProvider.tsx
+        │   └── AuthProvider.tsx
+        └── pages/
+            └── index.tsx # Page du module
+```
+
+## 🔧 Fonctionnalités Détaillées
+
+### 1. Génération de Routes
+Le plugin scanne automatiquement vos dossiers `pages/` et `modules/*/pages/` pour :
+- **Créer des routes React Router** automatiquement
+- **Gérer les layouts hiérarchiques**
+- **Supporter les pages d'erreur spécifiques**
+- **Générer des composants lazy-loaded**
+
+### 2. Internationalisation
+Extraction automatique des clés de traduction :
+- **Scan des fichiers source** pour les appels `t()`
+- **Détection des modules** avec fichiers de traduction
+- **Génération des imports dynamiques**
+- **Support multi-langue**
+
+### 3. Configuration
+Génération centralisée de configuration :
+- **Configuration racine** depuis `config.json`
+- **Configuration des modules** depuis `modules/*/config.json`
+- **Fichier TypeScript** avec imports dynamiques
+
+### 4. Génération de Providers
+Organisation automatique des providers React :
+- **Détection automatique** des fichiers provider (`Provider.tsx`)
+- **Hiérarchisation intelligente** par priorité
+- **Organisation par module** avec encapsulation automatique
+- **Chargement lazy** avec Suspense intégré
+- **Typage TypeScript** complet
+
+## 📚 API du Plugin
+
+### Fonction principale
+```typescript
+import init from '@arcpkg/initiator';
+
+// Initialisation par défaut (utilise __dirname)
+init();
+
+// Avec répertoire personnalisé
+init('/chemin/vers/mon/projet');
+```
+
+### Classes exportées
+```typescript
+import { 
+  TranslationGenerator, 
+  RouteGenerator, 
+  ConfigGenerator,
+  ProviderGenerator 
+} from '@arcpkg/initiator';
+
+// Utilisation avancée
+const translationGen = new TranslationGenerator(config);
+const routeGen = new RouteGenerator(config);
+const configGen = new ConfigGenerator(config);
+const providerGen = new ProviderGenerator(config);
+```
+
+### Interfaces TypeScript
+```typescript
+import type {
+  TranslationConfig,
+  RouteConfig,
+  ConfigGeneratorOptions,
+  ProviderConfig,
+  TranslationKey,
+  RouteFile,
+  ProviderInfo
+} from '@arcpkg/initiator';
+```
+
+## 🎯 Exemples d'Utilisation
+
+### Exemple 1 : Script d'initialisation
+```javascript
+// scripts/init.js
+import init from '@arcpkg/initiator';
+
+// Initialiser avec le répertoire du projet
+init(process.cwd());
+
+console.log('✅ Initialisation terminée !');
+```
+
+### Exemple 2 : Personnalisation avancée
+```typescript
+// scripts/custom-init.ts
+import { ProviderGenerator } from '@arcpkg/initiator';
+
+const customConfig = {
+  srcDir: './src',
+  modulesDir: './src/modules',
+  providersDir: './src/providers',
+  globalProvidersDir: './src/global-providers', // Dossier personnalisé
+  outputFile: './src/generated/provider.tsx'
+};
+
+const generator = new ProviderGenerator(customConfig);
+await generator.generate();
+```
+
+### Exemple 3 : Intégration avec un build personnalisé
+```json
+{
+  "scripts": {
+    "dev": "vite",
+    "build": "npm run generate && vite build",
+    "generate": "node scripts/generate-all.js",
+    "generate:routes": "node scripts/generate-routes.js",
+    "generate:intl": "node scripts/generate-intl.js",
+    "generate:config": "node scripts/generate-config.js",
+    "generate:providers": "node scripts/generate-providers.js"
+  }
+}
+```
+
+## 🔧 Configuration Avancée
+
+### Configuration de la traduction
+```typescript
+const translationConfig = {
+  srcDir: './src',
+  supportedLocales: ['en', 'fr', 'es'], // Langues supportées
+  outputFile: './src/auto-intl.ts',
+  modulesDir: './src/modules',
+  localesDir: './src/locales'
+};
+```
+
+### Configuration du routage
+```typescript
+const routeConfig = {
+  srcDir: './src',
+  modulesDir: './src/modules',
+  pagesDir: './src/pages', // Ou 'views', 'screens', etc.
+  outputFile: './src/auto-routes.tsx',
+  layoutFileName: '_layout', // Fichier de layout
+  errorFileName: '_error',   // Fichier d'erreur
+  notFoundFileName: '_404'   // Fichier 404
+};
+```
+
+### Configuration des providers
+```typescript
+const providerConfig = {
+  srcDir: './src',
+  modulesDir: './src/modules',
+  providersDir: './src/providers',
+  outputFile: './src/auto-provider.tsx',
+  globalProvidersDir: './src/providers' // Dossier des providers globaux
+};
+```
+
+### Fichier config.json racine
+```json
+{
+  "name": "Mon Application",
+  "version": "1.0.0",
+  "description": "Description de l'application",
+  "author": "Votre Nom",
+  "defaultLocale": "fr",
+  "supportedLocales": ["fr", "en"],
+  "apiUrl": "https://api.example.com",
+  "features": {
+    "auth": true,
+    "analytics": false,
+    "pwa": true
+  }
+}
+```
+
+### Fichier config.json de module
+```json
+{
+  "name": "Module Admin",
+  "description": "Module d'administration",
+  "author": "Équipe Admin",
+  "version": "1.0.0",
+  "routePrefix": "/admin",
+  "isEnabled": true,
+  "dependencies": ["auth"],
+  "permissions": ["admin", "superuser"]
+}
+```
+
+## 📁 Conventions de Fichiers
+
+### Pages spéciales
+| Fichier | Description | Route générée |
+|---------|-------------|---------------|
+| `_layout.tsx` | Layout du dossier | Non accessible directement |
+| `_error.tsx` | Page d'erreur | Utilisée comme errorElement |
+| `_404.tsx` | Page non trouvée | Route catch-all |
+| `[param].tsx` | Route paramétrée | `/:param` |
+| `[...slug].tsx` | Route catch-all | `/*` |
+| `index.tsx` | Page d'index | `/` ou `/dossier/` |
+
+### Providers détectés automatiquement
+| Pattern | Type détecté | Priorité |
+|---------|-------------|----------|
+| `*Router*.tsx` | Provider Router | Haute |
+| `*Redux*.tsx` | Provider Redux | Haute |
+| `*Theme*.tsx` | Provider Theme | Moyenne |
+| `*Context*.tsx` | Provider Context | Moyenne |
+| `*Provider.tsx` | Provider générique | Basse |
+| `*Error*.tsx` | Error Boundary | Très basse |
+
+### Structure de module
+```
+modules/
+└── nom-du-module/
+    ├── config.json         # Configuration du module
+    ├── locales/            # Traductions du module
+    │   ├── en.json
+    │   └── fr.json
+    ├── providers/          # Providers du module
+    │   ├── ReduxProvider.tsx
+    │   ├── AuthProvider.tsx
+    │   └── ThemeProvider.tsx
+    ├── pages/              # Pages du module
+    │   ├── _layout.tsx     # Layout du module
+    │   ├── _error.tsx      # Erreur du module
+    │   ├── _404.tsx        # 404 du module
+    │   └── index.tsx       # Page d'accueil du module
+    └── components/         # Composants du module (optionnel)
+```
+
+## 🔄 Workflow de Développement
+
+### 1. Initialisation du projet
+```bash
+# Créer un nouveau projet
+npm create vite@latest mon-app -- --template react-ts
+cd mon-app
+
+# Installer l'initiator
+npm install @arcpkg/initiator
+
+# Générer la structure initiale
+npx @arcpkg/initiator
+```
+
+### 2. Ajout d'un nouveau module
+```bash
+# Créer la structure du module
+mkdir -p src/modules/admin/{locales,providers,pages,components}
+
+# Ajouter les fichiers de base
+touch src/modules/admin/config.json
+touch src/modules/admin/pages/index.tsx
+touch src/modules/admin/locales/fr.json
+touch src/modules/admin/providers/ReduxProvider.tsx
+
+# Régénérer les fichiers
+npx @arcpkg/initiator
+```
+
+### 3. Ajout d'un provider global
+```bash
+# Créer un provider global
+mkdir -p src/providers
+touch src/providers/ThemeProvider.tsx
+
+# Régénérer le fichier auto-provider.tsx
+npx @arcpkg/initiator
+```
+
+### 4. Développement avec hot-reload
+```bash
+# Démarrer le serveur de développement
+npm run dev
+
+# Dans un autre terminal, surveiller les changements
+npx @arcpkg/initiator --watch
+```
+
+## 🛠️ Intégration avec d'autres outils
+
+### Avec Vite
+```javascript
+// vite.config.js
+import { defineConfig } from 'vite';
+import react from '@vitejs/plugin-react';
+
+export default defineConfig({
+  plugins: [react()],
+  build: {
+    rollupOptions: {
+      external: ['@arcpkg/initiator']
+    }
+  }
+});
+```
+
+### Utilisation du AppProvider généré
+```tsx
+// main.tsx
+import React from 'react';
+import ReactDOM from 'react-dom/client';
+import App from './App';
+import { AppProvider } from './auto-provider';
+import './index.css';
+
+ReactDOM.createRoot(document.getElementById('root')!).render(
+  <React.StrictMode>
+    <AppProvider>
+      <App />
+    </AppProvider>
+  </React.StrictMode>
+);
+```
+
+### Avec Next.js (Adaptation)
+```javascript
+// next.config.js
+const { generateRoutes } = require('@arcpkg/initiator/adapters/next');
+
+module.exports = {
+  async rewrites() {
+    const routes = await generateRoutes();
+    return routes.map(route => ({
+      source: route.path,
+      destination: route.filePath
+    }));
+  }
+};
+```
+
+### Avec Webpack
+```javascript
+// webpack.config.js
+const { GenerateRoutesPlugin } = require('@arcpkg/initiator/webpack');
+
+module.exports = {
+  plugins: [
+    new GenerateRoutesPlugin({
+      watch: process.env.NODE_ENV === 'development'
+    })
+  ]
+};
+```
+
+## 🐛 Dépannage
+
+### Problèmes courants
+
+1. **"Cannot find module"**
+   ```bash
+   # Réinstaller le plugin
+   npm install @arcpkg/initiator
+   ```
+
+2. **Fichiers non générés**
+   ```bash
+   # Forcer la régénération
+   npx @arcpkg/initiator --force
+   
+   # Vérifier les permissions
+   chmod +x node_modules/.bin/arc-init
+   ```
+
+3. **Erreurs TypeScript**
+   ```bash
+   # Vérifier les types
+   npm run type-check
+   
+   # Régénérer les fichiers
+   npx @arcpkg/initiator
+   ```
+
+4. **Providers non détectés**
+   ```bash
+   # Vérifier que le fichier contient "Provider" dans le nom
+   # Ou utilise createContext / Context.Provider
+   mv src/my-context.tsx src/MyContextProvider.tsx
+   ```
+
+### Logs de débogage
+```bash
+# Activer les logs détaillés
+DEBUG=arcpkg:* npx @arcpkg/initiator
+
+# Sauvegarder les logs dans un fichier
+npx @arcpkg/initiator 2>&1 | tee init.log
+```
+
+## 📄 Licence
+
+MIT License - Voir le fichier [LICENSE](LICENSE) pour plus de détails.
+
+## 🤝 Contribution
+
+Les contributions sont les bienvenues ! Pour contribuer :
+
+1. Fork le projet
+2. Créer une branche (`git checkout -b feature/amazing-feature`)
+3. Commit vos changements (`git commit -m 'Add amazing feature'`)
+4. Push vers la branche (`git push origin feature/amazing-feature`)
+5. Ouvrir une Pull Request
+
+## 🐛 Signaler un Bug
+
+Envoyez nous un mail à l'adresse `contact.inicode@gmail.com` pour :
+- Signaler un bug
+- Proposer une amélioration
+- Poser une question
+
+---
+
+**@arcpkg/initiator** - Le plugin d'initialisation intelligent pour React et TypeScript.
+
+*Développé par l'équipe INICODE*

package/config.ts

@@ -0,0 +1,153 @@
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { Pajo } from '@arcpkg/pajo';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export interface ConfigGeneratorOptions {
+    srcDir: string;
+    outputFile: string;
+    modulesDir: string;
+    rootConfigPath: string;
+    projectRoot: string;
+}
+
+export class ConfigGenerator {
+    private config: ConfigGeneratorOptions;
+    private modules: Set<string> = new Set();
+
+    constructor(
+        config: Partial<ConfigGeneratorOptions> = {},
+        dirname: string | undefined = __dirname,
+    ) {
+        this.config = {
+            srcDir: config.srcDir || Pajo.join(dirname, 'src') || '',
+            outputFile: config.outputFile || Pajo.join(dirname, 'src\\auto-config.ts') || '',
+            modulesDir: config.modulesDir || Pajo.join(dirname, 'src\\modules') || '',
+            rootConfigPath: config.rootConfigPath || Pajo.join(dirname, 'src\\config.json') || '',
+            projectRoot: config.projectRoot || dirname || ''
+        };
+        console.log(`--> ConfigGenerator config:: `, this.config);
+    }
+
+    public async generate(): Promise<void> {
+        console.log('🔍 Scanning for configuration files...');
+
+        await this.discoverModules();
+
+        await this.generateAutoConfigFile();
+
+        console.log(`✅ Generated ${this.config.outputFile}`);
+        console.log(`📦 Found modules with config: ${Array.from(this.modules).join(', ')}`);
+    }
+
+    private async discoverModules(): Promise<void> {
+        try {
+            
+            if (!fs.existsSync(this.config.modulesDir)) {
+                console.log(`⚠️ Modules directory not found: ${this.config.modulesDir}`);
+                return;
+            }
+
+            const moduleDirs = fs.readdirSync(this.config.modulesDir, { withFileTypes: true })
+                .filter(dirent => dirent.isDirectory())
+                .map(dirent => dirent.name);
+
+            for (const moduleName of moduleDirs) {
+                const configPath = path.join(this.config.modulesDir, moduleName, 'config.json');
+
+                if (fs.existsSync(configPath)) {
+                    this.modules.add(moduleName);
+                    console.log(`📁 Found config for module: ${moduleName}`);
+                }
+            }
+        } catch (error) {
+            console.error('Error discovering modules:', error);
+        }
+    }
+
+    private async generateAutoConfigFile(): Promise<void> {
+        const outputDir = path.dirname(this.config.outputFile);
+
+        if (!fs.existsSync(outputDir)) {
+            fs.mkdirSync(outputDir, { recursive: true });
+        }
+
+        const content = this.generateFileContent();
+        fs.writeFileSync(this.config.outputFile, content, 'utf-8');
+    }
+
+    private getRelativeImportPath(targetPath: string): string {
+        
+        const outputDir = path.dirname(this.config.outputFile);
+        const relative = path.relative(outputDir, targetPath);
+
+        let importPath = relative.replace(/\\/g, '/');
+
+        if (!importPath.startsWith('.') && !importPath.startsWith('/')) {
+            importPath = './' + importPath;
+        }
+
+        return importPath;
+    }
+
+    private generateFileContent(): string {
+        const { rootConfigPath, modulesDir } = this.config;
+
+        const sortedModules = Array.from(this.modules).sort();
+
+        const rootConfigExists = fs.existsSync(rootConfigPath);
+        console.log(`📄 Root config exists: ${rootConfigExists} at ${rootConfigPath}`);
+
+        const baseImportPath = rootConfigExists
+            ? this.getRelativeImportPath(rootConfigPath)
+            : null;
+
+        const baseConfig = rootConfigExists && baseImportPath
+            ? `  'app': (() => import('${baseImportPath}').then(module => module.default || module))`
+            : `  'app': (() => Promise.resolve({}))`;
+
+        const modulesImports = sortedModules.map(moduleName => {
+            const configPath = path.join(modulesDir, moduleName, 'config.json');
+            const configExists = fs.existsSync(configPath);
+
+            if (configExists) {
+                const importPath = this.getRelativeImportPath(configPath);
+                console.log(`📄 Module ${moduleName} config: ${configPath} -> ${importPath}`);
+                return `  '${moduleName}': (() => import('${importPath}').then(module => module.default || module))`;
+            } else {
+                console.log(`⚠️ Module ${moduleName} config not found: ${configPath}`);
+                return `  '${moduleName}': (() => Promise.resolve({}))`;
+            }
+        }).join(',\n');
+
+        return `export const configs = {
+  'base': {
+${baseConfig}
+  },
+  'modules': {
+${modulesImports.length > 0 ? modulesImports : '    // No modules with config.json found'}
+  }
+};
+
+export default configs;`;
+    }
+}
+
+async function ConfigInitiator(
+    dirname: string | undefined = __dirname
+) {
+    const config: Partial<ConfigGeneratorOptions> = {};
+
+    const generator = new ConfigGenerator(config, dirname);
+
+    generator.generate().then(() => {
+        console.log('🎉 Config generation completed successfully!');
+    }).catch((err) => {
+        console.error('❌ Failed to generate config: ', err);
+    });
+}
+
+export default ConfigInitiator;

package/index.ts

@@ -0,0 +1,23 @@
+import TranslationInitiator from './intl';
+import ConfigInitiator from './config';
+import RouteInitiator from './routing';
+import ProviderInitiator from './provider';
+import NativeRouteInitiator from './native-routing';
+
+export default function(
+    dirname: string = __dirname,
+    isNative: boolean = false,
+) {
+    isNative = (
+        typeof isNative === 'boolean'
+    ) ? isNative : false;
+
+    TranslationInitiator(dirname);
+    ConfigInitiator(dirname);
+    if(!!isNative) {
+        NativeRouteInitiator(dirname);
+    } else {
+        RouteInitiator(dirname);
+    }
+    ProviderInitiator(dirname);
+}