Socket
Socket
Sign inDemoInstall

hariko

Package Overview
Dependencies
152
Maintainers
1
Versions
10
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    hariko

Mock Server that implements the API Blueprint specification.


Version published
Maintainers
1
Created

Changelog

Source

1.2.1 (2019-09-09)

Bug Fixes

  • added test case have a some copy (92ba325)
  • hariko-parser: support case on document has attributes #20 (a89b99f)

Features

  • hariko-logger: logger make from lib #20 (470492b)
  • hariko-parser: support body content is zero case #20 (a2de647)
  • hariko-parser: support case on document has copy in group section (394f958)
  • hariko-parser: support category in category structure (dd402c3)

Bug Fixes

  • resource/parser: fixed parser for protagonist v2 (16f88ab)
  • uri-parser: fix from eslint warnings (917dc95)

Features

  • hariko: replace parser logic, and remove old codes. (653f646)
  • hariko-parser: added hariko's parsing structure (3ab065c)
  • hariko-parser: added uri-parser (3732a9e)
  • hariko-parser: parsing resource and return entries (07dcb72)

Readme

Source

node-hariko

Mock Server that implements the API Blueprint specification.

npm version Build Status Code Climate Test Coverage

Get started

Installation

npm install -g hariko

Usage

hariko\
  -f <glob expression to your md files>\
  -p <server port>

Examples

for CLI

hariko -f 'docs/**/*.md' -p 8080 -w

for Node.js

var hariko = require('hariko')
hariko.start(
  {
    file: 'docs/**/*.md',
    watch: true
  },
  function() {
    console.log('Starting hariko server.')
  }
)

CLI Options

file

Filename in the node-glob format of API Blueprint.

hariko -f 'docs/**/*.md'

exclude

Exclude filename in the node-glob format.

hariko -f 'docs/**/*.md'\
       --exclude 'docs/metadata.md'\
       --exclude 'docs/overview.md'

port

Port number of API Server. By default 3000.

hariko -f 'docs/**/*.md' -p 8000

host

Hostname of API Server. By default localhost

hariko -f 'docs/**/*.md' --host '0.0.0.0'

watch

Watching changes for markdown files. By default false.

hariko -f 'docs/**/*.md' -w

This watch we have been using the gaze. If you want to exit the watch is, enter Ctrl + C.

output

Output in the form of HarikoReosurce to JSON.

hariko -f 'docs/**/*.md' -o 'api/'

When output option is enabled, the server can perform realtime data changes because reading JSON.

proxy

A origin for proxy request. By default false.

hariko -f 'docs/**/*.md' --proxy 'http://localhost:8100'

verbose

Output the verbose log. By default false.

hariko -f 'docs/**/*.md' -v

CORS

Send CORS header. By default false.

hariko -f 'docs/**/*.md' --cors

log-level

set to log level.

hariko -f 'docs/**/*.md' --log-level debug

time

Output the logging time. By default false.

hariko -f 'docs/**/*.md' -t

API

var hariko = require('hariko')

hariko.start(options [, startCalleback]);

hariko.start({ file: 'docs/**/*.md' }, function() {
  console.log('hariko started!')
})

Development

run build

> ./docker-dev/bin/build
> docker run --rm -it -v$(pwd):/usr/local/docker/app --name hariko hariko npm run build

run tests

> ./docker-dev/bin/build
> docker run --rm -it --name hariko hariko npm test

License

MIT

Keywords

FAQs

Last updated on 09 Sep 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc