Devnote Laravel Package

Getting Started

Minimal Setup

1. Installation

   composer require creative-syntax/devnote
   

   Publish the package configuration (if needed):

   php artisan vendor:publish --provider="CreativeSyntax\DevNote\DevNoteServiceProvider" --tag="config"
   

2. First Use Case

   • Create a note/todo:

     use CreativeSyntax\DevNote\Facades\DevNote;
     
     DevNote::addNote('Fix login bug', 'auth', 'high');
     

   • View all notes:

     php artisan devnote:list
     

   • Mark as complete:

     DevNote::completeNote(1); // ID from list
     

3. Where to Look First

   • Artisan Commands: php artisan devnote:list, php artisan devnote:clear
   • Facade: CreativeSyntax\DevNote\Facades\DevNote
   • Config: config/devnote.php (if published)

Implementation Patterns

Core Workflows

1. Note Management

   • Add notes with context (e.g., module, priority):

     DevNote::addNote('Refactor user model', 'users', 'medium');
     

   • Filter notes by module/priority:

     $notes = DevNote::getNotes(['module' => 'auth', 'priority' => 'high']);
     

2. Integration with Laravel

   • Middleware for visibility:

     public function handle($request, Closure $next) {
         $notes = DevNote::getNotes(['module' => request()->route()->getName()]);
         view()->share('devNotes', $notes);
         return $next($request);
     }
     

   • Blade template:

     @foreach($devNotes as $note)
         <div class="note {{ $note->priority }}">
             {{ $note->title }} ({{ $note->module }})
         </div>
     @endforeach
     

3. Automation

   • Hook into events (e.g., Illuminate\Foundation\Bootstrapped):

     public function boot() {
         DevNote::checkForOverdueNotes(); // Hypothetical method
     }
     

Gotchas and Tips

Pitfalls

1. Storage Location

   • Notes are stored in storage/framework/devnotes.json by default. Ensure the storage directory is writable.
   • Fix: Run chmod -R 775 storage if permissions are denied.

2. No Database Dependency

   • Notes are file-based. Not ideal for production or multi-environment setups.
   • Workaround: Extend the package to support a database driver (see "Extension Points").

3. Priority Handling

   • Priorities (high, medium, low) are case-sensitive. Use lowercase consistently.

Debugging

1. Clear Corrupted Data

   php artisan devnote:clear
   

   • Rebuilds the JSON file from scratch.

2. Check File Permissions

   • Verify storage/framework/devnotes.json is writable.

Extension Points

1. Custom Storage

   • Override the storage path in config/devnote.php:

     'storage_path' => storage_path('app/devnotes/custom.json'),
     

2. Add Custom Fields

   • Extend the CreativeSyntax\DevNote\Models\Note model (if the package allows it) or use a wrapper:

     DevNote::addNote('Note', 'module', 'priority', ['custom_field' => 'value']);
     

3. API Endpoints

   • Create a custom controller to expose notes via API:

     Route::get('/api/devnotes', function () {
         return DevNote::getNotes();
     });
     

Pro Tips

• Tag Notes for Searchability

  DevNote::addNote('Note', 'module', 'priority', ['tags' => ['bug', 'auth']]);
  

• Sync Notes Across Environments Use a shared storage solution (e.g., S3) for the JSON file in team setups.
• CI/CD Integration Exclude storage/framework/devnotes.json from version control (add to .gitignore).