Nest CLI and scripts (Nest CLI và scripts)

Phần này cung cấp thêm bối cảnh về cách lệnh nest tương tác với các compiler và script, giúp đội DevOps quản lý môi trường phát triển.

Một ứng dụng Nest là một ứng dụng TypeScript tiêu chuẩn, cần được compile sang JavaScript trước khi có thể chạy được. Có nhiều cách khác nhau để thực hiện bước compile này, và developer/team có thể tự do chọn cách phù hợp nhất với mình. Với tinh thần đó, Nest cung cấp sẵn một bộ công cụ nhằm:

• Cung cấp một quy trình build/execute chuẩn, chạy được ngay từ command line, “chạy là được” với các giá trị mặc định hợp lý.
• Đảm bảo quy trình build/execute là mở, để developer có thể truy cập trực tiếp vào các công cụ bên dưới nhằm tùy chỉnh chúng bằng các tính năng và tùy chọn gốc (native).
• Vẫn giữ nguyên là một framework TypeScript/Node.js hoàn toàn tiêu chuẩn, để toàn bộ pipeline compile/deploy/execute có thể được quản lý bởi bất kỳ công cụ bên ngoài nào mà team phát triển chọn dùng.

Mục tiêu này đạt được thông qua sự kết hợp giữa lệnh nest, một TypeScript compiler cài đặt cục bộ, và các script trong package.json. Chúng ta sẽ mô tả cách các công nghệ này phối hợp với nhau bên dưới. Điều này sẽ giúp bạn hiểu chuyện gì đang diễn ra ở từng bước của quy trình build/execute, và cách tùy chỉnh hành vi đó nếu cần.

The nest binary (Binary nest)

Lệnh nest là một binary ở cấp hệ điều hành (tức là chạy từ dòng lệnh của OS). Lệnh này thực chất bao gồm 3 mảng riêng biệt, được mô tả bên dưới. Chúng tôi khuyến nghị bạn chạy các sub-command build (nest build) và execution (nest start) thông qua các script trong package.json được tự động cung cấp khi một project được scaffold (xem typescript starter nếu bạn muốn bắt đầu bằng cách clone một repo, thay vì chạy nest new).

Build

nest build là một lớp bọc (wrapper) trên compiler tsc hoặc swc tiêu chuẩn (đối với project tiêu chuẩn), hoặc trên bundler Rspack (đối với monorepo). Nó không thêm bất kỳ tính năng hay bước compile nào khác, ngoại trừ việc xử lý sẵn tsconfig-paths. Lý do nó tồn tại là vì hầu hết developer, đặc biệt là khi mới bắt đầu với Nest, không cần điều chỉnh các tùy chọn compiler (ví dụ: file tsconfig.json), vốn đôi khi khá rắc rối.

Xem tài liệu nest build để biết thêm chi tiết.

Execution (Thực thi)

nest start đơn giản là đảm bảo project đã được build (giống như nest build), sau đó gọi lệnh node theo cách di động (portable), dễ dùng để chạy ứng dụng đã compile. Cũng như với build, bạn được tự do tùy chỉnh quy trình này theo nhu cầu, bằng cách dùng lệnh nest start cùng các tùy chọn của nó, hoặc thay thế hoàn toàn nó. Toàn bộ quy trình là một pipeline build và execute chuẩn của ứng dụng TypeScript, và bạn được tự do quản lý quy trình này theo cách đó.

Xem tài liệu nest start để biết thêm chi tiết.

Generation (Sinh mã)

Các lệnh nest generate, đúng như tên gọi, sinh ra các Nest project mới, hoặc các component bên trong chúng.

Package scripts (Script trong package.json)

Chạy các lệnh nest ở cấp OS đòi hỏi binary nest phải được cài đặt global. Đây là một tính năng tiêu chuẩn của npm, nằm ngoài tầm kiểm soát trực tiếp của Nest. Một hệ quả của việc này là binary nest cài global sẽ không được quản lý như một dependency của project trong package.json. Ví dụ, hai developer khác nhau có thể đang chạy hai phiên bản khác nhau của binary nest. Giải pháp tiêu chuẩn cho vấn đề này là dùng package script, để bạn có thể coi các công cụ dùng trong bước build và execute như những dev dependency.

Khi bạn chạy nest new, hoặc clone typescript starter, Nest sẽ điền vào các script trong package.json của project mới những lệnh như build và start. Nó cũng cài đặt các công cụ compiler bên dưới (như typescript) dưới dạng dev dependency.

Bạn chạy các script build và execute bằng các lệnh như:

$ npm run build

và

$ npm run start

Các lệnh này dùng khả năng chạy script của npm để thực thi nest build hoặc nest start bằng binary nest được cài đặt cục bộ. Bằng cách dùng các package script có sẵn này, bạn có toàn quyền quản lý dependency đối với các lệnh Nest CLI*. Điều này có nghĩa là, bằng cách theo cách dùng được khuyến nghị này, mọi thành viên trong tổ chức của bạn đều được đảm bảo chạy cùng một phiên bản của các lệnh.

*Điều này áp dụng cho các lệnh build và start. Các lệnh nest new và nest generate không nằm trong pipeline build/execute, nên chúng hoạt động trong một ngữ cảnh khác, và không đi kèm sẵn script trong package.json.

Đối với hầu hết developer/team, chúng tôi khuyến nghị nên tận dụng các package script để build và execute Nest project của mình. Bạn có thể tùy chỉnh hoàn toàn hành vi của các script này thông qua tùy chọn của chúng, và/hoặc tùy chỉnh file cấu hình compiler tsc, swc, hoặc Rspack (ví dụ: tsconfig.json) khi cần. Bạn cũng được tự do chạy một quy trình build hoàn toàn tùy chỉnh để compile TypeScript (thậm chí chạy trực tiếp TypeScript bằng ts-node).

Backward compatibility (Khả năng tương thích ngược)

Vì các ứng dụng Nest là các ứng dụng TypeScript thuần túy, các phiên bản trước đó của script build/execute của Nest sẽ tiếp tục hoạt động. Bạn không bắt buộc phải nâng cấp chúng. Bạn có thể chọn tận dụng các lệnh nest build và nest start mới khi sẵn sàng, hoặc tiếp tục chạy các script cũ hoặc đã tùy chỉnh.

Migration (Di chuyển)

Mặc dù bạn không bắt buộc phải thay đổi gì, bạn có thể muốn chuyển sang dùng các lệnh CLI mới thay vì dùng các công cụ như tsc-watch hoặc ts-node. Trong trường hợp này, chỉ cần cài đặt phiên bản mới nhất của @nestjs/cli, cả global lẫn cục bộ:

$ npm install -g @nestjs/cli
$ cd  /some/project/root/folder
$ npm install -D @nestjs/cli

Sau đó bạn có thể thay thế các scripts được định nghĩa trong package.json bằng những script sau:

"build": "nest build",
"start": "nest start",
"start:dev": "nest start --watch",
"start:debug": "nest start --debug --watch",