\n \n Daniel Bannert's open source work is supported by the community on GitHub Sponsors\n \n
\n
\n\n---\n\n## Install\n\n```sh\nnpm install @anolilab/rc\n```\n\n```sh\nyarn add @anolilab/rc\n```\n\n```sh\npnpm add @anolilab/rc\n```\n\n## Usage\n\nThe main function provided by this module is rc. It allows you to load configuration settings for your application from different sources.\n\n```ts\nimport { rc } from \"@anolilab/rc\";\n\nconst { config, files } = rc(\"npm\");\n\n// returns a merged config object with all found npmrc files and a files list what files where found.\n```\n\n### Api\n\n- name (string): The application name. This is used to locate configuration files and environment variables.\n- options (object, optional): An object with the following properties:\n - config (string, optional): Path to a specific configuration file.\n - cwd (string, optional): The current working directory to start searching for configuration files. Defaults to process.cwd().\n - defaults (object, optional): Default configuration values.\n - home (string, optional): The home directory to use. Defaults to os.homedir().\n - stopAt (string, optional): Directory to stop searching for configuration files.\n\n## Standards\n\nGiven your application name (appname), rc will look in all the obvious places for configuration.\n\n- The defaults object you passed in\n- `/etc/${appname}/config`\n- `/etc/${appname}rc`\n- `$HOME/.config/${appname}/config`\n- `$HOME/.config/${appname}`\n- `$HOME/.${appname}/config`\n- `$HOME/.${appname}rc`\n- a local `.${appname}/config` and `.${appname}rc` and all found looking in `../../../ ../../ ../ ./` etc.\n- if you passed environment variable `${appname}_config` then from that file\n- if you passed options.config variable, then from that file\n- environment variables prefixed with `${appname}_`\n or use \"\\_\\_\" to indicate nested properties _(e.g. `appname_foo__bar__baz` => `foo.bar.baz`)_\n\nAll configuration sources that were found will be flattened into one object, in this exact order.\n\n## Api Docs\n\n\n\n# @anolilab/rc\n\n## Functions\n\n### rc()\n\n```ts\nfunction rc(name, options?): object;\n```\n\nDefined in: [index.ts:193](https://github.com/anolilab/multi-semantic-release/blob/589293f977a51773a6380f8abdc37be2f9e43372/packages/rc/src/index.ts#L193)\n\nAggregates configuration from multiple sources (defaults, configuration files, and environment variables)\ninto a single object, following the same resolution logic as the original `rc` npm package.\n\nThe resolution order is (highest precedence last):\n\n1. `options.defaults` – default values supplied by the caller\n2. Configuration files discovered by getConfigFiles\n3. Environment variables that start with `${name}_` (nested via `__`)\n\nThe function also returns the list of configuration file paths that were read while resolving the\nconfiguration. No mutation is performed on any of the discovered files – they are only read.\n\n#### Parameters\n\n##### name\n\n`string`\n\nThe base name of the application (used to derive env-var prefix and file names).\n\n##### options?\n\nOptional behaviour switches.\n\n###### config?\n\n`string`\n\nExplicit path to a configuration file that should be merged last.\n\n###### cwd?\n\n`string`\n\nWorking directory to start searching for local configuration files.\n\n###### defaults?\n\n`Record`\\<`string`, `any`\\>\n\nDefault configuration values that act as the lowest precedence.\n\n###### home?\n\n`string`\n\nHome directory to look for user-level configuration files. Defaults to the current user home directory.\n\n###### stopAt?\n\n`string`\n\nAbsolute path that acts as a boundary when traversing up the directory tree.\n\n#### Returns\n\n`object`\n\nAn object containing the final merged `config` and the ordered list of `files` that were considered.\n\n##### config\n\n```ts\nconfig: Record;\n```\n\n##### files\n\n```ts\nfiles: string[];\n```\n\n\n\n## Related\n\n- [rc](https://github.com/dominictarr/rc) - The non-configurable configuration loader for lazy people.\n\n## Supported Node.js Versions\n\nLibraries in this ecosystem make the best effort to track [Node.js’ release schedule](https://github.com/nodejs/release#release-schedule).\nHere’s [a post on why we think this is important](https://medium.com/the-node-js-collection/maintainers-should-consider-following-node-js-release-schedule-ab08ed4de71a).\n\n## Contributing\n\nIf you would like to help take a look at the [list of issues](https://github.com/anolilab/semantic-release/issues) and check our [Contributing](.github/CONTRIBUTING.md) guidelines.\n\n> **Note:** please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.\n\n## Credits\n\n- [Daniel Bannert](https://github.com/prisis)\n- [All Contributors](https://github.com/anolilab/semantic-release/graphs/contributors)\n\n## Made with ❤️ at Anolilab\n\nThis is an open source project and will always remain free to use. If you think it's cool, please star it 🌟. [Anolilab](https://www.anolilab.com/open-source) is a Development and AI Studio. Contact us at [hello@anolilab.com](mailto:hello@anolilab.com) if you need any help with these technologies or just want to say hi!\n\n## License\n\nThe anolilab rc is open-sourced software licensed under the [MIT][license-url]\n\n\n\n[license-badge]: https://img.shields.io/npm/l/@anolilab/rc?style=for-the-badge\n[license]: https://github.com/anolilab/multi-semantic-release/blob/main/LICENSE\n[npm-downloads-badge]: https://img.shields.io/npm/dm/@anolilab/rc?style=for-the-badge\n[npm-downloads]: https://www.npmjs.com/package/@anolilab/rc\n[prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge\n[prs-welcome]: https://github.com/anolilab/multi-semantic-release/blob/main/.github/CONTRIBUTING.md\n[chat-badge]: https://img.shields.io/discord/902465130518949899.svg?style=for-the-badge\n[chat]: https://discord.gg/eajEZvk2PG\n[typescript-badge]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript\n[typescript-url]: https://www.typescriptlang.org/\n[license-url]: LICENSE.md\n","readmeFilename":""}
![\"rc\"](\"__assets__/package-og.svg\")
\n\n