npmpackage.info

Gathering detailed insights and metrics for node-yaml-config

Other packages similar to node-yaml-config

node-config-yaml

0.1.4

Yaml Config for Node.js based on config-yml package

@yutengjing/eslint-config-basic

1.7.1

eslint config for ts + react project

node-config-loader

3.1.0

Scan directories and loads json and yaml files

@yutengjing/eslint-config-typescript

1.7.1

eslint config for typescript project

Gathering detailed insights and metrics for node-yaml-config

node-yaml-config

Write your configuration files for node.js in yaml

1.0.0

TypeScript

15.37 kB

5,037,626 2.4

Installations

npm install node-yaml-config

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

14.17.6

NPM Version

6.14.15 Score

96.4

Supply Chain

100

Quality

75.5

Maintenance

100

Vulnerability

98.6

License

Pull Requests

Open

0

Total

16

Closed

1

Merged

15

Issues

Open

1

Total

7

Closed

6

Releases

v1.0.0

Published on 30 Sept 2021

View all 1 releases

Contributors

Unable to fetch Contributors

View all 3 contributors

Languages

TypeScript

JavaScript

TypeScript (96.57%)

JavaScript (3.43%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

leafty

Download Statistics

Total Downloads

5,037,626

Last Day

8,029

Last Week

8,029

Last Month

93,366

Last Year

1,193,117

GitHub Statistics

23 Stars

35 Commits

7 Forks

5 Watching

2 Branches

3 Contributors

Bundle Size

47.97 kB

Minified

15.37 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.0.0

Package Id

node-yaml-config@1.0.0

Size

11.15 kB

NPM Version

6.14.15

Node Version

14.17.6

Publised On

30 Sept 2021

Total Downloads

Cumulative downloads

Total Downloads

5,037,626

Last day

8,029

Compared to previous day

Last week

-59.1%

8,029

Compared to previous week

Last month

7.2%

93,366

Compared to previous month

Last year

-50.9%

1,193,117

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

js-yaml node.extend

Dev Dependencies

@types/jest @types/js-yaml @types/node @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-plugin-import jest prettier rimraf ts-jest ts-node typescript

Versions

node-yaml-config

Write your configuration files for node.js in yaml

Installation

1npm install node-yaml-config

Usage

1var yaml_config = require('node-yaml-config');
2
3var config = yaml_config.load(__dirname + '/config/config.yml');
4
5console.log(config);

Or with Typescript:

1import { loadAsync } from 'node-yaml-config';
2
3async function main() {
4  const config = await loadAsync(__dirname + '/config/config.yml');
5  console.log(config);
6}
7main();

Configuration Files

In your configuration file:

1default:
2  server:
3    port: 3000
4  database:
5    host: 'localhost'
6    port: 27017
7development:
8  database:
9    db: 'dev_db'
10test:
11  database:
12    db: 'test_db'
13production:
14  server:
15    port: 8000
16  database:
17    db: 'prod_db'
18    user: 'dbuser'
19    password: 'pass'
20  cache:
21    dir: 'static'

node-yaml-config takes the configuration found in default, then overwrites it with the values found in the environment specific parts. The configuration file is loaded synchronously.

API

read(filename)

Reads the configuration found in filename.

load(filename[, env])

Load the configuration found in filename with the environment based on NODE_ENV. The environment can be forced with the env argument.

node-yaml-config keeps parsed yaml files in memory to avoid reading files again.

reload(filename)

Reload the configuration found in filename. Later calls to load will show the new configuration.

The file is loaded synchronously.

readAsync(filename)

Same as read but returns a Promise.

loadAsync(filename[, env])

Same as load but returns a Promise.

node-yaml-config keeps parsed yaml files in memory to avoid reading files again.

reloadAsync(filename)

Same as reload but returns a Promise.

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yaml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/leafty/node-yaml-config/nodejs.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yaml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/leafty/node-yaml-config/nodejs.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pre-release.yaml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/leafty/node-yaml-config/pre-release.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pre-release.yaml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/leafty/node-yaml-config/pre-release.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pre-release.yaml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/leafty/node-yaml-config/pre-release.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pre-release.yaml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/leafty/node-yaml-config/pre-release.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yaml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/leafty/node-yaml-config/publish.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yaml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/leafty/node-yaml-config/publish.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yaml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/leafty/node-yaml-config/publish.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yaml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/leafty/node-yaml-config/publish.yaml/main?enable=pin
Info: 0 out of 10 GitHub-owned GitHubAction dependencies pinned

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.4

/10

Last Scanned on 2025-02-03

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More