Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 1.56 KB

README.md

File metadata and controls

58 lines (40 loc) · 1.56 KB
Raw

Catty

Catty is the source file concatenator for Mapshaper.

Some features:

  • Each source file lists its dependencies in a formatted comment (see below). There is no manifest, unlike some other tools.
  • Concatenated files are (optionally) wrapped in a self-executing function, to protect the global namespace.
  • Catty can monitor source files and regenerate output files when a required source file changes.

Command line tool

Usage: $ catty [options] input output

Options:

  • -f Monitor source files, re-cat when something changes.
  • -g Don't wrap source files in an immediate function.
  • -d Comma-separated list of directories to monitor
  • -h Print help message

Example: $ catty -g -d src,lib src/input.js dist/output.js

Node module

Example

require('catty')({global: true})
	.addLibrary('src')
	.addLibrary('lib')
	.cat('src/input.js', 'dist/output.js');

Methods

#cat(input, output) Concatenate an input file with its dependencies. output may be a filename or a Node-style callback. If output is empty or contains a hyphen, catty sends its output to stdout.

#addLibrary(dir) Give catty a directory to search for dependencies.

#prepend(JS) Insert JavaScript before concatenated code.

#addDeps(deps) Inject one or more additional dependencies into the input file (comma-sep. list).

Comment format

Examples

/* @requires
mapshaper-innerlines
mapshaper-endpoints
mapshaper-dataset-utils
*/

/* @requires mapshaper-shapes, mapshaper-shape-geom */

ls