Thêm siêu dữ liệu hoặc cấu hình tùy chỉnh vào package.json, nó có hợp lệ không?

Question

Tôi đã thấy (không nhớ ở đâu) một tập tin package.json với các phím tùy chỉnh bắt đầu với một dấu gạch dưới:

{ 
    "name": "application-name" 
    , "version": "0.0.1" 
    , "private": true 
    , "dependencies": { 
     "express": "2.4.7" 
    , "jade": ">= 0.0.1" 
    } 
    , "_random": true 
} 

Bạn có được phép làm điều này? Nó vẫn còn hợp lệ? Nếu điều này được cho phép, có bất kỳ tài liệu nào về các quy tắc không?

Cảm ơn!

Answer 1

tl; dr:

• Vâng, bạn được phép để thêm các mục tùy chỉnh để package.json.
• Chọn tên chính:
  • chưa được xác định (xem chi tiết bên dưới)
  • không dành riêng để sử dụng trong tương lai (xem chi tiết bên dưới)
  • tránh tiền tố _ và $
  • và tốt nhất là sử dụng sử dụng đơn top-lev el key trong đó làm tổ các mục tùy chỉnh của bạn.

Ví dụ:, Nếu bạn sở hữu tên miền example.org, bạn có thể lưu trữ một phím tùy chỉnh random như sau, bên trong một chìa khóa cấp cao nhất trong ký hiệu ngược tên-miền-với _ thay thế cho . và, nếu thích hợp, -^{(xem ý kiến)} (ví dụ, org_example):

{ 
    "name": "application-name" 
    , "version": "0.0.1" 
    , "private": true 
    , "dependencies": { 
     "express": "2.4.7" 
    , "jade": ">= 0.0.1" 
    } 
    , "org_example": { 
     "random": true 
    } 
} 

package.json định dạng file

---

npm 's chủ yếu phù hợp với CommonJS package specification:

• phím mà npm hiện đang sử dụng: https://www.npmjs.org/doc/files/package.json.html
• phím được định nghĩa trong spec: http://wiki.commonjs.org/wiki/Packages/1.1

Đối với chọn phím tùy chỉnh: các CommonJS package specification bang (tôi nhấn mạnh):

Đoạn phim sau ds là reserved cho tương lai mở rộng: build, default, email, external, files, imports, maintainer, paths, platform, require, summary, test, using, downloads, uid.

Phần mở rộng cho đặc tả mô tả gói phải cố gắng tránh va chạm cho tên chuẩn trong tương lai bằng cách đặt tên khoảng cách của chúng với các tên vô hại không có ý nghĩa liên quan đến quản lý gói chung.

Các trường sau đây dành cho gói quan đăng ký sử dụng theo quyết định của họ: id, type. Tất cả các thuộc tính bắt đầu bằng _ hoặc $ cũng được đặt trước để đăng ký gói để sử dụng theo quyết định của mình.

Answer 2

Với bản chất của JSON và tuyên bố này từ Nodejitsu documentation Tôi không thấy điều gì sai trái với điều đó.

NPM chính nó là chỉ biết hai trường trong package.json:

{ 
    "name" : "barebones", 
    "version" : "0.0.0", 
} 

NPM cũng quan tâm đến một vài lĩnh vực được liệt kê here. Vì vậy, miễn là nó là JSON hợp lệ và không can thiệp vào Node.js hoặc NPM, mọi thứ sẽ ổn và hợp lệ.

Nhận thức của Node về các tệp package.json dường như kéo dài đến trường chính chính. Ref.

{ "name" : "some-library", 
    "main" : "./lib/some-library.js" } 

Nếu đây là trong một thư mục tại ./some-library, sau đó yêu cầu ('./ một số thư viện') sẽ cố gắng để tải ./some-library/lib/some- library.js.

Đây là mức độ nhận thức của Node về các tệp package.json.

Để tránh các xung đột có thể xảy ra, bạn nên đặt tiền tố cho khóa bằng một số ký tự hoặc từ. Dấu gạch dưới là một biến thể phổ biến.