{"id":16228525,"url":"https://github.com/poppa/key-value-file","last_synced_at":"2026-01-30T19:31:40.818Z","repository":{"id":35121633,"uuid":"209330479","full_name":"poppa/key-value-file","owner":"poppa","description":"Simple key/value file parser/writer","archived":false,"fork":false,"pushed_at":"2024-08-21T04:43:56.000Z","size":1222,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-22T02:00:47.394Z","etag":null,"topics":["dotenv","dotenv-parser","keyvalue","keyvalue-files","nodejs","parser","typescript"],"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/poppa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-18T14:33:59.000Z","updated_at":"2024-08-21T04:43:24.000Z","dependencies_parsed_at":"2024-08-21T05:44:14.219Z","dependency_job_id":"c9f9b2a4-e4a6-468c-b0f5-679ad0f864f5","html_url":"https://github.com/poppa/key-value-file","commit_stats":{"total_commits":61,"total_committers":3,"mean_commits":"20.333333333333332","dds":0.2622950819672131,"last_synced_commit":"66f028409e9bcfb07cd1bed2d6fb8de61f2d7f42"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/poppa/key-value-file","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/poppa%2Fkey-value-file","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/poppa%2Fkey-value-file/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/poppa%2Fkey-value-file/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/poppa%2Fkey-value-file/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/poppa","download_url":"https://codeload.github.com/poppa/key-value-file/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/poppa%2Fkey-value-file/sbom","scorecard":{"id":741146,"data":{"date":"2025-08-11","repo":{"name":"github.com/poppa/key-value-file","commit":"033759c9164ce9c692c2dbffee055054faeae8fd"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.5,"checks":[{"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":"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":"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":"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":"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:0","Info: FSF or OSI recognized license: MIT License: LICENSE: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":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 25 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":3,"reason":"7 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"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-22T17:30:37.281Z","repository_id":35121633,"created_at":"2025-08-22T17:30:37.281Z","updated_at":"2025-08-22T17:30:37.281Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28918214,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-30T19:10:10.838Z","status":"ssl_error","status_checked_at":"2026-01-30T19:06:40.573Z","response_time":66,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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":["dotenv","dotenv-parser","keyvalue","keyvalue-files","nodejs","parser","typescript"],"created_at":"2024-10-10T12:55:41.548Z","updated_at":"2026-01-30T19:31:40.803Z","avatar_url":"https://github.com/poppa.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# key-value-file\n\nThis is a simple **key/value file** parser/writer. Its initial purpose is to\nhandle parsing of `.env` files.\n\nThe main purpose is to be able to alter `.env` files programmatically\n\n# Usage\n\n## Manipulate an existing file\n\n```ts\n/* my-environment.env\n\nkey1 = value1\nkey2 = 2\n\nkey3= Some value with spaces\n*/\n\nimport { parseFile } from 'key-value-file'\n\nasync function myFunc() {\n  const kv = await parseFile('my-environment.env')\n\n  kv.rename('key1', 'keyOne')\n    .set('key2', 4)\n    .delete('key3')\n    .set('key4', 'new value')\n    .writeFile()\n}\n```\n\nThis will write the following to `my-environment.env`:\n\n```\nkeyOne = value1\nkey2 = 4\n\nkey4=new value\n```\n\n## Create a new file programmatically\n\n`KeyValueFile.create('file.ext')` loads the file if it exists. Otherwise the\nfile will be created when `KeyValueFile.writeFile()` is called.\n\n```ts\nimport { KeyValueFile } from 'key-value-file'\nconst file = KeyValueFile.create('.env')\n\nfile\n  .set('key1', 'Value 1')\n  .set('key2', 'Value 2')\n  .addNewline()\n  .addComment('Only used in test environment')\n  .set('test1', 1)\n  .set('test2', 2)\n  .writeFile()\n```\n\nThis will create a file with the following content:\n\n```\nkey1=Value 1\nkey2=Value 2\n\n# Only used in test environment\ntest1=1\ntest2=2\n```\n\n# Quick doc\n\n- **`async parseFile(path: PathLike): KeyValueFile`**\n\n- **`KeyValueFile`**\n\n  - **`path`**\n    Property that returns the file path of the key/value file.\n\n  - **`set(key: string, value: string | number): this`**\n    Set the value of `key` to `value`. If `key` doesn't exist it is created.\n\n  - **`get(key: string): string | undefined`**\n    Returns the value of `key`, or `undefined` if the key doesn't exist.\n\n  - **`delete(key: string): this`**\n    Delete the key `key` and its value.\n\n  - **`rename(key: string, newName: string): this`**\n    Rename the key `key` to `newName`.\n\n  - **`async writeFile(normalizeWhitespace = false): this`**\n    Write the current data to the path of `KeyValueFile`. If\n    `normalizeWhitespace` is `true` all excessive whitespace will be removed.\n\n  - **`toString(normalizeWhitespace = false): string`**\n    Convert the data to a key/value string. If `normalizeWhitespace` is\n    `true` all excessive whitespace will be removed.\n\n# TODO\n\n- ~~**Handle missing/empty values**~~ _(fixed)_\n  ~~Things will probably break right now if something like `key= ` occurs.~~\n\n- **Documentation**\n  Oh, how we like that.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpoppa%2Fkey-value-file","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpoppa%2Fkey-value-file","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpoppa%2Fkey-value-file/lists"}