\r\n A function that resolves a config file and returns its content, or null if not found.\r\n
\r\n[![npm][npm]][npm-url] [![Build][travis-badge]][travis-url] [![Coverage Status][coverage-badge]][coverage-url]\r\n\r\n## Table of Contents\r\n\r\n- [About](#about)\r\n - [How to install](#how-to-install)\r\n- [Getting started](#getting-started-examples)\r\n - [Example: JSON config file](#example-json-config-file)\r\n - [Example: config file exporting a JS function](#example-JavaScript-function-config-file )\r\n - [Example: JavaScript config file exporting a JSON object](#EXAMPLE-JavaScript-config-file-exporting-a-JSON-object)\r\n - [Example: Loading a config file from one of several places or formats](#EXAMPLE-Loading-a-config-file-from-one-of-several-places-or-formats)\r\n- [Contributing and Internal Documentation](#contributing-and-internal-documentation)\r\n\r\n## About\r\n\r\nReading a config file is a pretty standard operation for just about any node project. The config-resolver provides a function to avoid repeating the same boilerplate config-loading code in every project.\r\n\r\n### How to install\r\n\r\nThe following commands will install config-resolver:\r\n\r\n```shell\r\nnpm install --save-dev @auturge/config-resolver\r\n```\r\n\r\nor\r\n\r\n```shell\r\nyarn add @auturge/config-resolver --dev\r\n```\r\n\r\n## Getting Started (Examples)\r\n\r\nconfig-resolver supports JavaScript or JSON config files.\r\n\r\nThe following examples assume the project has this shape:\r\n\r\n```none\r\ndemo\r\n├── conf/\r\n│ ├── config.json\r\n│ ├── config.js\r\n│ └── config.export.js\r\n│\r\n├── src/\r\n│ ├── index.js\r\n```\r\n\r\n---\r\n\r\n### EXAMPLE: JSON config file\r\n\r\n#### config.json\r\n\r\n```JSON\r\n{\r\n source: './package.json',\r\n destination: './build/package.json',\r\n keeplist: ['name', 'version'],\r\n loglevel: 'INFO',\r\n}\r\n```\r\n\r\n#### index.js\r\n\r\n```JavaScript\r\nconst path = require('path')\r\nconst { resolveConfig } = require('@auturge/config-resolver')\r\n\r\nconst options = {\r\n explicit: {\r\n path: path.resolve(__dirname, '../conf/demo.config.json'),\r\n type: 'json',\r\n },\r\n}\r\nconst config = resolveConfig(options)\r\n\r\nconsole.log(JSON.stringify(config, undefined, 2))\r\n```\r\n\r\n#### result\r\n\r\n```JSON\r\n{\r\n \"source\": \"./package.json\",\r\n \"destination\": \"./build/package.json\",\r\n \"keeplist\": [\r\n \"name\",\r\n \"version\"\r\n ],\r\n \"loglevel\": \"INFO\"\r\n}\r\n```\r\n\r\n---\r\n\r\n### EXAMPLE: JavaScript function config file\r\n\r\n#### config.js\r\n\r\n```JavaScript\r\nmodule.exports = (env) => {\r\n const isProd = env && env['prod'] === true\r\n\r\n const DESTINATION = './build/{0}/package.json'.replace(\r\n '{0}', isProd ? 'prod' : 'dev'\r\n )\r\n\r\n const config = {\r\n source: './package.json',\r\n destination: DESTINATION,\r\n keeplist: ['name', 'version'],\r\n loglevel: 'INFO',\r\n }\r\n\r\n return config\r\n}\r\n```\r\n\r\n#### index.js\r\n\r\n```JavaScript\r\nconst path = require('path')\r\nconst { resolveConfig } = require('@auturge/config-resolver')\r\n\r\nconst env = { prod: true }\r\nconst options = {\r\n explicit: {\r\n path: path.resolve(__dirname, '../conf/demo.config.js'),\r\n type: 'function',\r\n },\r\n}\r\nconst configFunction = resolveConfig(options)\r\nconst config = configFunction(env)\r\n\r\nconsole.log(JSON.stringify(config, undefined, 2))\r\n```\r\n\r\n#### result\r\n\r\n```JSON\r\n{\r\n \"source\": \"./package.json\",\r\n \"destination\": \"./build/prod/package.json\",\r\n \"keeplist\": [\r\n \"name\",\r\n \"version\"\r\n ],\r\n \"loglevel\": \"INFO\"\r\n}\r\n```\r\n\r\n---\r\n\r\n### EXAMPLE: JavaScript config file exporting a JSON object\r\n\r\n#### config.export.js\r\n\r\n```JavaScript\r\nmodule.exports = {\r\n source: './package.json',\r\n destination: './build/package.json',\r\n keeplist: ['name', 'version'],\r\n loglevel: 'INFO',\r\n}\r\n```\r\n\r\n#### index.js\r\n\r\n```JavaScript\r\nconst path = require('path')\r\nconst { resolveConfig } = require('@auturge/config-resolver')\r\n\r\nconst env = { prod: true }\r\nconst options = {\r\n explicit: {\r\n path: path.resolve(__dirname, '../conf/demo.config.js'),\r\n type: 'json',\r\n },\r\n}\r\nconst config = resolveConfig(options)\r\n\r\nconsole.log(JSON.stringify(config, undefined, 2))\r\n```\r\n\r\n#### result\r\n\r\n```JSON\r\n{\r\n \"source\": \"./package.json\",\r\n \"destination\": \"./build/package.json\",\r\n \"keeplist\": [\r\n \"name\",\r\n \"version\"\r\n ],\r\n \"loglevel\": \"INFO\"\r\n}\r\n```\r\n\r\n---\r\n\r\n### EXAMPLE: Loading a config file from one of several places or formats\r\n\r\nSuppose you want to allow users to place their config files in one of several places, or support multiple formats. Say you want to search for config files with the following precedence (where higher on the list is where we look first):\r\n\r\n```none\r\n./.trimrc\t\tor\t \t./trim.config.js,\r\n./conf/.trimrc \tor\t\t./conf/trim.config.js\r\n./conf/demo.config.js\r\n./conf/demo.config.json\r\n```\r\n\r\n#### index.js\r\n\r\n```JavaScript\r\nconst path = require('path')\r\nconst { resolveConfig } = require('@auturge/config-resolver')\r\n\r\nconst env = { prod: true }\r\nconst options = {\r\n alternatives: [\r\n {\r\n\t\t\t// another file that does not exist in our demo\r\n\t\t\tpath: './.trimrc', type: 'json'\r\n },\r\n {\r\n\t\t\t// a file that does not exist in our demo\r\n\t\t\tpath: './trim.config.js', type: 'function',\r\n\t\t\tpriority: 0\r\n },\r\n {\r\n\t\t\t// a file that does not exist in our demo\r\n\t\t\tpath: './conf/trim.config.js', type: 'function',\r\n\t\t\tpriority: 1\r\n },\r\n {\r\n\t\t\t// another file that does not exist in our demo\r\n\t\t\tpath: './conf/.trimrc', type: 'json',\r\n\t\t\tpriority: 1\r\n },\r\n {\r\n path: './conf/demo.config.js'), type: 'function',\r\n priority: 2\r\n },\r\n{\r\n path: './conf/demo.config.json'), type: 'json',\r\n priority: 3\r\n },\r\n ],\r\n}\r\nconst config = resolveConfig(options)\r\n\r\nconsole.log(JSON.stringify(config, undefined, 2))\r\n```\r\n\r\n#### result\r\n\r\nUsing the above code, config-resolver would find and attempt to load `./conf/demo.config.js`.\r\n\r\n---\r\n\r\n## Contributing and Internal Documentation\r\n\r\nThe auturge family welcomes any contributor, small or big. We are happy to elaborate, guide you through the source code and find issues you might want to work on! To get started have a look at our [documentation on contributing][contributing].\r\n\r\n[contributing]: https://github.com/auturge/config-resolver/blob/master/docs/CONTRIBUTING.md\r\n[npm]: https://img.shields.io/npm/v/auturge/config-resolver.svg\r\n[npm-url]: https://www.npmjs.com/package/auturge/config-resolver\r\n[travis-url]: https://travis-ci.com/github/auturge/config-resolver\r\n[travis-badge]: https://api.travis-ci.com/auturge/config-resolver.svg?branch=master\r\n[coverage-badge]: https://coveralls.io/repos/github/auturge/config-resolver/badge.svg\r\n[coverage-url]: https://coveralls.io/github/auturge/config-resolver\r\n","readmeFilename":"README.md"}