JSPM

@kgryte/examples-snippet

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
    • 0
  • Score
    100M100P100Q13631F
  • License MIT

Creates an examples file.

Package Exports

  • @kgryte/examples-snippet

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@kgryte/examples-snippet) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Examples Snippet

NPM version Build Status Coverage Status Dependencies

Creates an examples file.

Installation

$ npm install @kgryte/examples-snippet

Usage

var cp = require( '@kgryte/examples-snippet' );

cp( dest[, opts ][, clbk ] )

Asynchronously create a file in a specified destination directory.

cp( 'path/to/a/directory', onCreate );

function onCreate( error ) {
    if ( error ) {
        throw error;
    }
    console.log( 'Success!' );
}

The function accepts the following options: * template: snippet template name. Default: 'nodejs'.

By default, a nodejs template is used. To specify a different snippet template, set the template option.

cp( 'path/to/a/directory', {
    'template': 'nodejs'
});

cp.sync( dest[, opts] )

Synchronously create a file in a specified destination directory.

cp.sync( 'path/to/a/directory' );

The function accepts the same options as the asynchronous version.

Notes

  • Supported templates may be found in the `./lib` directory and are named according to the directory name.

Examples

var mkdirp = require( 'mkdirp' ),
    path = require( 'path' ),
    cp = require( '@kgryte/examples-snippet' );

var dirpath = path.resolve( __dirname, '../build/' + new Date().getTime() );

mkdirp.sync( dirpath );
cp.sync( dirpath, {
    'template': 'nodejs'
});

To run the example code from the top-level application directory,

$ node ./examples/index.js

CLI

Installation

To use the module as a general utility, install the module globally

$ npm install -g @kgryte/examples-snippet

Usage

Usage: examples-snippet [options] [destination]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.
  -tmpl  --template [name]     Template name. Default: 'nodejs'.
         --title [title]       Test title. Default: ''.

Examples

$ cd ~/my/project/directory
$ examples-snippet
# => creates a file in the current working directory

To specify a destination other than the current working directory, provide a destination.

$ examples-snippet ./../some/other/directory

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

License

MIT license.

Copyright © 2015. Athan Reines.