# node-ssi

> A SSI parser

Latest version **0.3.2** (published 2016-04-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-ssi
pnpm add node-ssi
yarn add node-ssi
bun add node-ssi
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.2 |
| Published | 2016-04-14 |
| First published | 2014-08-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 16 |
| Author | yanni4night@gmail.com |
| Maintainers | yinyongcom666 |
| Keywords | ssi |

## Links

- npm: https://www.npmjs.com/package/node-ssi
- Repository: https://github.com/yanni4night/node-ssi
- Issues: https://github.com/yanni4night/node-ssi/issues
- npm.io page: https://npm.io/package/node-ssi

## Dependencies (2)

- [async](https://npm.io/package/async.md) ~1.4.2
- [extend](https://npm.io/package/extend.md) ~3.0.0

## Alternatives

- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads

## Recent versions

- 0.3.2 (latest) — 2016-04-14
- 0.3.1 — 2015-10-09
- 0.3.0 — 2014-12-04
- 0.2.2 — 2014-11-22
- 0.2.1 — 2014-11-05
- 0.2.0 — 2014-11-03
- 0.1.3 — 2014-09-23
- 0.1.2 — 2014-09-23
- 0.1.1 — 2014-08-25
- 0.1.0 — 2014-08-20

## README

node-ssi
======

[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency status][david-dm-image]][david-dm-url] [![Build status][appveyor-image]][appveyor-url] [![Built with Grunt][grunt-image]][grunt-url]

A server-side-include system for nodejs.

We only support parts of nginx ssi syntax:


      <!--# include file="path" -->
      <!--# include virtual="path" -->

      <!--# set var="k" value="v" -->

      <!--# echo var="n" default="default" -->

      <!--# if expr="test" -->
      <!--# elif expr="" -->
      <!--# else -->
      <!--# endif -->

Note:

* `file` includes are always relative to the baseDir provided in the options.
* `virtual` includes are relative to the current file.

usage
======

    var SSI = require('node-ssi');
    var ssi = new SSI({
            baseDir: './html/',
            encoding: 'utf-8'
            payload: {
                v: 5
            }
        });

    // handle a file
    ssi.compileFile('index.html', {payload:{title: 'Index'}}, function(err, content){

        });

    //handle a content
    ssi.compile('<!--# echo var="v" default="default" -->', function(err,content){

        });

test
======

`grunt test`

changelog
======
 - 2014-11-03[17:00:51]:support special chars like `\n`,`\v` etc.
 - 2014-12-04[12:39:20]:thanks for @nfriedly,we fixed some bugs and support more features

todo
======
better lexer

license
======

MIT

[downloads-image]: http://img.shields.io/npm/dm/node-ssi.svg
[npm-url]: https://npmjs.org/package/node-ssi
[npm-image]: http://img.shields.io/npm/v/node-ssi.svg

[travis-url]: https://travis-ci.org/yanni4night/node-ssi
[travis-image]: http://img.shields.io/travis/yanni4night/node-ssi.svg

[grunt-url]:http://gruntjs.com/
[grunt-image]: https://cdn.gruntjs.com/builtwith.png

[appveyor-image]:https://ci.appveyor.com/api/projects/status/6sv21grqrixe60yu?svg=true
[appveyor-url]:https://ci.appveyor.com/project/yanni4night/node-ssi

[david-dm-url]:https://david-dm.org/yanni4night/node-ssi
[david-dm-image]:https://david-dm.org/yanni4night/node-ssi.svg

---
_Source: https://npm.io/package/node-ssi · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._