Finch CLI

Finch CLI یک ابزار خط فرمان برای ساخت پروژه، اجرای سرور توسعه، ساخت، اجرای تست‌ها، و مدیریت مهاجرت دیتابیس است. دستورات رایج دارت را پوشش می‌دهد و وظایف مختص فینچ را نیز اضافه می‌کند.

نصب

dart pub global activate finch

دستورات

برای مشاهده تمام دستورات موجود finch -h را اجرا کنید:

finch -h

✔ templates
        Show the list of available templates
✔ create
        Make new project
        -p, --path       Path of the project
        -n, --name       Name of project
        -d, --docker     Use docker
        -t, --template   Project template [simple, example,...]
✔ get
        Get packages of project, (dart pub get)
✔ runner
        Build runner of project, (dart pub run build_runner build)
✔ run
        Run project, (dart run)
        -p, --path       Path of app file
        -a, --args       Arguments for app file
✔ serve
        Serve project with file watcher
        -p, --path       Path of app file
        -a, --args       Arguments for app file
✔ build
        Build Project (dart compile exe)
        -c, --cli        Build for cli
        -a, --appPath    Path of app file
        -l, --langPath   Languages path
        -p, --publicPath Public path
        -w, --widgetPath Widgets path
        -e, --envPath    Envitoment file (.env) path
        -o, --output     Output path
        -t, --type       Type of build (zip, exe)
✔ migrate
        Migrate project to new version of Finch
        -c, --create     Create new project and move files
        -n, --name       Name of migration file (only for create option)
        -s, --sqlite     Migrate SQLite files
✔ test
        Unit test of project, (dart test)
        -r, --reporter   Set how to print test results
✔ make:controller
        Make new controller
        -n, --name       Name of controller
        -p, --path       Path of controller (default: ./lib/controllers/)
✔ make:service
        Make new service
        -n, --name       Name of service
        -p, --path       Path of service (default: ./lib/services/)
✔ make:middleware
        Make new middleware
        -n, --name       Name of middleware
        -p, --path       Path of middleware (default: ./lib/middleware/)

        -h, --help       Show the help
        -v, --version    Finch Version
        -u, --update     Update Finch

مثال‌های رایج

ساخت پروژه جدید با قالب example

finch create -n my_app -t example

اجرای سرور توسعه با file watcher

دستور serve فایل‌های widget و زبان را رصد می‌کند و آن‌ها را بدون راه‌اندازی مجدد سرور بارگذاری می‌کند:

finch serve

یا با تعیین نقطه ورود:

finch serve -p lib/serve.dart

ساخت باینری برای محیط production

finch build -a lib/app.dart -o ./build/app

اجرای مهاجرت دیتابیس

# اعمال تمام مهاجرت‌های MySQL معلق
finch migrate --init

# ساخت فایل مهاجرت MySQL جدید
finch migrate --create --name add_users_table

# اعمال مهاجرت‌های SQLite
finch migrate --init --sqlite

دستور migrate به سیستم مهاجرت داخلی app در حال اجرا واگذار می‌شود. برای جزئیات بیشتر به Database Migration مراجعه کنید.