Skip to content

ftkit CLI

ftkit là gì?

ftkit là công cụ dòng lệnh đi kèm framework Fountain. Đây là một CLI có thể tạo mới service, sinh các thành phần của service, kiểm tra một repo có đúng chuẩn Fountain hay không, và chỉnh sửa mã nguồn — giúp bạn dựng dự án và giữ nó đúng chuẩn mà không phải viết tay các đoạn mã khuôn mẫu.

Theo mô tả trong chính mã nguồn (cmd/root.go): "ftkit — Tạo các microservice và thành phần bằng khung fountain" — một trình CLI có thể tạo mới, kiểm tra, chỉnh sửa các service và thành phần của service trong bộ khung Fountain.

  • Module: gitlab.soludian.com/soludian/ftkit
  • Xây dựng trên module Fountain (gitlab.soludian.com/soludian/fountain) và Cobra.

Cài đặt

ftkit được phân phối dưới dạng module Go riêng tư trên GitLab, nên việc cài đặt cần cấu hình GOPRIVATE giống như khi cài chính framework:

bash
go install gitlab.soludian.com/soludian/ftkit@latest

gitlab.soludian.com là host riêng tư, hãy cấu hình Go bỏ qua proxy/checksum công khai trước khi cài — xem Bắt đầu để biết hướng dẫn GOPRIVATE / .netrc đầy đủ:

bash
go env -w GOPRIVATE=gitlab.soludian.com/*
go env -w GONOSUMDB=gitlab.soludian.com/*

Binary sẽ được cài thành ftkit trong $GOPATH/bin. Người bảo trì chính CLI cũng có thể build từ repo:

  • nopush_build.sh — build binary đã được tối giản vào $GOPATH/bin/ftkit.exe (và nén bằng upx nếu có).
  • build.sh — làm tương tự, sau đó tải artifact build (đặt tên theo ngày) lên S3.

TIP

Hãy đảm bảo $GOPATH/bin nằm trong PATH để lệnh ftkit dùng được ở mọi nơi.

Các lệnh

ftkit đăng ký các lệnh con sau (mỗi lệnh đều có một alias ngắn):

LệnhAliasMô tả
initiDựng mới một service Fountain từ bộ layout có sẵn.
newnThêm một thành phần (controller, handler, DAO, server, package, client) vào service hiện có qua lời nhắc tương tác.
verifyvChạy 20 bước kiểm tra chuẩn trên một repo service và báo cáo pass / cảnh báo / lỗi.
headerhBổ sung header template chuẩn vào các file Go còn thiếu.

Ngoài ra, cách ftkit đọc cấu hình từ môi trường và file .env được trình bày ở trang env.

Phiên bản

Phiên bản CLI được nhúng lúc build (ftkit --version); giá trị mặc định trong mã nguồn là 0.0.1.