@amirdaraee/namewise 0.5.3 → 0.5.5

package/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,61 +0,0 @@
-name: Feature Request
-description: Suggest an idea for this project
-title: "[Feature]: "
-labels: ["enhancement", "feature-request"]
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Thanks for suggesting a new feature!
-
-  - type: textarea
-    id: problem
-    attributes:
-      label: Problem Description
-      description: Is your feature request related to a problem? Please describe.
-      placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-  - type: textarea
-    id: solution
-    attributes:
-      label: Proposed Solution
-      description: Describe the solution you'd like
-      placeholder: A clear and concise description of what you want to happen.
-    validations:
-      required: true
-
-  - type: textarea
-    id: alternatives
-    attributes:
-      label: Alternative Solutions
-      description: Describe alternatives you've considered
-      placeholder: A clear and concise description of any alternative solutions or features you've considered.
-
-  - type: dropdown
-    id: priority
-    attributes:
-      label: Priority
-      description: How important is this feature to you?
-      options:
-        - Low
-        - Medium
-        - High
-        - Critical
-    validations:
-      required: true
-
-  - type: checkboxes
-    id: implementation
-    attributes:
-      label: Implementation
-      description: Would you be willing to help implement this feature?
-      options:
-        - label: I would like to implement this feature
-        - label: I need help implementing this feature
-        - label: I can provide feedback during implementation
-
-  - type: textarea
-    id: additional
-    attributes:
-      label: Additional Context
-      description: Add any other context, screenshots, or examples about the feature request here.

package/.github/workflows/auto-release.yml

@@ -1,81 +0,0 @@
-name: Auto Release
-
-on:
-  workflow_run:
-    workflows: ["Build Pipeline"]
-    types:
-      - completed
-    branches: [ main ]
-
-jobs:
-  check-version:
-    runs-on: ubuntu-latest
-    # Only run if the build workflow succeeded
-    if: ${{ github.event.workflow_run.conclusion == 'success' }}
-    outputs:
-      should-release: ${{ steps.version-check.outputs.should-release }}
-      new-version: ${{ steps.version-check.outputs.new-version }}
-
-    steps:
-    - name: Checkout code
-      uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
-    
-    - name: Check if version changed
-      id: version-check
-      run: |
-        # Get current version from package.json
-        CURRENT_VERSION=$(node -p "require('./package.json').version")
-        echo "Current version: $CURRENT_VERSION"
-        
-        # Check if tag already exists
-        if git tag --list | grep -q "^v$CURRENT_VERSION$"; then
-          echo "should-release=false" >> $GITHUB_OUTPUT
-          echo "Tag v$CURRENT_VERSION already exists"
-        else
-          echo "should-release=true" >> $GITHUB_OUTPUT
-          echo "new-version=$CURRENT_VERSION" >> $GITHUB_OUTPUT
-          echo "New version detected: $CURRENT_VERSION"
-        fi
-
-  auto-release:
-    needs: check-version
-    runs-on: ubuntu-latest
-    if: needs.check-version.outputs.should-release == 'true'
-    permissions:
-      contents: write
-    
-    steps:
-    - name: Checkout code
-      uses: actions/checkout@v4
-    
-    - name: Setup Node.js
-      uses: actions/setup-node@v4
-      with:
-        node-version: '20.x'
-        cache: 'npm'
-        registry-url: 'https://registry.npmjs.org'
-    
-    - name: Install dependencies
-      run: npm ci
-    
-    - name: Run tests
-      run: npm run test:run
-    
-    - name: Build project
-      run: npm run build
-    
-    - name: Create and push tag
-      run: |
-        git config --local user.email "action@github.com"
-        git config --local user.name "GitHub Action"
-        git tag -a "v${{ needs.check-version.outputs.new-version }}" -m "Release v${{ needs.check-version.outputs.new-version }}"
-        git push origin "v${{ needs.check-version.outputs.new-version }}"
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-    
-    - name: Publish to npm
-      run: npm publish
-      env:
-        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/build.yml

@@ -1,55 +0,0 @@
-name: Build Pipeline
-
-on:
-  workflow_dispatch: # Allows manual triggering
-  push:
-    branches: [ main ]
-  workflow_call: # Allows this workflow to be called by other workflows
-
-jobs:
-  test:
-    name: Run Tests Before Build
-    uses: ./.github/workflows/test.yml
-
-  build:
-    name: Build Project
-    runs-on: ubuntu-latest
-    needs: [test]
-    if: ${{ needs.test.result == 'success' }}
-    
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-      
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '22'
-          cache: 'npm'
-      
-      - name: Install dependencies
-        run: npm ci
-      
-      - name: Build project
-        run: npm run build
-      
-      - name: Test CLI build
-        run: |
-          node dist/index.js --help
-          node dist/index.js --version
-      
-      - name: Upload build artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: build-artifacts-${{ github.sha }}
-          path: |
-            dist/
-            package.json
-            package-lock.json
-            README.md
-            LICENSE
-            CHANGELOG.md
-          retention-days: 30
-          
-      - name: Build success notification
-        run: echo "✅ Build completed successfully for commit ${{ github.sha }}"

package/.github/workflows/publish.yml

@@ -1,134 +0,0 @@
-name: Publish Pipeline
-
-on:
-  workflow_dispatch: # Allows manual triggering
-    inputs:
-      use_artifact:
-        description: 'Use build artifact (provide artifact name or "latest")'
-        required: false
-        default: ''
-  release:
-    types: [published]
-
-jobs:
-  build:
-    name: Build for Publishing
-    uses: ./.github/workflows/build.yml
-    if: ${{ github.event.inputs.use_artifact == '' }}
-
-  publish:
-    name: Publish Package
-    runs-on: ubuntu-latest
-    needs: [build]
-    if: ${{ always() && (needs.build.result == 'success' || github.event.inputs.use_artifact != '') }}
-    environment: production # Requires environment approval for production
-    
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-      
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '22'
-          registry-url: 'https://registry.npmjs.org'
-          cache: 'npm'
-      
-      - name: Download build artifacts (from current run)
-        if: ${{ github.event.inputs.use_artifact == '' }}
-        uses: actions/download-artifact@v4
-        with:
-          name: build-artifacts-${{ github.sha }}
-          path: ./
-      
-      - name: Download build artifacts (from specific run)
-        if: ${{ github.event.inputs.use_artifact != '' && github.event.inputs.use_artifact != 'latest' }}
-        uses: actions/download-artifact@v4
-        with:
-          name: ${{ github.event.inputs.use_artifact }}
-          path: ./
-      
-      - name: Download latest build artifacts
-        if: ${{ github.event.inputs.use_artifact == 'latest' }}
-        run: |
-          echo "Downloading latest build artifacts..."
-          gh run download --name "build-artifacts-*" --limit 1
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      
-      - name: Install dependencies (only for package.json)
-        run: npm ci --production
-      
-      - name: Publish to NPM
-        run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-      
-      - name: Publish success notification
-        run: echo "✅ Package published to NPM successfully"
-
-  publish-github:
-    name: Publish to GitHub Packages
-    runs-on: ubuntu-latest
-    needs: [build, publish]
-    if: ${{ always() && needs.publish.result == 'success' }}
-    permissions:
-      contents: read
-      packages: write
-    
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-      
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '22'
-          registry-url: 'https://npm.pkg.github.com'
-          cache: 'npm'
-      
-      - name: Download build artifacts (reuse from publish job)
-        if: ${{ github.event.inputs.use_artifact == '' }}
-        uses: actions/download-artifact@v4
-        with:
-          name: build-artifacts-${{ github.sha }}
-          path: ./
-      
-      - name: Download build artifacts (from specific run)
-        if: ${{ github.event.inputs.use_artifact != '' && github.event.inputs.use_artifact != 'latest' }}
-        uses: actions/download-artifact@v4
-        with:
-          name: ${{ github.event.inputs.use_artifact }}
-          path: ./
-      
-      - name: Download latest build artifacts
-        if: ${{ github.event.inputs.use_artifact == 'latest' }}
-        run: |
-          echo "Downloading latest build artifacts..."
-          gh run download --name "build-artifacts-*" --limit 1
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      
-      - name: Install dependencies (only for package.json)
-        run: npm ci --production
-      
-      - name: Configure package for GitHub Packages
-        run: |
-          cp package.json package.json.backup
-          node -e "
-            const pkg = require('./package.json');
-            pkg.name = '@${{ github.repository_owner }}/' + pkg.name.split('/').pop();
-            require('fs').writeFileSync('package.json', JSON.stringify(pkg, null, 2));
-          "
-      
-      - name: Publish to GitHub Packages
-        run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      
-      - name: Restore original package.json
-        run: mv package.json.backup package.json
-        if: always()
-      
-      - name: GitHub Packages success notification
-        run: echo "✅ Package published to GitHub Packages successfully"

package/.github/workflows/test.yml

@@ -1,45 +0,0 @@
-name: Test Pipeline
-
-on:
-  workflow_dispatch: # Allows manual triggering
-  workflow_call: # Allows this workflow to be called by other workflows
-  pull_request:
-    branches: [ main ]
-
-jobs:
-  test:
-    name: Run Tests
-    runs-on: ubuntu-latest
-    
-    strategy:
-      matrix:
-        node-version: [18, 20, 22]
-    
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-      
-      - name: Setup Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: 'npm'
-      
-      - name: Install dependencies
-        run: npm ci
-      
-      - name: Run linter (if available)
-        run: npm run lint --if-present
-      
-      - name: Run tests
-        run: npm run test:run
-      
-      - name: Generate coverage report
-        run: npm run test:coverage
-        if: matrix.node-version == '22'
-      
-      - name: Upload coverage reports
-        uses: codecov/codecov-action@v3
-        if: matrix.node-version == '22'
-        with:
-          fail_ci_if_error: false

package/src/cli/commands.ts

@@ -1,64 +0,0 @@
-import { Command } from 'commander';
-import { renameFiles } from './rename.js';
-
-export function setupCommands(program: Command): void {
-  program
-    .command('rename')
-    .description('🚀 Rename files in a directory based on their content using AI analysis')
-    .argument('[directory]', 'Directory containing files to rename (default: current directory)', '.')
-    .option('-p, --provider <provider>', 'AI provider (claude|openai|ollama|lmstudio)', 'claude')
-    .option('-k, --api-key <key>', 'API key for cloud providers (or set CLAUDE_API_KEY/OPENAI_API_KEY)')
-    .option('-c, --case <convention>', 'Naming convention (kebab-case|snake_case|camelCase|PascalCase|lowercase|UPPERCASE)', 'kebab-case')
-    .option('-t, --template <category>', 'File category template (document|movie|music|series|photo|book|general|auto)', 'general')
-    .option('-n, --name <personalName>', 'Personal name to include in filenames (for document/photo templates)')
-    .option('-d, --date <format>', 'Date format to include (YYYY-MM-DD|YYYY|YYYYMMDD|none)', 'none')
-    .option('--dry-run', 'Preview changes without actually renaming files (RECOMMENDED first!)', false)
-    .option('--max-size <size>', 'Maximum file size in MB to process', '10')
-    .option('--base-url <url>', 'Base URL for local LLM providers (default: ollama=http://localhost:11434, lmstudio=http://localhost:1234)')
-    .option('--model <name>', 'Model name for local LLM providers (default: ollama=llama3.1, lmstudio=local-model)')
-    .addHelpText('after', `
-
-🔍 How it works:
-  1. Scans directory for supported files (PDF, DOCX, XLSX, TXT, MD, RTF)
-  2. Extracts content and metadata from each file
-  3. For scanned PDFs with no text, converts to image for AI vision analysis
-  4. Uses AI to analyze content and generate descriptive names
-  5. Applies your chosen template and naming convention
-  6. Renames files (or shows preview with --dry-run)
-
-💡 Pro Tips:
-  • Always use --dry-run first to preview changes
-  • Use 'auto' template for smart file type detection
-  • Personal templates work great for documents and photos
-  • Scanned PDFs are automatically handled via AI vision (Claude/OpenAI/Ollama)
-  • Set API keys as environment variables for cloud providers
-  • Local LLMs (Ollama/LMStudio) require running servers first
-
-🖥️  Local LLM Setup:
-  • Ollama: Start with 'ollama serve' (default: http://localhost:11434)
-  • LMStudio: Enable local server mode (default: http://localhost:1234)
-
-📝 Examples:
-  # Current directory (no directory argument needed)
-  namewise rename --dry-run
-  namewise rename --provider claude --template document --name "alice"
-
-  # Specific directory
-  namewise rename ./documents --dry-run
-
-  # Cloud providers (require API keys)
-  namewise rename ./docs --provider claude --template document --name "alice"
-  namewise rename ./media --provider openai --template auto
-
-  # Local LLMs (no API key needed)
-  namewise rename --provider ollama --model llama3.1 --dry-run
-  namewise rename ./documents --provider ollama --model llama3.1
-  namewise rename ./contracts --provider lmstudio --base-url http://localhost:1234
-
-  # Custom Ollama setup
-  namewise rename ./files --provider ollama --base-url http://192.168.1.100:11434 --model codellama
-`)
-    .action(async (directory, options) => {
-      await renameFiles(directory, options);
-    });
-}

package/src/cli/rename.ts

@@ -1,171 +0,0 @@
-import { promises as fs } from 'fs';
-import path from 'path';
-import inquirer from 'inquirer';
-import { FileInfo, Config, RenameResult, FileCategory, DateFormat } from '../types/index.js';
-import { DocumentParserFactory } from '../parsers/factory.js';
-import { AIServiceFactory } from '../services/ai-factory.js';
-import { FileRenamer } from '../services/file-renamer.js';
-
-export async function renameFiles(directory: string, options: any): Promise<void> {
-  try {
-    // Validate directory exists
-    const stats = await fs.stat(directory);
-    if (!stats.isDirectory()) {
-      throw new Error(`${directory} is not a directory`);
-    }
-
-    // Get API key for cloud providers only
-    let apiKey = options.apiKey;
-    const requiresApiKey = ['claude', 'openai'].includes(options.provider);
-    
-    if (requiresApiKey && !apiKey) {
-      // Check environment variables first
-      if (options.provider === 'claude' && process.env.CLAUDE_API_KEY) {
-        apiKey = process.env.CLAUDE_API_KEY;
-      } else if (options.provider === 'openai' && process.env.OPENAI_API_KEY) {
-        apiKey = process.env.OPENAI_API_KEY;
-      } else {
-        const keyPrompt = await inquirer.prompt([
-          {
-            type: 'password',
-            name: 'apiKey',
-            message: `Enter your ${options.provider} API key:`,
-            mask: '*'
-          }
-        ]);
-        apiKey = keyPrompt.apiKey;
-      }
-    }
-
-    // Create config
-    const config: Config = {
-      aiProvider: options.provider,
-      apiKey,
-      maxFileSize: parseInt(options.maxSize) * 1024 * 1024, // Convert MB to bytes
-      supportedExtensions: ['.pdf', '.docx', '.doc', '.xlsx', '.xls', '.txt'],
-      dryRun: options.dryRun,
-      namingConvention: options.case,
-      templateOptions: {
-        category: options.template as FileCategory,
-        personalName: options.name,
-        dateFormat: options.date as DateFormat
-      },
-      // Local LLM specific configuration
-      localLLMConfig: {
-        baseUrl: options.baseUrl,
-        model: options.model
-      }
-    };
-
-    // Initialize services
-    const parserFactory = new DocumentParserFactory(config);
-    const aiService = AIServiceFactory.create(config.aiProvider, apiKey, config.localLLMConfig);
-    const fileRenamer = new FileRenamer(parserFactory, aiService, config);
-
-    // Get files to process
-    const files = await getFilesToProcess(directory, config.supportedExtensions);
-    
-    if (files.length === 0) {
-      console.log('No supported files found in the directory.');
-      return;
-    }
-
-    console.log(`Found ${files.length} files to process:`);
-    files.forEach(file => console.log(`  - ${file.name}`));
-
-    // Confirm before processing
-    if (!config.dryRun) {
-      const confirm = await inquirer.prompt([
-        {
-          type: 'confirm',
-          name: 'proceed',
-          message: 'Do you want to proceed with renaming these files?',
-          default: false
-        }
-      ]);
-
-      if (!confirm.proceed) {
-        console.log('Operation cancelled.');
-        return;
-      }
-    }
-
-    // Process files
-    console.log('\nProcessing files...');
-    const results = await fileRenamer.renameFiles(files);
-
-    // Display results
-    displayResults(results, config.dryRun);
-
-  } catch (error) {
-    console.error('Error:', error instanceof Error ? error.message : 'Unknown error');
-    process.exit(1);
-  }
-}
-
-async function getFilesToProcess(directory: string, supportedExtensions: string[]): Promise<FileInfo[]> {
-  const files: FileInfo[] = [];
-  const entries = await fs.readdir(directory, { withFileTypes: true });
-
-  for (const entry of entries) {
-    if (entry.isFile()) {
-      const filePath = path.join(directory, entry.name);
-      const extension = path.extname(entry.name).toLowerCase();
-      
-      if (supportedExtensions.includes(extension)) {
-        const stats = await fs.stat(filePath);
-        
-        // Extract folder context
-        const parentFolder = path.basename(directory);
-        const fullPath = path.resolve(filePath);
-        const folderPath = path.dirname(fullPath).split(path.sep).filter(p => p);
-        
-        files.push({
-          path: filePath,
-          name: entry.name,
-          extension,
-          size: stats.size,
-          // File system metadata
-          createdAt: stats.birthtime,
-          modifiedAt: stats.mtime,
-          accessedAt: stats.atime,
-          // Context metadata
-          parentFolder,
-          folderPath: folderPath.slice(-3), // Last 3 folder levels for context
-          // Document metadata will be populated by parsers
-          documentMetadata: undefined
-        });
-      }
-    }
-  }
-
-  return files;
-}
-
-function displayResults(results: RenameResult[], dryRun: boolean): void {
-  const successful = results.filter(r => r.success);
-  const failed = results.filter(r => !r.success);
-
-  console.log(`\n${dryRun ? 'Preview' : 'Results'}:`);
-  console.log(`✅ ${successful.length} files ${dryRun ? 'would be' : 'successfully'} renamed`);
-  
-  if (failed.length > 0) {
-    console.log(`❌ ${failed.length} files failed`);
-  }
-
-  console.log('\nDetails:');
-  results.forEach(result => {
-    const status = result.success ? '✅' : '❌';
-    const originalName = path.basename(result.originalPath);
-    const newName = path.basename(result.newPath);
-    
-    if (result.success) {
-      console.log(`${status} ${originalName} → ${newName}`);
-    } else {
-      console.log(`${status} ${originalName} (failed)`);
-      if (result.error) {
-        console.log(`   Error: ${result.error}`);
-      }
-    }
-  });
-}

package/src/index.ts

@@ -1,54 +0,0 @@
-#!/usr/bin/env node
-
-import { program } from 'commander';
-import { setupCommands } from './cli/commands.js';
-
-async function main() {
-  program
-    .name('namewise')
-    .description('🤖 AI-powered CLI tool that intelligently renames files based on their content using Claude or OpenAI')
-    .version('0.3.1')
-    .addHelpText('after', `
-
-📋 Supported File Types:
-  PDF, DOCX/DOC, XLSX/XLS, TXT, MD, RTF
-
-🎯 File Templates:
-  • general    - Simple descriptive names (default)
-  • document   - Personal docs with name/date: contract-john-20241205.pdf
-  • movie      - Movies with year: the-matrix-1999.mkv
-  • series     - TV shows: breaking-bad-s01e01.mkv
-  • music      - Music with artist: the-beatles-hey-jude.mp3
-  • photo      - Photos with context: vacation-paris-john-20241205.jpg
-  • book       - Books with author: george-orwell-1984.pdf
-  • auto       - AI auto-detects best template
-
-🔧 Naming Conventions:
-  kebab-case, snake_case, camelCase, PascalCase, lowercase, UPPERCASE
-
-💡 Quick Examples:
-  # Basic usage (dry run first - recommended!)
-  namewise rename ./documents --dry-run
-
-  # With Claude AI and specific template
-  namewise rename ./documents --provider claude --template document --name "john"
-
-  # Movies with auto-detection
-  namewise rename ./movies --template auto --case kebab-case
-
-  # OpenAI with custom settings
-  namewise rename ./files --provider openai --api-key your-key --max-size 20
-
-🔑 API Keys:
-  Set environment variables: CLAUDE_API_KEY or OPENAI_API_KEY
-  Or provide via --api-key flag
-
-📖 More info: https://github.com/amirdaraee/namewise#readme
-`);
-
-  setupCommands(program);
-  
-  await program.parseAsync(process.argv);
-}
-
-main().catch(console.error);