Cách thực hiện: Xuất bản Gói đầu tiên của bạn sang npm
Đây là một hướng dẫn nhỏ để xuất bản các gói của bạn trên npm.
Bạn đã viết một số đoạn mã phần mềm mà bạn nghĩ là thực sự hữu ích! Đến đây bạn muốn xuất bản nó trên npm để những người khác có thể sử dụng gói mã tuyệt vời của bạn!
Kích hoạt nhà ga
Có rất nhiều cấu hình cho npm nhưng nhiều khi chúng sẽ dành riêng cho từng dự án. Bài viết này sẽ đề cập đến các yếu tố cần thiết để xuất bản các gói của bạn trên npm.
npm có trong Node.js. Để kiểm tra xem npm đã được cài đặt trên hệ thống của bạn chưa, hãy chạy lệnh này trong terminal của bạn: npm -v
Tạo folder
Hãy tạo một folder chứa mã nguồn của gói của ta . Trong terminal của bạn:
# This will create, and navigate # into the `wonderful-bundle` directory $ mkdir wonderful-bundle $ cd wonderful-bundle Khởi tạo gói npm
Đến đây bạn đang ở trong folder , đây là nơi ta bắt đầu sử dụng các lệnh npm !
$ npm init Chạy npm init sẽ hỏi bạn một số câu hỏi cài đặt (ví dụ: tên gói, mô tả gói, v.v.).
Bạn chỉ cần nhấn “Enter” cho mỗi câu hỏi và bảng soạn mặc định này cho file package.json sẽ được tạo trong folder của bạn:
{ "name": "wonderful-bundle", "version": "1.0.0", "description": "", "main": "index.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, "author": "", "license": "ISC" } Tệp package.json là gì?
Bạn có thể so sánh tệp package.json với thẻ công thức cho bữa ăn yêu thích của bạn.
Tệp package.json chứa tất cả metadata mô tả về dự án (như tên “Apple Crumb Pie”) và tất cả các yếu tố phụ thuộc cần thiết để chạy đúng cách (các thành phần: “táo”, “vỏ bánh”, “đường ", Vân vân).
Sử dụng tất cả thông tin này, npm kết hợp mọi thứ lại với nhau để người khác có thể dễ dàng download và chạy gói của bạn.
Hãy chỉnh sửa package.json để bao gồm mô tả và thông tin tác giả.
{ "name": "wonderful-bundle", "version": "1.0.0", "description": "outputs an uplifting message", "main": "index.js", "author": "Chompy MacPherson <chompymac@alligator.io>", "license": "ISC" } Các trường duy nhất được yêu cầu trong package.json là “tên”, “phiên bản” và “chính”. Trường "tập lệnh" đã bị xóa vì ta chưa viết bất kỳ bài kiểm tra nào.
Trường "chính" là đường dẫn file đến mã JavaScript. Khi ai đó sử dụng gói của bạn, file JavaScript này sẽ được sử dụng. Hãy tạo index.js trong terminal của ta :
$ touch index.js Trong một editor mà bạn chọn…
module.exports = function() { console.log("you're wonderful!"); return; }; Hãy nhớ export mã của bạn giống như cách bạn làm cho các file local cho dự án phần mềm của bạn.
Tạo README
Nói chung, bạn nên bao gồm tài liệu cho gói của bạn để những người khác biết cách sử dụng nó. Tệp README thường được sử dụng cho mục đích này.
Hãy tạo file README trong folder root của folder gói của bạn:
# create the README file $ touch README # put some text into README $ echo "## Wonderful Bundle \n\n Get an uplifting message!" > README … Và Xuất bản
Hiện tại, đây là folder file cho wonderful-bundle trông như thế nào:
wonderful-bundle |_ index.js |_ README |_ package.json Về cơ bản, đây là cấu trúc cơ bản của một gói npm. Không cần nhiều để xuất bản phần mềm của bạn lên npm!
Bây giờ ta cảm thấy khá tốt về gói của bạn , hãy xuất bản nó!
$ npm publish Bạn cần một account trên trang web đăng ký npm và nếu bạn chưa đăng nhập vào nó từ CLI, bạn cần đăng nhập. Bạn cũng phải sử dụng tên gói chưa được sử dụng trên register đã sẵn sàng.
Kết thúc
Đó là nó! Gói của bạn hiện đã được xuất bản trên npm . Tóm lại, chỉ có 3 bước để đi từ số không đến số đã xuất bản:
- Khởi tạo:
npm init - Thêm mã nguồn:
index.jsvàREADME - Xuất bản:
npm publish
Bây giờ khi ai đó muốn sử dụng gói của bạn, họ chỉ cần chạy điều này trong terminal của họ:
$ npm install wonderful-bundle Thao tác này sẽ download và cài đặt bất kỳ phụ thuộc nào cần thiết cho gói của bạn trong các dự án phần mềm của người khác! Công nghệ thật tuyệt vời 🤤
Hy vọng rằng hướng dẫn này đã cho bạn thấy việc đóng góp phần mềm của bạn cho cộng đồng Nguồn mở dễ dàng như thế nào, dù nó có ý nghĩa lớn hay nhỏ 👉 🌎
Nếu bạn muốn sử dụng Yarn, hãy xem hướng dẫn này: npm vs Yarn Commands Cheat Sheet
Các tin liên quan
