Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dsifford/confzen

A command line utility for creating and maintaining configuration files for javascript and typescript projects
https://github.com/dsifford/confzen

Last synced: about 1 month ago
JSON representation

A command line utility for creating and maintaining configuration files for javascript and typescript projects

Awesome Lists containing this project

README

        

![Imgur](http://i.imgur.com/e2ajwrz.png)

# confzen [![Build Status](https://travis-ci.org/dsifford/confzen.svg?branch=master)](https://travis-ci.org/dsifford/confzen)
> A command line utility for creating and maintaining configuration files for javascript and typescript projects.

## Why?
Trying to remember the options that are available for the various compilers and linters is hard. This project assumes that responsibility.

## Currently Available Configurations
- TypeScript
- TSLint
- ESLint
- Babel

> Need more? Send a PR. The only requirement is a JSON Schema.

## Example

[![asciicast](https://asciinema.org/a/23ftzqfwqu77hhbgihxovjcgn.png)](https://asciinema.org/a/23ftzqfwqu77hhbgihxovjcgn)

## Installation

`npm`
```
npm install -g confzen
```

`yarn`
```
yarn global add confzen
```

## Usage

```sh
$ confzen [path/to/config]
```

If a path is passed as a parameter, the path is checked to see if a configuration file of that type exists. If the file exists, it is opened for modification.

If no file is found in the path provided, a new file is created.

If no path is given, the current directory is used as default.

### Keybindings

> **TL;DR** All the expected vim bindings are enabled.

Action | Key
--- | ---
Navigation | Arrow keys **OR** h j k l
Select Option | Enter
Search downward | / then `search term` then Enter
Search upward | ? then `search term` then Enter
Toggle focus between JSON preview and configuration list | Tab
Quit | q