update-readme.yml

name: Update README Dependencies and Structure

on:
  push:
    branches:
      - main
    paths-ignore:
      - 'README.md'

permissions:
  contents: write

jobs:
  update-readme:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout Repository
        uses: actions/checkout@v6

      - name: Setup Node.js
        uses: actions/setup-node@v6
        with:
          node-version: 'lts/*'

      - name: Update README.md
        run: |
          node -e "
          const fs = require('fs');
          const path = require('path');
          const pkg = require('./package.json');

          // --- 1. Generate Dependencies ---
          const deps = { ...(pkg.dependencies || {}), ...(pkg.devDependencies || {}) };
          const sortedDeps = Object.keys(deps).sort();
          let depMarkdown = '\n';
          for (const dep of sortedDeps) {
              depMarkdown += \`- [\${dep}](https://www.npmjs.com/package/\${dep}): \${deps[dep]}\\n\`;
          }
          depMarkdown += '\n';

          // --- 2. Dynamic .env Detection ---
          let envFileToInject = null;
          // Check if .env.example exists in the root
          if (fs.existsSync('.env.example')) {
            envFileToInject = '.env/.env.local';
          }

          // --- 3. Generate Folder Structure ---
          const ignoreFolders = ['.git', '.next', 'node_modules', '.github', '.vscode'];
          const ignoreFiles = ['LICENSE'];
          const noExpandFolders = ['public', 'migrations', 'assets'];

          function getStructure(dir, depth = 0) {
            let structure = '';
            
            // Read directory items
            let items = fs.readdirSync(dir, { withFileTypes: true });

            // Filter out ignored folders, files, and *.md files
            items = items.filter(item => {
              if (item.isDirectory() && ignoreFolders.includes(item.name)) return false;
              if (item.isFile() && ignoreFiles.includes(item.name)) return false;
              if (item.isFile() && item.name.endsWith('.md')) return false;
              return true;
            });

            // Artificially inject the dynamic .env string if we are at the root
            if (depth === 0 && envFileToInject) {
              items.push({
                name: envFileToInject,
                isDirectory: () => false,
                isFile: () => true
              });
            }

            // Sort: Directories first, then files alphabetically
            items.sort((a, b) => {
              if (a.isDirectory() === b.isDirectory()) {
                return a.name.localeCompare(b.name);
              }
              return a.isDirectory() ? -1 : 1;
            });

            // Build the string
            items.forEach((item) => {
              // Dynamically generate the tree prefix based on depth (e.g., '  |- ', '    |-- ', '      |--- ')
              const prefix = '  '.repeat(depth + 1) + '|' + '-'.repeat(depth + 1) + ' ';
              
              if (item.isDirectory()) {
                structure += \`\${prefix}\${item.name}/\\n\`;
                
                // Recurse if at root, OR if we are at depth 1 inside a 'src' folder
                const isSrcSubfolder = depth === 1 && path.basename(dir) === 'src';
                if ((depth === 0 || isSrcSubfolder) && !noExpandFolders.includes(item.name)) {
                  structure += getStructure(path.join(dir, item.name), depth + 1);
                }
              } else {
                structure += \`\${prefix}\${item.name}\\n\`;
              }
            });
            return structure;
          }

          const projectName = pkg.name || 'project-root';
          const folderMarkdown = '\\n\`\`\`bash\\n' + projectName + '/\\n' + getStructure('.') + '\`\`\`\\n';

          // --- 4. Replace in README ---
          const readmePath = './README.md';
          let readme = fs.readFileSync(readmePath, 'utf8');

          // Replace Dependencies
          const depRegex = new RegExp('<!--- DEPENDENCIES_START --->[\\\\s\\\\S]*?<!--- DEPENDENCIES_END --->');
          readme = readme.replace(depRegex, '<!--- DEPENDENCIES_START --->' + depMarkdown + '<!--- DEPENDENCIES_END --->');

          // Replace Folder Structure
          const folderRegex = new RegExp('<!--- FOLDER_STRUCTURE_START --->[\\\\s\\\\S]*?<!--- FOLDER_STRUCTURE_END --->');
          if (folderRegex.test(readme)) {
             readme = readme.replace(folderRegex, '<!--- FOLDER_STRUCTURE_START --->' + folderMarkdown + '<!--- FOLDER_STRUCTURE_END --->');
          } else {
             console.log('Warning: FOLDER_STRUCTURE markers not found in README.md');
          }

          fs.writeFileSync(readmePath, readme);
          "

      - name: Commit and Push Changes
        run: |
          git config user.name "github-actions[bot]"
          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
          git add README.md
          git commit -m "docs: update dependencies and folder structure in README" || echo "No changes to commit"
          git push