hyperupcall / config

A deno module that helps you load configuration

config

A deno module that helps you load configuration.

⚠️ Warning The examples in this README pull from main. you may want to "pin" to a particular version by using git tags in the URL to direct you at a particular version. For example, to use v1.3.2 of hyperupcall/config, you would want to import https://deno.land/x/[email protected]/mod.ts.

Usage

import { Config } from "https://deno.land/x/config/mod.ts"

// Example
const config = await Config.load({
  file: 'fileName'
})
if (!config) {
  console.log("config is 'undefined' when no config files were found")
}

// Example including defaults
await Config.load({
  file: 'fileName',
  searchDir: Deno.cwd()
})

Options

• file the name of your file
• searchDir the directory to start searching. this is the directory that might include a .config file

Priority

The ordering is as follows. Modules are loaded from .config folder first, then the parent to that folder. Rc files in .config never start with a dot.

• .config/file.config.ts
• .config/file.config.js
• .config/file.toml
• .config/file.json
• .config/file.yaml
• .config/file.yml
• file.config.ts
• file.config.js
• .file.toml
• .file.json
• .file.yaml
• .file.yml

config's Issues

publish latest version to deno.land/x

the version on deno.land/x is from 2020

resolving config in home directory

Would be useful to check for config at ~/. This should be disabled by default and explicitly turned on via an option

resolving files ending in rc

Config files that end with rc are not resolved. Should they be? If so - needs to be implemented

look in to decodeUri to solve windows path issue

/C:/ on windows is not acceptable and breaks, look into solving this with decodeURI instead of hacky .slice workaround