File: README.md

package info (click to toggle)
node-catty 0.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid, trixie
  • size: 136 kB
  • sloc: javascript: 449; makefile: 2
file content (58 lines) | stat: -rw-r--r-- 1,594 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
## Catty ##

Catty is the source file concatenator for [Mapshaper](https://github.com/mbloch/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