rahmatawaludin/laravel-notes

Laravel 4 Artisan Notes Management

Monday, March 3, 2014
by rahmatawaludin
Repository
6 Watchers
24 Stars
118 Installations

PHP
0 Dependents
0 Suggesters
12 Forks
3 Open issues
3 Versions
0 % Grown

Laravel 4 Artisan Notes Management

, _(*1)

Inpired by Rails Rake notes, Laravel Notes helps you manage your notes when developing an application. It will search comment begin with TODO, FIXME, or OPTIMIZE., _(*2)

Installation

Update your composer.json to require "rahmatawaludin/laravel-notes": "dev-master"

{
  "require": {
    "laravel/framework": "4.1.*",
    "rahmatawaludin/laravel-notes": "dev-master"
  },
  ...
}

Run composer update in the Terminal
Add the LaravelNotesServiceProvider 'Rahmatawaludin\LaravelNotes\LaravelNotesServiceProvider' to the laravel providers array in the file app/config/app.php

'providers' => array(
    ...
    'Rahmatawaludin\LaravelNotes\LaravelNotesServiceProvider'
  )

Usage

Add your comment to file within app directory begin with @TODO, @FIXME, or @OPTIMIZE. example:, _(*3)

app/controllers/HomeController.php:, _(*4)

...
// @TODO create different layout
...

app/routes.php, _(*5)

// @FIXME missing controller for router

app/models/User.php, _(*6)

/**
 * This is really important
 * @OPTIMIZE better looping for this model
 * @var string
 */

Then use notes in terminal to view all notes:, _(*7)

$ php artisan notes

Options

To filter only one type

$ php artisan notes todo

To add custom types to the default ones

$ php artisan notes --extra-filters=foo,bar

To search only within a directory (defaults: app)

$ php artisan notes --include-path=app/views

To exclude a directory (defaults: storage)

$ php artisan notes --exclude-path=app/views

Under the hood

Laravel Notes will check your plataform and run grep of you are on a UNIX system. For Windows users it will use PHP to read and parse files. Non-formal tests have found that grep is 2x faster., _(*8)

Screenshot

alt text , _(*9)

Roadmap

Version	Feature
~~1.0~~	~~Basic viewing notes~~
~~1.1~~	~~Filter notes by type~~
~~1.2~~	~~Filter notes by custom type~~
~~1.3~~	~~View notes on specific directory~~
~~1.4~~	~~Excludes notes on specific directory~~
~~2.0~~	~~Improved lookup~~
2.1	Add `--group-by-file` and `--group-by-type`
2.2	Any idea?

Contribute

Fork
Work on dev branch
Pull
Repeat.. :)

03/03 2014

dev-master

9999999-dev

Laravel 4 Artisan Notes Management

Sources Download

MIT

The Requires

The Development Requires

by Rahmat Awaludin

19/02 2014

2.0

2.0.0.0

Laravel 4 Artisan Notes Management

Sources Download

MIT

The Requires

The Development Requires

by Rahmat Awaludin

11/02 2014

1.0

1.0.0.0

Laravel 4 Artisan Notes Management

Sources Download

library laravel-notes