วิธีการตั้งค่าตัวแปรสภาพแวดล้อมจากภายใน package.json

จะตั้งค่าตัวแปรสภาพแวดล้อมบางอย่างจากภายในpackage.jsonเพื่อใช้กับnpm startคำสั่ง like ได้อย่างไร

นี่คือสิ่งที่ฉันมีอยู่ในปัจจุบันของฉันpackage.json:

{
  ...
  "scripts": {
    "help": "tagove help",
    "start": "tagove start"
  }
  ...
}

ฉันต้องการตั้งค่าตัวแปรสภาพแวดล้อม (เช่นNODE_ENV) ในสคริปต์เริ่มต้นในขณะที่ยังสามารถเริ่มต้นแอปได้ด้วยคำสั่งnpm startเดียว

ตั้งค่าตัวแปรสภาพแวดล้อมในคำสั่งสคริปต์:

...
"scripts": {
  "start": "node app.js",
  "test": "env NODE_ENV=test mocha --reporter spec"
},
...

จากนั้นใช้process.env.NODE_ENVในแอปของคุณ

หมายเหตุ: envตรวจสอบให้แน่ใจว่ามันใช้งานได้บนแพลตฟอร์มต่างๆ คุณสามารถละเว้นได้หากคุณสนใจเฉพาะ Mac / Linux

เพียงแค่ใช้แพคเกจ NPM ข้าม env ง่ายสุด ๆ ทำงานบน Windows, Linux และทุกสภาพแวดล้อม โปรดสังเกตว่าคุณไม่ได้ใช้ && เพื่อย้ายไปยังงานต่อไป คุณเพิ่งตั้งค่า env แล้วเริ่มงานถัดไป ขอมอบเครดิตให้แก่@mikekidderสำหรับคำแนะนำจากหนึ่งในความคิดเห็นที่นี่

จากเอกสาร:

{
  "scripts": {
    "build": "cross-env NODE_ENV=production OTHERFLAG=myValue webpack --config build/webpack.config.js"
  }
}

โปรดสังเกตว่าหากคุณต้องการตั้งค่า vars ทั่วโลกหลายใบคุณเพียงแค่ระบุอย่างต่อเนื่องตามด้วยคำสั่งของคุณที่จะดำเนินการ

ในที่สุดคำสั่งที่ดำเนินการ (ใช้วางไข่) คือ:

webpack --config build/webpack.config.js

NODE_ENVตัวแปรสภาพแวดล้อมจะถูกกำหนดโดยข้าม env

ฉันแค่ต้องการเพิ่มสองเซ็นต์ของฉันที่นี่สำหรับนักสำรวจโหนดในอนาคต ใน Ubuntu 14.04 ของฉันใช้งานNODE_ENV=testไม่ได้ฉันต้องใช้export NODE_ENV=testหลังจากนั้นNODE_ENV=testก็เริ่มทำงานด้วยแปลก ๆ

บน Windows ตามที่ได้กล่าวไว้ว่าคุณต้องใช้set NODE_ENV=testแต่สำหรับโซลูชันข้ามแพลตฟอร์มไลบรารี cross-env ดูเหมือนจะไม่ใช้กลอุบายและคุณจำเป็นต้องใช้ไลบรารีจริงๆในการทำสิ่งนี้:

export NODE_ENV=test || set NODE_ENV=test&& yadda yadda

จำเป็นต้องใช้แถบแนวตั้งเนื่องจากไม่เช่นนั้น Windows จะขัดข้องในexport NODE_ENVคำสั่งที่ไม่รู้จัก: D Dunno เกี่ยวกับพื้นที่ต่อท้าย แต่เพื่อให้แน่ใจว่าฉันลบมันด้วย

เนื่องจากฉันมักพบว่าตัวเองทำงานกับตัวแปรสภาพแวดล้อมหลายตัวฉันจึงพบว่ามีประโยชน์ที่จะเก็บไว้ใน.envไฟล์แยกต่างหาก(อย่าลืมละเว้นสิ่งนี้จากแหล่งควบคุมของคุณ)

VAR_A=Hello World
VAR_B=format the .env file like this with new vars separated by a line break

จากนั้นเติมexport $(cat .env | xargs) &&หน้าคำสั่งสคริปต์ของคุณ

ตัวอย่าง:

{
  ...
  "scripts": {
    ...
    "start": "export $(cat .env | xargs) && echo do your thing here",
    "env": "export $(cat .env | xargs) && env",
    "env-windows": "export $(cat .env | xargs) && set"
  }
  ...
}

สำหรับการทดสอบคุณสามารถดูตัวแปร env ได้โดยการรันnpm run env(linux) หรือnpm run env-windows(windows)

ลองสิ่งนี้บน Windows โดยแทนที่YOURENV:

  {
    ...
     "scripts": {
       "help": "set NODE_ENV=YOURENV && tagove help",
       "start": "set NODE_ENV=YOURENV && tagove start"
     }
    ...
  }

ทันใดนั้นฉันก็พบว่า actionhero ใช้รหัสต่อไปนี้ซึ่งแก้ไขปัญหาของฉันโดยเพียงแค่ผ่าน--NODE_ENV=productionตัวเลือกคำสั่งเริ่มต้นสคริปต์

if(argv['NODE_ENV'] != null){
  api.env = argv['NODE_ENV'];
} else if(process.env.NODE_ENV != null){
  api.env = process.env.NODE_ENV;
}

ฉันขอขอบคุณที่ยอมรับคำตอบของคนอื่นที่รู้วิธีที่ดีกว่าในการตั้งค่าตัวแปรสภาพแวดล้อมใน package.json หรือ init script หรือสิ่งที่คล้าย ๆ กันโดยที่แอพเริ่มต้นโดยคนอื่น

env-cmdสำหรับชุดขนาดใหญ่ของตัวแปรสภาพแวดล้อมหรือเมื่อคุณต้องการที่จะนำมาใช้ใหม่ที่คุณสามารถใช้

./.env ไฟล์:

# This is a comment
ENV1=THANKS
ENV2=FOR ALL
ENV3=THE FISH

./package.json:

{
  "scripts": {
    "test": "env-cmd mocha -R spec"
  }
}

แม้ว่าจะไม่ตอบคำถามโดยตรง แต่ฉันต้องการแบ่งปันแนวคิดที่ด้านบนของคำตอบอื่น ๆ จากสิ่งที่ฉันได้รับจากสิ่งเหล่านี้จะมีความซับซ้อนในระดับหนึ่งเพื่อให้เกิดความเป็นอิสระข้ามแพลตฟอร์ม

ในสถานการณ์ของฉันทั้งหมดที่ฉันต้องการในตอนแรกการตั้งค่าตัวแปรเพื่อควบคุมว่าจะให้เซิร์ฟเวอร์ปลอดภัยด้วยการรับรองความถูกต้อง JWT หรือไม่ (เพื่อจุดประสงค์ในการพัฒนา)

หลังจากอ่านคำตอบแล้วฉันตัดสินใจที่จะสร้างไฟล์ 2 ไฟล์ที่แตกต่างกันโดยเปิดและปิดการตรวจสอบตามลำดับ

  "scripts": {
    "dev": "nodemon --debug  index_auth.js",
    "devna": "nodemon --debug  index_no_auth.js",
  }

ไฟล์เป็นไฟล์เสริมที่เรียกไฟล์ index.js ดั้งเดิม (ซึ่งฉันเปลี่ยนชื่อappbootstrapper.js):

//index_no_auth.js authentication turned off
const bootstrapper = require('./appbootstrapper');
bootstrapper(false);

//index_auth.js authentication turned on
const bootstrapper = require('./appbootstrapper');
bootstrapper(true);

class AppBootStrapper {

    init(useauth) {
        //real initialization
    }
}

บางทีนี่อาจช่วยคนอื่นได้

{
  ...
  "scripts": {
    "start": "ENV NODE_ENV=production someapp --options"
  }
  ...
}

สิ่งนี้จะทำงานในคอนโซล Windows :

"scripts": {
  "aaa": "set TMP=test && npm run bbb",
  "bbb": "echo %TMP%"
}

npm run aaa

เอาท์พุท: test

ดูคำตอบนี้สำหรับรายละเอียด

คุณไม่ควรตั้งค่าตัวแปร ENV package.jsonเป็น ActionHero ใช้เพื่อให้คุณสามารถตั้งค่าตัวเลือกการเปลี่ยนแปลงที่มีการโหลดจากไฟล์ในNODE_ENV ./configตรวจสอบไฟล์ redis configและดูว่า NODE_ENV ใช้เพื่อเปลี่ยนตัวเลือกฐานข้อมูลอย่างไรNODE_ENV=test

หากคุณต้องการใช้ตัวแปร ENV อื่น ๆ เพื่อตั้งค่า (อาจเป็นพอร์ต HTTP) คุณยังไม่จำเป็นต้องเปลี่ยนแปลงอะไรpackage.jsonเลย ตัวอย่างเช่นหากคุณตั้งค่าเป็นPORT=1234ENV และต้องการใช้พอร์ตนั้นเป็นพอร์ต HTTP NODE_ENV=productionให้อ้างอิงในไฟล์ config ที่เกี่ยวข้อง IE:

# in config/servers/web.js
exports.production = { 
  servers: {
    web: function(api){
      return {
       port: process.env.PORT
      }
    }
  }
}

npm (และ yarn) ส่งผ่านข้อมูลจำนวนมากจาก package.json ไปยังสคริปต์เป็นตัวแปรสภาพแวดล้อม ใช้npm run envเพื่อดูพวกเขาทั้งหมด นี้ถูกบันทึกไว้ในhttps://docs.npmjs.com/misc/scripts#environmentและไม่ได้เป็นเพียงสำหรับ "วงจรชีวิต" สคริปต์เหมือนprepublishแต่ยังสคริปต์ใด ๆ npm runดำเนินการโดย

คุณสามารถเข้าถึงโค้ดภายในเหล่านี้ (เช่นprocess.env.npm_package_config_portใน JS) แต่เชลล์เหล่านี้มีอยู่แล้วที่ใช้สคริปต์เพื่อให้คุณสามารถเข้าถึงพวกเขาเป็นส่วน$npm_...ขยายใน "สคริปต์" (ไวยากรณ์ยูนิกซ์อาจไม่ทำงานบน windows?)

ส่วน "การตั้งค่า"ดูเหมือนว่ามีไว้สำหรับการใช้งานนี้:

  "name": "myproject",
  ...
  "config": {
    "port": "8010"
  },
  "scripts": {
    "start": "node server.js $npm_package_config_port",
    "test": "wait-on http://localhost:$npm_package_config_port/ && node test.js http://localhost:$npm_package_config_port/"
  } 

คุณภาพที่สำคัญของฟิลด์ "config" เหล่านี้คือผู้ใช้สามารถลบล้างได้โดยไม่ต้องแก้ไข package.json !

$ npm run start

> myproject@0.0.0 start /home/cben/mydir
> node server.js $npm_package_config_port

Serving on localhost:8010

$ npm config set myproject:port 8020
$ git diff package.json  # no change!
$ cat ~/.npmrc
myproject:port=8020

$ npm run start

> myproject@0.0.0 start /home/cben/mydir
> node server.js $npm_package_config_port

Serving on localhost:8020

ดูNPM การตั้งค่าและเส้นด้าย config ของเอกสาร
มันจะปรากฏเส้นด้ายที่อ่าน~/.npmrcเพื่อให้npm config setมีผลกระทบต่อทั้งสอง แต่yarn config setเขียนไป~/.yarnrcเพื่อให้เส้นด้ายเท่านั้นที่จะเห็นมัน :-(

คำตอบของ @ luke เกือบจะเป็นสิ่งที่ฉันต้องการ! ขอบคุณ

เนื่องจากคำตอบที่เลือกนั้นตรงไปตรงมา (และถูกต้อง) แต่เก่าฉันต้องการเสนอทางเลือกสำหรับการนำเข้าตัวแปรจากไฟล์. env ที่แยกต่างหากเมื่อรันสคริปต์ของคุณและแก้ไขข้อ จำกัด บางประการสำหรับคำตอบของลุค ลองสิ่งนี้:

::: .env ไฟล์ :::

# This way, you CAN use comments in your .env files
NODE_PATH="src/"

# You can also have extra/empty lines in it
SASS_PATH="node_modules:src/styles"

จากนั้นในแพคเกจ json คุณจะสร้างสคริปต์ที่จะตั้งค่าตัวแปรและเรียกใช้ก่อนสคริปต์ที่คุณต้องการ:

::: package.json :::

scripts: {
  "set-env": "export $(cat .env | grep \"^[^#;]\" |xargs)",
  "storybook": "npm run set-env && start-storybook -s public"
}

ข้อสังเกตบางอย่าง:

• การแสดงออกปกติในคำสั่ง grep'ed cat จะล้างความคิดเห็นและบรรทัดว่าง

• &&ไม่จำเป็นต้องเป็น"กาว"ไปnpm run set-envตามที่มันจะต้องถ้าคุณตั้งค่าตัวแปรในคำสั่งเดียวกัน

• หากคุณกำลังใช้เส้นด้ายคุณอาจเห็นคำเตือนคุณสามารถเปลี่ยนเป็นyarn set-envหรือใช้npm run set-env --scripts-prepend-node-path &&แทน

สภาพแวดล้อมที่แตกต่างกัน

ข้อดีอีกอย่างเมื่อใช้มันคือคุณสามารถมีตัวแปรสภาพแวดล้อมที่แตกต่างกัน

scripts: {
  "set-env:production": "export $(cat .production.env | grep \"^[^#;]\" |xargs)",
  "set-env:development": "export $(cat .env | grep \"^[^#;]\" |xargs)",
}

โปรดจำไว้ว่าอย่าเพิ่มไฟล์. env ไปยังที่เก็บข้อมูล git ของคุณเมื่อคุณมีรหัสผ่านรหัสผ่านหรือข้อมูลส่วนบุคคลที่เหมาะสม

ใช้ทุบตีคอมไพล์ใน windows Git Bash ประมวลผลคำสั่งแตกต่างจาก cmd

พรอมต์คำสั่ง Windows ส่วนใหญ่จะทำให้หายใจไม่ออกเมื่อคุณตั้งค่าตัวแปรสภาพแวดล้อมด้วย NODE_ENV = การผลิตเช่นนั้น (ข้อยกเว้นคือ Bash บน Windows ซึ่งใช้ Native Bash) ในทำนองเดียวกันมีความแตกต่างในวิธีที่คำสั่ง windows และ POSIX ใช้ตัวแปรสภาพแวดล้อม ด้วย POSIX คุณใช้: $ ENV_VAR และในหน้าต่างที่คุณใช้% ENV_VAR% - ข้ามเอกสาร env

{
  ...
  "scripts": {
    "help": "tagove help",
    "start": "env NODE_ENV=production tagove start"
  }
  ...
}

ใช้แพ็คเกจ dotenv เพื่อประกาศตัวแปร env