npm.io
2.0.2 • Published 5 years ago

dotf

Licence
MIT
Version
2.0.2
Deps
2
Size
7 kB
Vulns
0
Weekly
0
Stars
2

dotf Build Status npm Version

Manage multiple dotfiles.

npm i dotf

Features

  • Supports multiple dotfiles
  • Absolute or relative dotfiles

Example

import dotf from 'dotf';

// Setup dotfiles
let dotglobal = dotf('~', 'myrc'); // Global (~)
let dotlocal = dotf(__dirname, 'myignore'); // Local (./)

// Write
let overwriteGlobal = await dotglobal.write({ myGlobal: 1337 });
let overwriteLocal = await dotlocal.write({ myLocal: 2674 });

// Exists
let globalExists = await dotglobal.exists();
let localExists = await dotlocal.exists();

// Read
let globalRead = await dotglobal.read();
let localRead = await dotlocal.read();

Why not use XXX instead?

  • I didn't see support for custom paths in dotfile in other packages (i.e. /dotfile).
  • This module provides 1 liner read/write/existance with the modern await syntax.

Tests (ava)

npm i
npm test