node icon indicating copy to clipboard operation
node copied to clipboard

doc: add environment variables specification

Open IlyasShabi opened this issue 9 months ago • 1 comments

Following https://github.com/nodejs/node/issues/49148 Add documentation for environment variables specifications

IlyasShabi avatar Apr 28 '24 15:04 IlyasShabi

@IlyasShabi are you interested in continuing on this? this is the only missing PR from making dotenv stable.

anonrig avatar May 23 '24 23:05 anonrig

@anonrig sorry for the delay I was on holidays, yes will work on it this weekend.

IlyasShabi avatar May 24 '24 09:05 IlyasShabi

@GeoffreyBooth AFAIK, the only documentation for parsing env files is from the dotenv package https://github.com/motdotla/dotenv

For adding new features we should update this document. If the changes are breaking, we need to document them clearly. Do you have some suggestions ?

IlyasShabi avatar May 25 '24 22:05 IlyasShabi

@RedYetiDev your comment is not really helpful or contain any actionable item. please provide direct suggestions.

anonrig avatar May 26 '24 04:05 anonrig

I have two general concerns with this PR:

  1. This is a lot of text to introduce and then need to maintain; we’re essentially defining our own specification here. Is this specified somewhere already that we can just link to?

  2. What happens when we want to add a new feature that’s not specified, like string interpolation? We just update this spec? Would that be a breaking change?

@GeoffreyBooth there is no direct specification for dotenv other than the documentation. i believe this is the first technical specification of it. i'd like to move with this specification. do you have any blockers?

anonrig avatar May 26 '24 04:05 anonrig

@RedYetiDev your comment is not really helpful or contain any actionable item. please provide direct suggestions.

Sorry! I'll do a review instead. I didn't mean for it to come off as unhelpful.

redyetidev avatar May 26 '24 11:05 redyetidev

@anonrig IMO this PR is ready to land

IlyasShabi avatar Jun 02 '24 10:06 IlyasShabi

hey @IlyasShabi can you apply/address the reviews?

anonrig avatar Jun 09 '24 14:06 anonrig