envfile

v7.1.0

Parse and stringify the environment configuration files and format, also known as .env files and dotenv files For more information about how to use this package see README

Latest version published 11 months ago

License: Artistic-2.0

NPM

GitHub

Package Health Score

71 / 100

security
No known security issues
popularity
Recognized
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
7.1.0	\|	12/2023		0 C 0 H 0 M 0 L	0 H 1 M 0 L
7.0.0	\|	11/2023		0 C 0 H 0 M 0 L	0 H 1 M 0 L
6.22.0	\|	11/2023		0 C 0 H 0 M 0 L	0 H 1 M 0 L
6.18.0	\|	09/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.2.0	\|	05/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Artistic-2.0

Non-Permissive License

We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (82,677)

GitHub Stars: 61
Forks: 10
Contributors: 9

Direct Usage Popularity

The npm package envfile receives a total of 82,677 downloads a week. As such, we scored envfile popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package envfile, we found that it has been starred 61 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 9
Funding: Yes

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like envfile is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 3
Open PR: 1
Last Release: 11 months ago
Last Commit: 1 month ago

Further analysis of the maintenance status of envfile based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that envfile demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=8

Age: 12 years
Dependencies: 0 Direct
Versions: 104
Install Size: 45.9 kB
Dist-tags: 2
# of Files: 23
Maintainers: 1
TS Typings: Yes

envfile has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use envfile?

To help you get started, we've collected the most common ways that envfile is being used within popular public projects.

hernanjkd / Resume-Builder / deploy-to-github.js View on Github

Console.help(`Check your remote by doing:
$ git remote get-url origin

Add your remote by doing:
$ git remote add origin 
`);
return;
}
Console.info("The remote was found successfully, starting the deploy from here: "+origin);

//get the repository project name
const repository = gh(origin);

// update the env file
const envPath = './.env';
const env = envfile.parseFileSync(envPath);
env['BASENAME'] = `/${repository["name"]}/`;
Console.info("Updating the .env file with the basename "+repository["name"]);
fs.writeFileSync(envPath, envfile.stringifySync(env));

const compiler = webpack(require(path.resolve(__dirname, 'webpack.prod.js')));
compiler.run((err, stats) =&gt; {
    if (err || stats.hasErrors()) {
      console.log(stats.toString({
        colors: true
      }));
      Console.error("There was an error compiling, review above");
      return;
    }
    Console.success("Your code compiled successfully, proceding to deploy...");
    ghpages.publish('public', function(err) {
        if(err){

View more ways to use envfile

envfile

Parse and stringify the environment configuration files and format, also known as .env files and dotenv files

What are environment configuration files?

They are files use to configure environments by applications and servers that support them. Generally they look like this:

a=1
b:2
c = 3
d : 4

They are commonly also called envfiles, .env files, and dotenv files.

Usage

Complete API Documentation.

Via the Command Line

Requires a global installation of envfile: npm install -g envfile

# envfile to JSON
echo -e "a=1\nb:2" | envfile env2json &gt; config.json

# JSON to envfile
echo '{"a":1,"b":2}' | envfile json2env &gt; config.env

Via Node.js

// Include envfile
const { parse, stringify } = require('envfile')

// Parse an envfile string
console.log(parse('a=1\nb:2'))

// Stringify a javascript object to an envfile string
console.log(stringify({ a: 1, b: 2 }))

Install

npm

Install Globally

Install: npm install --global envfile
Executable: envfile

Install Locally

Install: npm install --save envfile
Executable: npx envfile
Import: import * as pkg from ('envfile')
Require: const pkg = require('envfile')

Deno

import * as pkg from 'https://unpkg.com/envfile@^7.1.0/edition-deno/index.ts'

Skypack

unpkg

jspm

Editions

This package is published with the following editions:

envfile/source/index.ts is TypeScript source code with Import for modules
envfile/edition-browsers/index.js is TypeScript compiled against ES2022 for web browsers with Import for modules
envfile aliases envfile/edition-es2022/index.js
envfile/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
envfile/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modules
envfile/edition-types/index.d.ts is TypeScript compiled Types with Import for modules
envfile/edition-deno/index.ts is TypeScript source code made to be compatible with Deno

History

Discover the release history by heading on over to the HISTORY.md file.

Backers

Code

Discover how to contribute via the CONTRIBUTING.md file.

Authors

2013+ Benjamin Lupton — Accelerating collaborative wisdom.

Maintainers

Benjamin Lupton — Accelerating collaborative wisdom.

Contributors

Finances

Donors

License

Unless stated otherwise all works are:

and licensed under:

Artistic License 2.0

envfile development dependencies

@types/node @typescript-eslint/eslint-plugin @typescript-eslint/parser assert-helpers eslint eslint-config-bevry eslint-config-prettier eslint-plugin-prettier filedirname kava make-deno-edition prettier projectz safeps typedoc typescript valid-directory valid-module

FAQs

What is envfile?

Parse and stringify the environment configuration files and format, also known as .env files and dotenv files. Visit Snyk Advisor to see a full health score report for envfile, including popularity, security, maintenance & community analysis.

Is envfile popular?

The npm package envfile receives a total of 82,677 weekly downloads. As such, envfile popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is envfile well maintained?

We found indications that envfile maintenance is sustainable demonstrating some project activity. We saw a total of 9 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is envfile safe to use?

The npm package envfile was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 November-2024, at 13:25 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (82,677)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Not sure how to use envfile?

envfile

What are environment configuration files?

Usage

Via the Command Line

Via Node.js

Install

npm

Install Globally

Install Locally

Deno

Skypack

unpkg

jspm

Editions

History

Backers

Code

Authors

Maintainers

Contributors

Finances

Sponsors

Donors

License

envfile development dependencies

FAQs

What is envfile?

Is envfile popular?

Is envfile well maintained?

Is envfile safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues