@toonstrip/cli 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +50 -0
- package/package.json +15 -2
package/README.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# @toonstrip/cli
|
|
2
|
+
|
|
3
|
+
The `toonstrip` command-line tool. Currently one command: validating an
|
|
4
|
+
asset pack against the toonstrip pack contract.
|
|
5
|
+
|
|
6
|
+
Part of [toonstrip](https://github.com/dkdev24/toonstrip), a
|
|
7
|
+
framework-embeddable comic-strip renderer.
|
|
8
|
+
|
|
9
|
+
## Install
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
npm install -g @toonstrip/cli
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Or run without installing:
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
npx @toonstrip/cli pack validate ./my-pack
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
toonstrip pack validate <dir>
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Checks that `<dir>` is a valid toonstrip asset pack:
|
|
28
|
+
|
|
29
|
+
- `pack.json` exists and has the required shape (`name`, `version`,
|
|
30
|
+
`license`, `characters`, `backdrops`)
|
|
31
|
+
- every declared character's sheet image and manifest file exist
|
|
32
|
+
- every character has at least a `NEUTRAL` face (the minimum pose a caller
|
|
33
|
+
can always render)
|
|
34
|
+
- every declared backdrop file exists, with dimensions matching what
|
|
35
|
+
`pack.json` declares
|
|
36
|
+
|
|
37
|
+
Exits `0` and prints `OK: <dir> is a valid pack` on success; exits `1` and
|
|
38
|
+
lists every problem found on failure.
|
|
39
|
+
|
|
40
|
+
```
|
|
41
|
+
$ toonstrip pack validate packages/pack-comic-chat
|
|
42
|
+
OK: packages/pack-comic-chat is a valid pack
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
See [`docs/packs.md`](https://github.com/dkdev24/toonstrip/blob/main/docs/packs.md)
|
|
46
|
+
in the repo for the full pack contract and a walkthrough for building one.
|
|
47
|
+
|
|
48
|
+
## License
|
|
49
|
+
|
|
50
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@toonstrip/cli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
|
+
"description": "Command-line tool for validating toonstrip asset packs.",
|
|
4
5
|
"license": "MIT",
|
|
5
6
|
"type": "module",
|
|
6
7
|
"main": "./dist/index.js",
|
|
@@ -23,5 +24,17 @@
|
|
|
23
24
|
},
|
|
24
25
|
"publishConfig": {
|
|
25
26
|
"access": "public"
|
|
26
|
-
}
|
|
27
|
+
},
|
|
28
|
+
"keywords": [
|
|
29
|
+
"toonstrip",
|
|
30
|
+
"comic",
|
|
31
|
+
"cli"
|
|
32
|
+
],
|
|
33
|
+
"repository": {
|
|
34
|
+
"type": "git",
|
|
35
|
+
"url": "git+https://github.com/dkdev24/toonstrip.git",
|
|
36
|
+
"directory": "packages/cli"
|
|
37
|
+
},
|
|
38
|
+
"homepage": "https://github.com/dkdev24/toonstrip#readme",
|
|
39
|
+
"bugs": "https://github.com/dkdev24/toonstrip/issues"
|
|
27
40
|
}
|