# node-a2conf
> node-a2conf is a JavaScript module which provides an easy way to configure apache2.
Latest version **0.2.0** (published 2023-02-13) · MIT license · 0 weekly downloads
## Install
```sh
npm install node-a2conf
pnpm add node-a2conf
yarn add node-a2conf
bun add node-a2conf
```
## Health
**Score 30/100 (F)** — status: abandoned.
Positive: has types; esm support; no vulnerabilities; high quality score.
Warnings: low downloads; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.2.0 |
| Published | 2023-02-13 |
| First published | 2023-02-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 71.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Thibault Ehrhart |
| Maintainers | ehrhart |
| Keywords | typescript, node, npm, apache2, config, configuration, parse, vhost |
## Links
- npm: https://www.npmjs.com/package/node-a2conf
- Repository: https://github.com/ehrhart/node-a2conf
- Issues: https://github.com/ehrhart/node-a2conf/issues
- npm.io page: https://npm.io/package/node-a2conf
## Alternatives
- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads
## Recent versions
- 0.2.0 (latest) — 2023-02-13
- 0.1.0 — 2023-02-02
## README
# node-a2conf
node-a2conf is a JavaScript module which provides an easy way to configure apache2.
[](https://www.npmjs.com/package/node-a2conf) [](https://github.com/ehrhart/node-a2conf/releases) [](https://github.com/ehrhart/node-a2conf/blob/main/LICENSE)
## Development
### Install dependencies
Install dependencies with npm:
```bash
npm i
```
### Test
Test the code with Jest framework:
```bash
npm run test
```
**Note:** This package uses [husky](https://typicode.github.io/husky/), [pinst](https://github.com/typicode/pinst) and [commitlint](https://commitlint.js.org/) to automatically execute test and [lint commit message](https://www.conventionalcommits.org/) before every commit.
### Build
Build production (distribution) files in the **dist** folder:
```bash
npm run build
```
It generates CommonJS (in **dist/cjs** folder), ES Modules (in **dist/esm** folder), as well as TypeScript declaration files (in **dist/types** folder).
## Examples
### Read and parse from a configuration file
```js
const { fromFile } = require('node-a2conf');
const root = await fromFile('example.conf');
for (const vhost of root.children('VirtualHost')) {
console.log(vhost.first('ServerName'));
}
```
### Read and parse from a text string
```js
const { fromText } = require('node-a2conf');
const root = await fromText(`
ServerAdmin postmaster@example.com
ServerName example.com
ServerAlias www.example.com example.example.com
ServerAlias x.example.com
DocumentRoot /usr/local/apache/htdocs/example.com
SSLEngine On
`);
root.findVHost('example.com')?.set('SSLEngine', 'Off')
console.log(root.dump());
```
### Create a new configuration
```js
const { Node } = require('node-a2conf');
const root = new Node();
const vhost = root.insert('');
vhost.insert('ServerName example.net');
vhost.insert('DocumentRoot /var/www/examplenet/');
vhost.insert('ServerAlias www.example.net', 'servername');
console.log(root.dump());
/*
ServerName example.net
ServerAlias www.example.net
DocumentRoot /var/www/examplenet/
*/
```
### API
#### `Node`
##### `isOpen()`
Returns true if this node opens section, e.g `` or ``.
##### `isClose()`
Returns true if this node closes section.
##### `add(child: Node)`
Append child to node.
##### `addRaw(raw: string)`
Append string as child to node.
##### `insert(childNode: Node | string, afterNode?: Node | string)`
Insert child after another node.
##### `set(name: string, value: string)`
Set the value of a property given its name. If multiple properties with the same name are in the node, they will all be replaced.
##### `getOpenTag()`
Returns the open tag, e.g ``.
##### `getCloseTag()`
Returns the open tag, e.g ``.
##### `filter(pattern: RegExp | string)`
Returns children matching a pattern.
##### `children(name?: string, { recursive } = { recursive: false })`
Returns children matching name. Set `recursive` to true to search for nested nodes as well.
##### `first(name: string, { recursive } = { recursive: false })`
Returns the first child matching a name. Set `recursive` to true to search for nested nodes as well.
##### `extend(n: Node)`
Extends a node with another node.
##### `readText(text: string)`
Parses raw text and replace all content from that node with the newly parsed content.
##### `readFile(fileName: string)`
Parses a file and replace all content from that node with the newly parsed content.
##### `writeFile(fileName: string)`
Dumps the content of a node as a string into a file.
##### `dump(depth = 0)`
Dumps the content of a node as a string. Set `depth` to the base number of spaces to append on each line.
##### `toString()`
Returns the node name as a string.
##### `delete()`
Deletes the node from its parent.
##### `findVHost(hostname: string, arg?: string)`
Helper function to find a VHost given its name and optional arguments. Returns a `Node` or `null` if no VHost matches the parameters.
#### `fromText(text: string, props?: NodeProps)`
Reads and parses a file then returns a `Node` object.
#### `fromFile(fileName: string, props?: NodeProps)`
Parses a raw text string then returns a `Node` object.
## References
- https://github.com/yaroslaff/a2conf/
---
_Source: https://npm.io/package/node-a2conf · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._