savagecore / node-apache2-conf-formatter

A javascript port of https://github.com/bearx3f/a2conf - basic formatting

apache2-conf-formatter

Format apache2 configuration files

Install

$ npm install apache2-conf-formatter

Usage

const apache2ConfFormatter = require('apache2-conf-formatter');

console.log(apache2ConfFormatter.format('httpd.conf'));
//=> Promise <String> the formatted configuration file

API

format(path, [options])

Format the given file

arguments: path the path to file. options (optional) Object see options

returns: Promise <String> the formatted configuration file

options

useTabs

Type: boolean

Default: false

Indent lines with tabs instead of spaces

tabWidth

Type: number

Default: 2

Specify the number of spaces/tabs per indentation-level

License

MIT © SavageCore

node-apache2-conf-formatter's Issues

Enhancement for README : string vs Promise<String>

For anyone who wants the actual result and not just the Promise :

const apache2ConfFormatter = require('apache2-conf-formatter');

apache2ConfFormatter.format('httpd.conf').then(function (final_result) {
    console.log(final_result);
});

Sure, with a promise we can do anything we want. But the README shows console.log() for the promise, which is rather useless. If there is any mention at all of console.log() then it would probably be preferable to show the final result ... and then leave it to the user/developer's imagination about what else can be done with the data.

TY