Meuhitneuh NPM

MeuhItNeuh

MeuhItNeuh is a mower simulator. From a lawn description and a list of mowers with a trajectory, it computes the final position of the mowers on the lawn.

Installation

Install the package globally.

$ npm install meuhitneuh -g

CLI usage

Simple usage

$ meuhitneuh --input /path/to/input/file --output /path/to/output/file

Advanced usage:

Usage: meuhitneuh [options]

Options:

  -h, --help           output usage information
  -V, --version        output the version number
  -i, --input <file>   Input config UTF-8 file
  -o, --output <file>  Output result UTF-8 file
  -l, --log [level]    Log level [info]

NodeJS usage

Install the package locally

$ npm install meuhitneuh

Example of code

// import
var App = require('meuhitneuh');

// build the app from input and output files
var app = new App(inputFile, outputFile);

// load input file content
app.loadInputFile();

// create a callback function
var mowerFinished = function mowerFinished(mower) {
  // mower is the Mower instance that has finished its trajectory
  console.log(mower);
};

// launch mowing process
app.runMowing(mowerFinished);

// write output file
app.writeOutputFile();

Developpement

Init

Note: if your are on Windows, ensure that your are pulling original files (including the EOF) by tuning up the Git configuration

$ git config --global core.autocrlf false

Pull the code from the github repo:

$ git clone https://github.com/spicquenot/meuhitneuh.git

Install npm dependencies

$ cd meuhitneuh
$ npm install

Build with Gulp

The build contains:

a syntax checker: ESLint
a test framework with tests: mocha (tests are stores in the ./test folder)
a JSDoc documentation builder: documentation (documentation is generated in the ./doc folder)