{"id":24380513,"url":"https://github.com/urbanjs/urbanjs-config","last_synced_at":"2026-04-24T06:33:20.107Z","repository":{"id":57387461,"uuid":"107987348","full_name":"urbanjs/urbanjs-config","owner":"urbanjs","description":"Simple utility functions for configuration management","archived":false,"fork":false,"pushed_at":"2017-10-23T22:02:07.000Z","size":52,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-04-08T09:16:22.318Z","etag":null,"topics":["config","configuration","dotenv","environment-variables","node","nodejs"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/urbanjs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-23T13:39:03.000Z","updated_at":"2017-10-23T20:02:22.000Z","dependencies_parsed_at":"2022-09-07T14:51:37.935Z","dependency_job_id":null,"html_url":"https://github.com/urbanjs/urbanjs-config","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/urbanjs/urbanjs-config","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/urbanjs%2Furbanjs-config","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/urbanjs%2Furbanjs-config/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/urbanjs%2Furbanjs-config/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/urbanjs%2Furbanjs-config/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/urbanjs","download_url":"https://codeload.github.com/urbanjs/urbanjs-config/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/urbanjs%2Furbanjs-config/sbom","scorecard":{"id":911823,"data":{"date":"2025-08-11","repo":{"name":"github.com/urbanjs/urbanjs-config","commit":"c183132c29278839e6717dd55e7fc000e3139f68"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/5 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.md:0","Info: FSF or OSI recognized license: MIT License: LICENSE.md:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":0,"reason":"65 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-8w4h-3cm3-2pm2","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx","Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-rq8g-5pc5-wrhr","Warn: Project is vulnerable to: GHSA-9vvw-cc9w-f27h","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-hr2v-3952-633q","Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9","Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm","Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h","Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-qh2h-chj9-jffq","Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6","Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9","Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f","Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p","Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv","Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8","Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65","Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh","Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44","Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988","Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq","Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm","Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-8g7p-74h8-hg48","Warn: Project is vulnerable to: GHSA-pc5p-h8pf-mvwp","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546","Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695","Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm","Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574","Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-hxm2-r34f-qmc5","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-446m-mv8f-q348","Warn: Project is vulnerable to: GHSA-8hfj-j24r-96c4","Warn: Project is vulnerable to: GHSA-wc69-rhjr-hc9g","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3","Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v","Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh","Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-24T19:29:34.574Z","repository_id":57387461,"created_at":"2025-08-24T19:29:34.574Z","updated_at":"2025-08-24T19:29:34.574Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32212806,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-24T03:15:14.334Z","status":"ssl_error","status_checked_at":"2026-04-24T03:15:11.608Z","response_time":64,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["config","configuration","dotenv","environment-variables","node","nodejs"],"created_at":"2025-01-19T08:19:34.564Z","updated_at":"2026-04-24T06:33:20.079Z","avatar_url":"https://github.com/urbanjs.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# urbanjs-config\n[![Build Status](https://travis-ci.org/urbanjs/urbanjs-config.svg?branch=master)](https://travis-ci.org/urbanjs/urbanjs-config)\n\n## Install\n\n```\nyarn add urbanjs-config\n```\n\n## Usage\n\nFor advanced use cases see [examples](https://github.com/urbanjs/urbanjs-config/tree/master/examples)\n\nExample `config.js` file:\n\n```javascript\n'use strict';\n\nconst es6TemplateResolver = require('es6-template-strings');\nconst config = require('urbanjs-config');\n\nconst defaults = {\n  port: 3000,\n  serverOrigin: 'http://localhost:${port}',\n  useSecureCookies: false\n};\n\nmodule.exports =\n  config.resolveReferences(\n    config.applyEnvironmentVariables(defaults, 'MY_APP'),\n    es6TemplateResolver\n  );\n```\n\n## Motivation\n\n`urbanjs-config` does not want to implement all features of configuration management.\nThis package tries to add the bare minimum utility functions to set up the configuration of applications with ease.\nCombine this package with [dotenv](https://www.npmjs.com/package/dotenv) and you're good to go.\n\nOther features (if necessary):\n- *custom config storage* - config should be a plain object literal\nand [json pointer](https://www.npmjs.com/package/jsonpointer) or [lodash](https://www.npmjs.com/package/lodash)\ncan be used to retrieve data\n- *complex coercing* - config should be a plain object literal with `number`, `string` and `boolean` values\n- *validation* - use `json schema` for this purpose, see [example](https://github.com/urbanjs/urbanjs-config/blob/master/examples/05-validation.ts)\n- *support of command line arguments* - use environment variables based on [the twelve-factor app methodology](https://12factor.net/config)\n- *support of config files* - use environment variables based on [the twelve-factor app methodology](https://12factor.net/config)\n- *event listeners* - why would config change at runtime?\n\n## API\n\n## .applyEnvironmentVariables(config, [prefix], [store])\n\nUpdates the given `config` with the environment variables.\nIf prefix is given, environment variables must start with `\u003cPREFIX\u003e__`.\n\nDefaults:\n  - prefix: empty string\n  - store: `process.env`\n\n```typescript\nimport { applyEnvironmentVariables } from 'urbanjs-config';\n\ntype Configuration = {\n  port: number;\n  serverOrigin: string;\n  useSecureCookies: boolean;\n};\n\nconst defaults: Configuration = {\n  port: 3000,\n  serverOrigin: 'http://localhost:3000',\n  useSecureCookies: false\n};\n\nexport const config = applyEnvironmentVariables\u003cConfiguration\u003e(\n  defaults,\n  'MY_PREFIX'\n);\n```\n\n*Note:* the example above will update the configuration\n        if either `MY_PREFIX__PORT`, `MY_PREFIX__SERVER_ORIGIN` or `MY_PREFIX__USE_SECURE_COOKIES`\n        are defined within `process.env`.\n\n*Note:* Environment variables are always strings but\n        they are transformed based on the original type of the config value.\n        **Only boolean, string and number values are supported.**\n\n*Note:* Nested objects are also supported.\n\n*Note:* config key is transformed based on the [.toConstantCase()](https://github.com/urbanjs/urbanjs-config/blob/master/src/utils.ts#L1) api\n\n## .resolveReferences(config, resolver)\n\nResolves `references` within the config value. A `reference` refers to another config value based on its key.\n\nA resolver method can be implemented based on:\n\n`export type Resolver = (value: string, config: object) =\u003e string;`\n\n```typescript\nimport es6TemplateResolver = require('es6-template-strings');\nimport { resolveReferences } from 'urbanjs-config';\n\ntype Configuration = {\n  port: number;\n  serverOrigin: string;\n};\n\nconst defaults: Configuration = {\n  port: 3000,\n  serverOrigin: 'http://localhost:${port}'\n};\n\nexport const config = resolveReferences(\n  defaults,\n  es6TemplateResolver\n);\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Furbanjs%2Furbanjs-config","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Furbanjs%2Furbanjs-config","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Furbanjs%2Furbanjs-config/lists"}