Làm thế nào để xuất bản một gói trên npm
Trình quản lý gói Node, thường được gọi là npm, là một kho lưu trữ trực tuyến để xuất bản các gói và thư viện NodeJS.
Nó cũng là một công cụ dòng lệnh cho phép bạn tương tác với các gói đã đăng ký. Nó có thể giúp cài đặt gói, quản lý phiên bản và quản lý phụ thuộc.
Các nhà phát triển xuất bản thư viện JavaScript của họ vào npm mỗi ngày. Quá trình này khá đơn giản, vì vậy bạn cũng có thể xuất bản một gói trên npm.
Mục Lục
Bước 1: Cài đặt NodeJS
Để tương tác với npm, bạn phải cài đặt nó trên toàn cầu trên hệ thống của mình.
Bắt đầu bằng cách cài đặt NodeJS và npm trên Ubuntu, trên Windows hoặc làm theo hướng dẫn trên trang web NodeJS.
Bước 2: Tạo tài khoản npm
Để xuất bản các gói của bạn trên npm, bạn phải tạo một tài khoản npm trên trang web chính thức của npm.
Làm theo các bước dưới đây để tạo tài khoản npm:
- Truy cập trang đăng ký npm.
- Điền thông tin chi tiết của bạn, đồng ý với giấy phép và chính sách bảo mật, và nhấp vào “tạo tài khoản”.
- Xác minh email của bạn với liên kết bạn sẽ nhận được từ npm trong hộp thư của bạn.
Nếu bạn không xác minh địa chỉ email của mình, npm sẽ báo lỗi khi bạn cố gắng xuất bản các gói của mình.
Bước 3: Khởi tạo Kho lưu trữ Git
Tiếp theo, bạn cần khởi tạo kho lưu trữ Git để theo dõi tất cả các thay đổi bạn sẽ thực hiện đối với dự án của mình.
Trên thiết bị đầu cuối của bạn, điều hướng đến thư mục gốc của dự án và chạy lệnh sau để khởi tạo kho lưu trữ Git trống.
git init
Tạo một .gitignore và thêm bất kỳ tệp nào mà bạn không muốn Git theo dõi. Sau đó chạy lệnh sau để theo dõi các tệp còn lại:
git add -A
Tiếp theo, chạy lệnh sau để chụp ảnh nhanh đầu tiên của bạn bằng cách cam kết mã cho Git.
git commit -m initial-commit
Bạn có thể chọn lưu trữ kho lưu trữ Git của mình trên GitHub hoặc một dịch vụ tương tự như Gitlab để cộng tác liền mạch.
Bước 4: Khởi tạo npm trong Dự án của bạn
Tiếp theo, khởi tạo npm trong dự án của bạn để thêm chi tiết về dự án của bạn vào tệp package.json. Những chi tiết này sẽ được công khai vào npm.
Trên thiết bị đầu cuối của bạn, điều hướng đến thư mục gốc của dự án và chạy lệnh sau để khởi tạo npm trong dự án của bạn.
npm init
Lệnh trên sẽ kích hoạt một tập hợp các lời nhắc trên dòng lệnh của bạn:
- tên gói hàng: Đây là tên của gói npm của bạn; nó phải là duy nhất nếu bạn muốn xuất bản gói trên npm; nếu không, npm sẽ báo lỗi.
- phiên bản: Thuộc tính này biểu thị phiên bản hiện tại của gói của bạn. Bạn phải tăng nó mỗi khi bạn cập nhật gói của mình, nếu không npm sẽ xuất hiện lỗi. Giá trị mặc định là 1.0.0.
- sự mô tả: Thuộc tính này là mô tả gói của bạn. Nó sẽ được công khai khi bạn xuất bản gói của mình.
- điểm vào: Thuộc tính này biểu thị tên tệp nơi bắt đầu thực thi mã của bạn.
- lệnh kiểm tra: Thuộc tính này cho biết lệnh sẽ chạy khi bạn thực thi chạy thử nghiệm npm.
- kho git: Thuộc tính này là URL cho kho lưu trữ Git từ xa của bạn.
- từ khóa: Thuộc tính này biểu thị các từ khóa có liên quan đến dự án của bạn sẽ giúp công cụ tìm kiếm tìm thấy nó.
- tác giả: Thuộc tính này phải là tên hoặc bí danh của bạn.
- giấy phép: Đây là giấy phép mà bạn muốn xuất bản gói theo đó. Giấy phép mặc định là giấy phép Hiệp hội Hệ thống Internet (ISC).
Sau khi thiết lập điều này, bạn có thể tạo gói của mình.
Bước 5: Kiểm tra gói hàng của bạn
Sau khi tạo xong gói, bạn nên kiểm tra cục bộ để xem nó sẽ hoạt động như thế nào sau khi bạn triển khai trên npm.
Để kiểm tra cục bộ gói của bạn, trước tiên, hãy chạy lệnh sau trong thư mục dự án của bạn:
npm link
Lệnh trên cho phép bạn tham chiếu cục bộ gói của mình như cách bạn làm với gói được lưu trữ trên máy chủ npm.
Sau đó, tạo một thư mục khác trong thư mục gốc của dự án của bạn và cd vào đó.
mkdir test
cd test
Trong thư mục thử nghiệm, hãy chạy lệnh sau để liên kết gói của bạn với thư mục:
npm link name-of-your-package
Cuối cùng, tạo một tệp giả để kiểm tra chức năng gói của bạn.
Sau khi hoàn thành các bài kiểm tra của mình, bạn có thể xóa thư mục kiểm tra của mình một cách an toàn.
Bước 6: Đăng nhập vào npm trên Hệ thống của bạn
Tiếp theo, bạn phải đăng nhập vào tài khoản npm trên hệ thống của mình.
Chạy lệnh sau để đăng nhập vào tài khoản npm của bạn:
npm login
Thao tác này sẽ nhắc bạn điền tên người dùng, mật khẩu và mã xác thực hai yếu tố (nếu bạn đã bật mã này trên tài khoản của mình).
Bước 7: Xuất bản gói của bạn
Sau khi bạn đã hoàn thành tất cả các bước ở trên, hãy chạy lệnh sau để xuất bản gói của bạn trên npm.
npm publish
Lệnh này yêu cầu mật khẩu dùng một lần sẽ được gửi đến email của bạn. Sau đó, nó sẽ xuất bản gói của bạn trên npm.
Bạn có thể xem các gói bạn đã xuất bản trên npm. Đăng nhập vào tài khoản npm của bạn trên npmjs.com và điều hướng đến phần gói trên trang tổng quan hồ sơ của bạn.
Để cài đặt gói của bạn và sử dụng nó như một phần phụ thuộc vào bất kỳ dự án nào của bạn, hãy chạy:
npm install name-of-your-package
Xóa gói hàng của bạn khỏi npm
Bạn vẫn có toàn quyền kiểm soát các gói của mình trên npm, nghĩa là bạn có thể sửa đổi và thậm chí xóa gói vĩnh viễn khỏi npm. Bạn có thể xóa các gói của mình bằng cách đi tới phần cài đặt của gói và chọn tùy chọn xóa gói.