Có cách nào để lấy phiên bản từ pack.json trong mã nodejs không?

Có cách nào để cài đặt phiên bản trong package.jsonứng dụng nodejs không? Tôi muốn một cái gì đó như thế này

var port = process.env.PORT || 3000
app.listen port
console.log "Express server listening on port %d in %s mode %s", app.address().port, app.settings.env, app.VERSION

Tôi thấy rằng đoạn mã sau đây làm việc tốt nhất cho tôi. Vì nó sử dụng requiređể tải package.json, nó hoạt động bất kể thư mục làm việc hiện tại.

var pjson = require('./package.json');
console.log(pjson.version);

Một cảnh báo, lịch sự của @Pathogen:

Làm điều này với Browserify có ý nghĩa bảo mật.
Cẩn thận không để lộ của bạn package.jsoncho khách hàng, vì điều đó có nghĩa là tất cả các số phiên bản phụ thuộc của bạn, các lệnh xây dựng và kiểm tra và nhiều hơn nữa được gửi đến máy khách.
Nếu bạn đang xây dựng máy chủ và máy khách trong cùng một dự án, bạn cũng sẽ hiển thị số phiên bản phía máy chủ của mình. Dữ liệu cụ thể như vậy có thể được sử dụng bởi kẻ tấn công để phù hợp hơn với cuộc tấn công vào máy chủ của bạn.

Nếu ứng dụng của bạn được khởi chạy với 'npm start', bạn chỉ cần sử dụng:

process.env.npm_package_version

Xem vars pack.json để biết thêm chi tiết.

Sử dụng các mô-đun ES6, bạn có thể làm như sau:

import {version} from './package.json';

Hoặc trong vỏ cũ đơn giản:

node -e "console.log(require('./package.json').version);"

Điều này có thể được rút ngắn để

node -p "require('./package.json').version"

Mặc dù đây không phải là chính xác những gì câu hỏi được hỏi, nhưng nó hữu ích nếu bạn muốn sử dụng phiên bản trong package.jsonchính nó, ví dụ để đăng nhập vào một tệp được phiên bản trong script:

{
  "name": "myapp",
  "version": "0.1.2",
  "scripts": {
    "run": "node index.js 2>&1 | tee -a myapp_v$(node -p \"require('./package.json').version\").log",
  ...
}

Có hai cách để lấy phiên bản:

1. Yêu cầu package.jsonvà nhận phiên bản:

const { version } = require('./package.json');

2. Sử dụng các biến môi trường:

const version = process.env.npm_package_version;

Xin đừng sử dụng JSON.parse, fs.readFile, fs.readFileSyncvà không sử dụng khác npm modulesđó là không cần thiết cho câu hỏi này.

Đây là cách đọc phiên bản trong gói.json:

fs = require('fs')
json = JSON.parse(fs.readFileSync('package.json', 'utf8'))
version = json.version

Có một cách khác để tìm nạp thông tin nhất định từ package.jsontệp của bạn, đó là sử dụng mô-đun pkginfo .

Cách sử dụng mô-đun này rất đơn giản. Bạn có thể nhận được tất cả các biến gói bằng cách sử dụng:

require('pkginfo')(module);

Hoặc chỉ một số chi tiết nhất định ( versiontrong trường hợp này)

require('pkginfo')(module, 'version');

Và các biến gói của bạn sẽ được đặt thành module.exports(vì vậy số phiên bản sẽ có thể truy cập qua module.exports.version).

Bạn có thể sử dụng đoạn mã sau:

require('pkginfo')(module, 'version');
console.log "Express server listening on port %d in %s mode %s", app.address().port, app.settings.env, module.exports.version

Mô-đun này có tính năng rất hay - nó có thể được sử dụng trong bất kỳ tệp nào trong dự án của bạn (ví dụ: trong các thư mục con) và nó sẽ tự động lấy thông tin từ bạn package.json. Vì vậy, bạn không phải lo lắng bạn package.jsonđang ở đâu .

Tôi hy vọng điều đó sẽ giúp.

Đối với những người tìm kiếm một giải pháp phía khách hàng an toàn cũng hoạt động ở phía máy chủ, có sự chuyển đổi . Nó là một công cụ dòng lệnh đọc phiên bản từ gói.json gần nhất và tạo tệp mô-đun CommonJS có thể nhập được để xuất phiên bản. Tuyên bố miễn trừ trách nhiệm: Tôi là người bảo trì.

$ genversion lib/version.js

Tôi thừa nhận sự an toàn của phía khách hàng không phải là mục đích chính của OP, nhưng như được thảo luận trong câu trả lời của Mark Wallace và aug , nó rất phù hợp và cũng là lý do tôi tìm thấy câu hỏi và trả lời này.

Chỉ cần thêm một câu trả lời vì tôi đã đến câu hỏi này để xem cách tốt nhất để đưa phiên bản từ gói.json vào ứng dụng web của tôi.

Tôi biết câu hỏi này được nhắm mục tiêu cho Node.js, tuy nhiên, nếu bạn đang sử dụng Webpack để đóng gói ứng dụng của mình, chỉ cần một lời nhắc là cách sử dụng DefinePlugin để khai báo phiên bản toàn cầu trong cấu hình và tham chiếu. Vì vậy, bạn có thể làm trongwebpack.config.json

const pkg = require('../../package.json');

...

plugins : [
    new webpack.DefinePlugin({
      AppVersion: JSON.stringify(pkg.version),
...

Và AppVersionbây giờ là một toàn cầu có sẵn cho bạn sử dụng. Ngoài ra, hãy chắc chắn rằng .eslintrcbạn bỏ qua điều này thông qua prop toàn cầu

lựa chọn 1

Thực hành tốt nhất là phiên bản từ gói.json sử dụng các biến môi trường npm.

process.env.npm_package_version

thêm thông tin về: https://docs.npmjs.com/USE-npm/config.html

Điều này sẽ chỉ hoạt động khi bạn bắt đầu dịch vụ của mình bằng lệnh NPM.

Thông tin nhanh: bạn có thể đọc bất kỳ giá trị nào trong pacakge.json bằng process.env.npm_package_ [keyname]

Lựa chọn 2

Đặt phiên bản trong biến môi trường bằng cách sử dụng https://www.npmjs.com/package/dotenv dưới dạng .envtệp và liên quan đến nó trongprocess.env.version

Bạn có thể sử dụng ES6 để nhập gói.json để lấy số phiên bản và xuất phiên bản trên bảng điều khiển.

import {name as app_name, version as app_version}  from './path/to/package.json';

console.log(`App ---- ${app_name}\nVersion ---- ${app_version}`);

Để xác định phiên bản gói trong mã nút, bạn có thể sử dụng như sau:

1. const version = require('./package.json').version; cho các phiên bản <ES6

2. import {version} from './package.json'; cho phiên bản ES6

3. const version = process.env.npm_package_version; nếu ứng dụng đã được bắt đầu sử dụng npm start, tất cả các biến môi trường npm_ * sẽ khả dụng.

4. Bạn cũng có thể sử dụng các gói npm sau - root-request, pkginfo, dự án phiên bản.

Bạn có thể sử dụng gói phiên bản dự án .

$ npm install --save project-version

Sau đó

const version = require('project-version');

console.log(version);
//=>  '1.0.0'

Nó sử dụng process.env.npm_package_versionnhưng dự phòng trên phiên bản được viết package.jsontrong trường hợp var env bị thiếu vì một số lý do.

Tại sao không sử dụng yêu cầu giải quyết ...

const packageJson = path.dirname(require.resolve('package-name')) + '/package.json';
const { version } = require(packageJson);
console.log('version', version)

Với phương pháp này hoạt động cho tất cả các đường dẫn phụ :)

Tôi làm điều này với findup-sync:

var findup = require('findup-sync');
var packagejson = require(findup('package.json'));
console.log(packagejson.version); // => '0.0.1' 

Tôi biết đây không phải là ý định của OP, nhưng tôi chỉ phải làm điều này, vì vậy hy vọng nó sẽ giúp người tiếp theo.

Nếu bạn đang sử dụng docker-compose cho quy trình CI / CD của mình, bạn có thể lấy nó theo cách này!

version:
  image: node:7-alpine
  volumes:
    - .:/usr/src/service/
  working_dir: /usr/src/service/
  command: ash -c "node -p \"require('./package.json').version.replace('\n', '')\""

Đối với hình ảnh, bạn có thể sử dụng bất kỳ hình ảnh nút. Tôi sử dụng alpine vì nó là nhỏ nhất.

Nhập package.jsontệp của bạn vào server.jshoặc app.jssau đó truy cập các thuộc tính của gói.json vào tệp máy chủ.

var package = require('./package.json');

biến gói chứa tất cả dữ liệu trong pack.json.

Tôi đã tạo một mã hữu ích để lấy gói.j.j của mô đun mẹ

function loadParentPackageJson() {
    if (!module.parent || !module.parent.filename) return null
    let dir = path.dirname(module.parent.filename)
    let maxDepth = 5
    let packageJson = null
    while (maxDepth > 0) {
        const packageJsonPath = `${dir}/package.json`
        const exists = existsSync(packageJsonPath)
        if (exists) {
            packageJson = require(packageJsonPath)
            break
        }
        dir = path.resolve(dir, '../')
        maxDepth--
    }
    return packageJson
}

Nếu sử dụng rollup, rollup-plugin-replaceplugin có thể được sử dụng để thêm phiên bản mà không để lộ gói.json cho máy khách.

// rollup.config.js

import pkg from './package.json';
import { terser } from "rollup-plugin-terser";
import resolve from 'rollup-plugin-node-resolve';
import commonJS from 'rollup-plugin-commonjs'
import replace from 'rollup-plugin-replace';

export default {
  plugins: [
    replace({
      exclude: 'node_modules/**',
      'MY_PACKAGE_JSON_VERSION': pkg.version, // will replace 'MY_PACKAGE_JSON_VERSION' with package.json version throughout source code
    }),
  ]
};

Sau đó, trong mã nguồn, bất cứ nơi nào bạn muốn có phiên bản pack.json, bạn sẽ sử dụng chuỗi 'MY_PACKAGE_JSON_VERSION'.

// src/index.js
export const packageVersion = 'MY_PACKAGE_JSON_VERSION' // replaced with actual version number in rollup.config.js