rahmatawaludin / laravel-notes
Laravel 4 Artisan Notes Management
2.0
2014-02-19 03:30 UTC
Requires
- php: >=5.3.0
- illuminate/console: ~4
- illuminate/filesystem: ~4
- illuminate/support: 4.1.*
Requires (Dev)
- jakub-onderka/php-console-highlighter: dev-master
- jakub-onderka/php-parallel-lint: *
- mockery/mockery: 0.8.0
- phpmd/phpmd: 1.5.*
- phpunit/phpunit: 3.7.27
- squizlabs/php_codesniffer: 1.*
This package is not auto-updated.
Last update: 2024-11-09 17:19:28 UTC
README
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.
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 fileapp/config/app.php
'providers' => array(
...
'Rahmatawaludin\LaravelNotes\LaravelNotesServiceProvider'
)
Usage
Add your comment to file within app
directory begin with @TODO, @FIXME, or @OPTIMIZE.
example:
app/controllers/HomeController.php:
...
// @TODO create different layout
...
app/routes.php
// @FIXME missing controller for router
app/models/User.php
/**
* This is really important
* @OPTIMIZE better looping for this model
* @var string
*/
Then use notes
in terminal to view all notes:
$ 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.
Screenshot
Roadmap
Contribute
- Fork
- Work on dev branch
- Pull
- Repeat.. :)