# dot-file-config

> Manage application state via config in json dot-file

Latest version **0.6.1** (published 2016-01-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install dot-file-config
pnpm add dot-file-config
yarn add dot-file-config
bun add dot-file-config
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.1 |
| Published | 2016-01-29 |
| First published | 2015-06-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | ewnd9 |
| Maintainers | ewnd9 |

## Links

- npm: https://www.npmjs.com/package/dot-file-config
- Repository: https://github.com/ewnd9/dot-file-config
- Homepage: https://github.com/ewnd9/dot-file-config#readme
- Issues: https://github.com/ewnd9/dot-file-config/issues
- npm.io page: https://npm.io/package/dot-file-config

## Dependencies (1)

- [user-home](https://npm.io/package/user-home.md) ^2.0.0

## Recent versions

- 0.6.1 (latest) — 2016-01-29
- 0.6.0 — 2016-01-28
- 0.5.0 — 2015-08-15
- 0.4.0 — 2015-08-09
- 0.3.1 — 2015-08-05
- 0.3.0 — 2015-08-05
- 0.2.0 — 2015-08-02
- 0.1.0 — 2015-07-28
- 0.0.3 — 2015-07-10
- 0.0.2 — 2015-06-24
- 0.0.1 — 2015-06-06

## README

# dot-file-config

[![Build Status](https://travis-ci.org/ewnd9/dot-file-config.svg?branch=master)](https://travis-ci.org/ewnd9/dot-file-config)

> A dot-file is generally any file whose name begins with a full stop. https://en.wikipedia.org/wiki/Dot-file

Manage application state via config in json dot-file

## Install

```
$ npm install dot-file-config --save
```

## Usage

```js
var config = require('dot-file-config')('.your-app-name', {
	defaultConfigFile: <String>, // relative path
	onFirstRun: <Function> // optional
});

config.path // path to config file
config.defaultPath // absolute path to default config file (argument can be relative)
config.data // content of dot-file
config.isFirstRun // true when config didn't exist before
config.save() // persist config.data back to dot-file
```

## Changelog

- `v0.6.0`

	- Removed symlinking to Dropbox
	- options' `firstRunCallback` renamed to `onFirstRun`

## Related

- [configstore](https://github.com/yeoman/configstore)
- [text-db](https://github.com/asarode/text-db)
- [node-store](https://github.com/alexkwolfe/node-store)
- [jsop](https://github.com/typicode/jsop)

## License

MIT © [ewnd9](http://ewnd9.com)

---
_Source: https://npm.io/package/dot-file-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._