https://github.com/yoannmoinet/dotconf

:ring: One file, to rule them all.
https://github.com/yoannmoinet/dotconf

Last synced: about 1 year ago
JSON representation

:ring: One file, to rule them all.

• Host: GitHub
• URL: https://github.com/yoannmoinet/dotconf
• Owner: yoannmoinet
• License: mit
• Created: 2015-12-01T05:00:35.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-09-08T13:08:14.000Z (almost 9 years ago)
• Last Synced: 2025-03-27T21:23:15.933Z (about 1 year ago)
• Language: JavaScript
• Homepage: http://yoannmoinet.github.io/dotconf
• Size: 630 KB
• Stars: 45
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![logo](./media/dotconf_med.png)

> One file, to rule them all.

[![build](https://travis-ci.org/yoannmoinet/dotconf.svg)](https://travis-ci.org/yoannmoinet/dotconf) [![npm version](https://img.shields.io/npm/v/dotconf.svg?style=flat)](https://npmjs.org/package/dotconf) ![status](https://img.shields.io/badge/stability-experimental-red.svg?style=flat)

---

`dotconf` will archive all your `.file|.directory` into **one single** `.conf`.

It will extract them when needed (advised in `npm postinstall`).

![example](./media/demo.gif)

## Installation

```bash

# Locally in your project [advised]

npm i dotconf --save

# Or globally

npm i dotconf -g

```

## Usage

```bash

dotconf [OPTIONS] [ARGS]

```

## Options

```bash

# Actions

-a,     --archive                   Archive your files

-e,     --extract                   Extract your files

# Options

-d,     --destination      [STRING] Destination of the archive

# Default is .file

-p,     --pattern          [STRING] Pattern to get file files

# Default is .*

-s,     --safe             [BOOL]   Execute in safe mode

# Default is true

        --safeDestination  [STRING] Destination of the safe storage

# Default is .tempDotConf

-i,     --ignore           [ARRAY]  What to ignore

# Default is .git*,node_modules/**,.file,.tempDotConf/**

# CLI related

-k,     --no-color                  Omit color from output

        --debug                     Show debug information

-v,     --version                   Display the current version

-h,     --help                      Display help and usage details

```

By default, options can be read in the `package.json` under `dotconf` object.

```json

"dotconf": {

    "destination": ".file",

    "safeDestination": ".tempDotConf",

    "safe": true,

    "pattern": ".*",

    "ignore": [

        ".git*",

        "node_modules/**" ,

        ".file",

        ".tempDotConf/**"

    ]

}

```