README

Notes 帮助您在开发应用程序时管理笔记

默认情况下，信息存储在项目根目录下的 notes.json 文件中。

安装

• 更新您的 composer.json 以包含 "albertgrala/notes": "dev-master" 。

{
  "require": {
    "laravel/framework": "4.0.*",
    "albertgrala/notes": "dev-master"
  },
  "autoload": {
    "classmap": [
      "app/commands",
      "app/controllers",
      "app/models",
      "app/database/migrations",
      "app/database/seeds",
      "app/tests/TestCase.php"
    ]
  },
  "minimum-stability": "dev"
}

• 在终端中运行 composer update
• 将 NotesServiceProvider 'Albertgrala\Notes\NotesServiceProvider' 添加到文件 app/config/app.php 中的 laravel providers 数组中

'providers' => array(

    'Illuminate\Foundation\Providers\ArtisanServiceProvider',
    'Illuminate\Auth\AuthServiceProvider',
    'Illuminate\Cache\CacheServiceProvider',
    'Illuminate\Foundation\Providers\CommandCreatorServiceProvider',
    'Illuminate\Session\CommandsServiceProvider',
    'Illuminate\Foundation\Providers\ComposerServiceProvider',
    'Illuminate\Routing\ControllerServiceProvider',
    'Illuminate\Cookie\CookieServiceProvider',
    'Illuminate\Database\DatabaseServiceProvider',
    'Illuminate\Encryption\EncryptionServiceProvider',
    'Illuminate\Filesystem\FilesystemServiceProvider',
    'Illuminate\Hashing\HashServiceProvider',
    'Illuminate\Foundation\Providers\KeyGeneratorServiceProvider',
    'Illuminate\Log\LogServiceProvider',
    'Illuminate\Mail\MailServiceProvider',
    'Illuminate\Database\MigrationServiceProvider',
    'Illuminate\Pagination\PaginationServiceProvider',
    'Illuminate\Foundation\Providers\PublisherServiceProvider',
    'Illuminate\Queue\QueueServiceProvider',
    'Illuminate\Redis\RedisServiceProvider',
    'Illuminate\Auth\Reminders\ReminderServiceProvider',
    'Illuminate\Database\SeedServiceProvider',
    'Illuminate\Foundation\Providers\ServerServiceProvider',
    'Illuminate\Session\SessionServiceProvider',
    'Illuminate\Foundation\Providers\TinkerServiceProvider',
    'Illuminate\Translation\TranslationServiceProvider',
    'Illuminate\Validation\ValidationServiceProvider',
    'Illuminate\View\ViewServiceProvider',
    'Illuminate\Workbench\WorkbenchServiceProvider',
    'Albertgrala\Notes\NotesServiceProvider',

  )

命令

在终端中输入 php artisan，您可以看到 notes 命令

notes:add

type 参数是 必需的。输入命令后，终端将要求您描述您的笔记

php artisan notes:add todo

笔记将保存在 notes.json 文件中。默认情况下，type 转换为大写。

type 的示例： todo ， optimize ， fixme ， bug

notes:show

要列出您的笔记，只需在终端中输入 php artisan notes:show 即可，这将提示所有标记为未完成的笔记。

php artisan notes:show

您可以通过传递参数来根据 type 过滤您的笔记。可以使用单数或复数形式，大写或小写。

php artisan notes:show todo
php artisan notes:show todos
php artisan notes:show TODO
php artisan notes:show TODOS

标志

--all 标志将提示已完成和未完成的笔记。在此示例中，我们将列出所有错误笔记。

php artisan notes:show bugs --all

--done 标志将过滤并仅提示标记为完成的笔记。

php artisan notes:show todos --done

--today 标志将过滤并仅提示今天创建的笔记。在此示例中，我们将列出今天创建的所有笔记

php artisan notes:show --today

您可以组合标志以进行更精确的过滤。

php artisan notes:show todos --done --today

notes:complete

传递笔记 ID 以将笔记标记为完成。笔记将被标记为完成，并且完成时间保存为 completed_at

php artisan notes:complete 1

notes:delete

传递笔记 ID 以删除笔记

php artisan notes:delete 5

您可以通过传递 --all 标志删除所有笔记

php artisan notes:delete --all

Json 文件

notes.json 具有以下结构

{
  "notes":[
    {
      "id":1,
      "name":"Create the readme file",
      "type":"TODO",
      "done":true,
      "created_at":"2013-02-26 13:41:37",
      "completed_at":"2013-02-26 13:41:52"
    },
    {
      "id":2,
      "name":"Push notes changes to github",
      "type":"TODO",
      "done":true,
      "created_at":"2013-02-26 13:44:38",
      "completed_at":"2013-02-26 13:44:53"
    }
  ]
}

屏幕截图