Есть ли способ получить версию из package.json в коде nodejs?

Есть ли способ получить версию, установленную package.jsonв приложении nodejs? Я хотел бы что-то вроде этого

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

Я обнаружил, что следующий фрагмент кода работает лучше всего для меня. Поскольку он использует requireдля загрузки package.json, он работает независимо от текущего рабочего каталога.

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

Предупреждение, любезно предоставленное @Pathogen:

Выполнение этого с Browserify имеет последствия для безопасности.
Будьте осторожны, чтобы не показывать свою package.jsonинформацию клиенту, поскольку это означает, что все номера версий зависимостей, команды построения и тестирования и многое другое отправляются клиенту.
Если вы строите сервер и клиент в одном проекте, вы также предоставляете номера версий на стороне сервера. Такие специфические данные могут быть использованы злоумышленником для лучшего соответствия атаке на вашем сервере.

Если ваше приложение запускается с «npm start», вы можете просто использовать:

process.env.npm_package_version

Смотрите package.json vars для более подробной информации.

Используя модули ES6, вы можете сделать следующее:

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

Или в простой старой оболочке:

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

Это может быть сокращено до

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

Несмотря на то, что это не совсем то, что задал вопрос, полезно, если вы хотите использовать версию внутри package.jsonсебя, например, для входа в версионный файл в 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",
  ...
}

Есть два способа получения версии:

1. Требование package.jsonи получение версии:

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

2. Использование переменных среды:

const version = process.env.npm_package_version;

Пожалуйста , не используйте JSON.parse, fs.readFile, fs.readFileSyncи не используйте другое npm modulesэто не нужно для этого вопроса.

Вот как читать версию из package.json:

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

Существует другой способ получения определенной информации из вашего package.jsonфайла, а именно с помощью модуля pkginfo .

Использование этого модуля очень просто. Вы можете получить все переменные пакета, используя:

require('pkginfo')(module);

Или только определенные детали ( versionв этом случае)

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

И ваши переменные пакета будут установлены в module.exports(поэтому номер версии будет доступен через module.exports.version).

Вы можете использовать следующий фрагмент кода:

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

Этот модуль имеет очень хорошую функцию - его можно использовать в любом файле вашего проекта (например, во вложенных папках), и он будет автоматически получать информацию из вашего package.json. Так что вам не нужно беспокоиться о том, где вы находитесь package.json.

Я надеюсь, что это поможет.

Для тех, кто ищет безопасное решение на стороне клиента, которое также работает на стороне сервера, есть genversion . Это инструмент командной строки, который читает версию из ближайшего package.json и генерирует импортируемый файл модуля CommonJS, который экспортирует версию. Отказ от ответственности: я сопровождающий.

$ genversion lib/version.js

Я признаю, что безопасность на стороне клиента не была основной целью OP, но, как обсуждалось в ответах Марка Уоллеса и Ауга , это очень важно, а также причина, по которой я нашел этот вопрос и ответ .

Просто добавив ответ, потому что я пришел к этому вопросу, чтобы увидеть лучший способ включить версию из package.json в мое веб-приложение.

Я знаю, что этот вопрос предназначен для Node.js, однако, если вы используете Webpack для объединения своего приложения, просто напоминание, рекомендуемый способ - использовать DefinePlugin для объявления глобальной версии в конфигурации и ссылки на нее . Так что вы могли бы сделать в своемwebpack.config.json

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

...

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

И AppVersionтеперь это глобальный, который доступен для использования. Также убедитесь, что .eslintrcвы игнорируете это через глобальную опору

Опция 1

Рекомендуется использовать версию из package.json с использованием переменных среды npm.

process.env.npm_package_version

больше информации на: https://docs.npmjs.com/using-npm/config.html

Это будет работать только тогда, когда вы запустите свой сервис с помощью команды NPM.

Краткая информация: вы можете прочитать любые значения в pacakge.json, используя process.env.npm_package_ [keyname]

Вариант 2

Установка версии в переменной окружения, используя https://www.npmjs.com/package/dotenv в качестве .envфайла, и относительно этого вprocess.env.version

Вы можете использовать ES6 для импорта package.json для получения номера версии и вывода версии на консоль.

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

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

Чтобы определить версию пакета в коде узла, вы можете использовать следующее:

1. const version = require('./package.json').version; для <ES6 версий

2. import {version} from './package.json'; для версии ES6

3. const version = process.env.npm_package_version; если приложение было запущено с использованием npm start, все переменные окружения npm_ * становятся доступными.

4. Вы также можете использовать следующие пакеты npm - root-require, pkginfo, project-version.

Вы можете использовать пакет проекта-версии .

$ npm install --save project-version

затем

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

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

Оно использует process.env.npm_package_version но откат на версию, написанную в package.jsonслучае, если env var по какой-то причине отсутствует.

Почему бы не использовать требуемое разрешение ...

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

При таком подходе работаю для всех подпутей :)

Я делаю это с findup-sync:

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

Я знаю, что это не цель ОП, но я просто должен был сделать это, поэтому надеюсь, что это поможет следующему человеку.

Если вы используете docker-compose для процесса CI / CD, вы можете получить его таким образом!

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', '')\""

для изображения вы можете использовать любой узел изображения. Я использую альпийский, потому что он самый маленький.

Импорт package.jsonфайла в server.jsили app.jsи затем package.json доступ к свойствам в файл сервера.

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

Переменная package содержит все данные в package.json.

Я сделал полезный код, чтобы получить package.json родительского модуля

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
}

Если используется накопительный пакет, rollup-plugin-replaceплагин можно использовать для добавления версии без предоставления package.json клиенту.

// 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
    }),
  ]
};

Затем в исходном коде, где бы вы ни хотели иметь версию package.json, вы должны использовать строку «MY_PACKAGE_JSON_VERSION».

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