Introduction

jsyang is a YANG (RFC 6020) parser, implemented in TypeScript.

Current version is 0.1.0, released 2017-06-27.

NOTE: Tested on OSX v10.11.6 with Node.js v8.1.2 and TypeScript v2.3.4. Not built for browser use (yet).

NOTE: This release doesn't do anything useful as a command line tool, except for validating a YANG-file. It's released in preparation for an upcoming YANG-plugin for Visual Studio Code.

Install

$ npm install jsyang

$ ./node_modules/.bin/jsyang <YANG-file>

$ jsyang --help
Usage: jsyang [options] [arguments]

Options:
  -h, --help  Show help
  -p, --path <directory>
  --parse-only Only the parsing step, no semantic analysis
  --test-prefix-suffix Output prefix-/suffix-lines used during tests
  --test-timestamps Show parse result times

Build

$ make deps
$ make build

Tests

$ make -C test deps
$ make -C test test

NOTE: The tests are dependent on Python 2.7 and GCC

Tools

##pyang pyang for inspiration and tests.

##lux Lux for tests.

##pegjs

pegjs for the XPATH-parser.

LICENSE

The MIT License (MIT)

Copyright (c) 2017 Nicklas Bystedt

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.