Cách chạy, định cấu hình và khắc phục sự cố tập lệnh npm
tập lệnh npm bao gồm một tập hợp các lệnh đầu cuối mà bạn có thể sử dụng để tự động hóa các tác vụ trong dự án JavaScript. Chúng cũng cung cấp một cách nhất quán để chạy các lệnh trong các môi trường khác nhau.
Bạn có thể thiết lập tập lệnh npm trong tệp pack.json, chạy chúng trên dòng lệnh và sử dụng nhiều tùy chọn để định cấu hình hành vi của chúng.
Mục Lục
Thiết lập tập lệnh npm trong tệp pack.json
Bạn thường xác định tập lệnh npm trong tệp pack.json, nằm ở thư mục gốc của dự án JavaScript của bạn. Đây không phải là điều bắt buộc vì bạn có thể thực thi tập lệnh từ các tệp khác, nhưng pack.json giúp truy cập và quản lý tập lệnh của bạn dễ dàng hơn.
Lưu ý rằng bạn cần cài đặt npm và Node trong môi trường phát triển của mình để theo dõi. Dưới đây là một số bài viết hữu ích:
Để thiết lập tập lệnh npm trong pack.json, hãy làm theo các bước bên dưới:
- Điều hướng đến thư mục gốc của dự án của bạn.
- Chạy npm init trên thiết bị đầu cuối. Lệnh sẽ hỏi bạn một số câu hỏi về dự án của bạn. Trả lời chúng để tạo tệp pack.json thích hợp.
npm init - Trong tệp pack.json, tìm trường tập lệnh. Tại đây, bạn có thể thêm tên của tập lệnh và lệnh mà tập lệnh sẽ chạy dưới dạng cặp khóa/giá trị. Ví dụ: tập lệnh bên dưới, có tên là hello-world, sẽ in “Xin chào thế giới” trong thiết bị đầu cuối khi chạy.
{
"scripts": {
"hello-world": "echo \"Hello world\""
}
}
Dưới đây là một số tập lệnh phổ biến cho các dự án JavaScript:
- bắt đầu: Tập lệnh này khởi động máy chủ phát triển. Ví dụ, trong một dự án Node, nó có thể chạy máy chủ bằng gật đầu.
- xây dựng: Tạo mã sản xuất cho ứng dụng của bạn và có thể sử dụng một công cụ như webpack để thu nhỏ và gói mã.
- kiểm tra: Tập lệnh này chạy các thử nghiệm được xác định trong dự án của bạn. Nó có thể chạy một khung thử nghiệm như Jest.
- xơ vải: Tập lệnh lint chạy một công cụ lint chẳng hạn như ESLint để kiểm tra mã để tìm các lỗi tiềm ẩn.
- đồng hồ: Tập lệnh này xem mã nguồn để biết các thay đổi rồi chạy lệnh. Nó hữu ích cho việc chạy lại các bài kiểm tra hoặc xây dựng lại ứng dụng khi thay đổi mã.
- triển khai: Chạy lệnh triển khai ứng dụng vào môi trường đã chỉ định như sản xuất hoặc dàn dựng.
Kịch bản trước và sau
npm hỗ trợ các tập lệnh trước và sau. Các tập lệnh trước chạy trước một tập lệnh cụ thể trong khi các tập lệnh sau chạy sau đó. Bạn có thể tạo tập lệnh trước và sau cho bất kỳ tập lệnh nào, chỉ cần thêm tiền tố “pre” hoặc “post” vào tên tập lệnh của bạn.
Ví dụ: bên dưới là tập lệnh thử nghiệm trước và sau thử nghiệm sẽ chạy trước và sau tập lệnh thử nghiệm tương ứng.
{
"scripts": {
"pretest": "npm run lint",
"test": "jest",
"posttest": "npm run build"
}
}
Chạy tập lệnh npm từ pack.json
Khi bạn đã thêm tập lệnh npm vào pack.json, bạn có thể chạy tập lệnh đó bằng lệnh npm chạy lệnh.
Đây là cú pháp:
npm run <script-name>
Ví dụ: để chạy tập lệnh bắt đầu được xác định trước đó, hãy sử dụng:
npm run start
Bạn có thể thực thi npm tự chạy lệnh để lấy danh sách tất cả các tập lệnh có sẵn trong một dự án. Đây là một số đầu ra ví dụ:
Scripts available in npm-scripts-demo@1.0.0 via `npm run-script`:
hello-world
echo "Hello world"
Nó liệt kê tên của tập lệnh và lệnh mà nó chạy.
Sử dụng các lệnh tốc ký để chạy các tập lệnh tích hợp
npm hỗ trợ một số tập lệnh dựng sẵn mà bạn có thể chạy bằng các lệnh tốc ký. Ví dụ: để chạy tập lệnh npm có tên start, bạn có thể sử dụng npm start, thay vì npm run start.
Điều này thuận tiện và nhanh chóng hơn so với việc gõ lệnh đầy đủ. Các tập lệnh tích hợp khác mà bạn có thể chạy như thế này bao gồm “kiểm tra”, “dừng” và “khởi động lại”.
Chạy nhiều tập lệnh npm
Bạn có thể chạy nhiều tập lệnh npm theo hai cách:
Nếu bạn đang sử dụng Linux hoặc bất kỳ hệ thống giống Unix nào khác, bạn có thể sử dụng các phương pháp tiêu chuẩn để chạy nhiều lệnh cùng một lúc.
Để chạy nhiều tập lệnh npm tuần tự, hãy sử dụng &&, ví dụ:
npm run start && npm test
Để chạy nhiều tập lệnh npm song song, hãy sử dụng &, ví dụ:
npm run server & npm run client
Trong các môi trường không phải UNIX, bạn có thể sử dụng lệnh npm-run-all hoặc gói npm đồng thời.
Sử dụng npm-run-all:
npm-run-all --parallel server client
Sử dụng đồng thời trong pack.json.
"scripts": {
"dev": "concurrently \"npm run server\" \"npm run client\"",
}
Lưu ý rằng bạn cần cài đặt các gói npm-run-all và Concurrently trước khi sử dụng chúng.
Khắc phục sự cố các lỗi Npm Script phổ biến
Dưới đây là một số lỗi phổ biến mà bạn có thể gặp phải khi chạy tập lệnh npm:
- lỗi npm! tập lệnh bị thiếu — Lỗi này xảy ra khi bạn chưa xác định tập lệnh mà bạn đang cố chạy trong tệp pack.json. Đảm bảo bạn viết đúng tên tập lệnh và tên đó được xác định trong trường tập lệnh của tệp pack.json.
- Quyền bị từ chối — Lỗi này xảy ra khi bạn không có quyền chạy tập lệnh, vì vậy hãy đảm bảo bạn có quyền phù hợp.
- Thiếu phụ thuộc — Lỗi này xảy ra khi tập lệnh sử dụng gói chưa được cài đặt. Sử dụng một công cụ như depcheck để kiểm tra các phần phụ thuộc bị thiếu trong pack.json, sau đó cài đặt chúng bằng cài đặt npm.
- Lệnh không xác định — Lỗi này thường xảy ra khi bạn chạy tập lệnh tùy chỉnh dưới dạng lệnh npm tích hợp. Hãy chắc chắn rằng bạn sử dụng chạy npm hoặc là tập lệnh chạy npm khi chạy tập lệnh tùy chỉnh.
Sử dụng Biến môi trường trong Tập lệnh npm
Các biến môi trường cho phép bạn truyền thông tin mà không cần mã hóa cứng. Để sử dụng các biến môi trường trong tập lệnh npm, bạn có thể sử dụng gói cross-env npm. Công cụ này giúp bạn thiết lập một biến môi trường trong bất kỳ môi trường nào.
Bắt đầu bằng cách chạy lệnh này trên thiết bị đầu cuối để cài đặt nó dưới dạng phần phụ thuộc của nhà phát triển:
npm i save -D cross-env
Sau đó sử dụng nó trong kịch bản của bạn như thế này:
{
"scripts": {
"build": "cross-env NODE_ENV=production webpack"
}
}
Ở đây, cross-env đặt biến NODE_ENV thành “sản xuất”.
Truyền đối số dòng lệnh cho tập lệnh
Bạn có thể chuyển đối số dòng lệnh tới tập lệnh npm bằng cách sử dụng hai dấu gạch ngang “–” sau tên tập lệnh. Ví dụ: lệnh sau chạy tập lệnh kiểm tra với đối số theo dõi:
npm run test -- --watch
Bạn cũng có thể gửi đối số dòng lệnh tới tập lệnh npm như sau:
npm run my-port --PORT=3000
Sau đó truy cập nó trong tập lệnh như sau.
"scripts": {
"my-port": "echo \"Port: $npm_config_PORT\""
}
Trên hệ thống Windows, hãy sử dụng cái này:
"scripts": {
"my-port": "echo \"Port: %npm_config_PORT%\""
}
Tập lệnh sẽ in “Cổng: 3000” khi bạn chạy tập lệnh.
Tại sao nên sử dụng Tập lệnh npm?
Bạn có thể thêm các tập lệnh vào package.json, chạy chúng trên dòng lệnh, sử dụng các hook trước và sau, đồng thời chuyển các đối số dòng và biến môi trường cho chúng.
tập lệnh npm là một cách mạnh mẽ để tự động hóa các tác vụ trong các dự án JavaScript. Chúng có thể cải thiện quy trình làm việc của bạn và tiết kiệm thời gian bằng cách cung cấp cho bạn các lệnh nhất quán để chạy nhiều tác vụ.