clasp-js

CLASP.js

Command-Line Argument Sorting and Parsing, for JavaScript

Table of Contents

• Summary
• Introduction
• Installation & usage
  • The name
• Components
• Examples
• Project Information
  • Where to get help
  • Contribution guidelines
  • Dependencies
  • Related projects
  • License

Summary

CLASP stands for Command-Line Argument Sorting and Parsing. The first CLASP library was a C library with a C++ wrapper. There have been several implementations in other languages. CLASP.js is the JavaScript version.

Introduction

T.B.C.

Installation & usage

Install using npm install clasp-js.

Use it via require('clasp-js').

The name

NOTE: the name clasp-js follows NPM's package-name rules, but breaks with one of the tips - the one about not including js or node in the name - because there are multiple CLASP libraries, and there already exists a clasp package in NPM.

Components

T.B.C.

Examples

Examples are provided in the examples directory, along with a markdown description for each. A detailed list TOC of them is provided in EXAMPLES.md.

Project Information

Where to get help

GitHub Page

Contribution guidelines

Defect reports, feature requests, and pull requests are welcome on https://github.com/synesissoftware/CLASP.js.

Dependencies

• assert (Development-only);
• memory-streams (Development-only);
• mocha (Development-only);

Related projects

• CLASP.js is inspired by the C/C++ CLASP library, which is documented in the articles:

• An Introduction to CLASP, Matthew Wilson, CVu, January 2012;

• Anatomy of a CLI Program written in C, Matthew Wilson, CVu, September 2012; and

• Anatomy of a CLI Program written in C++, Matthew Wilson, CVu, September 2015;

• CLASP.Go;

• CLASP.NET;

• CLASP.Python;

• CLASP.Ruby.

License

CLASP.js is released under the 3-clause BSD license. See LICENSE for details.