@svgsketch/cli 0.1.3 → 0.2.1

package/README.md

@@ -11,6 +11,7 @@ npm install -g @svgsketch/cli
 ## Commands
 
 ```bash
+svgsketch import <input.svg> -o <output.svgs>
 svgsketch validate <input>
 svgsketch render <input> -o <output.svg>
 svgsketch info <input>
@@ -21,6 +22,9 @@ svgsketch codegen <input> -f <svg|react|vue|d3|css>
 ## Examples
 
 ```bash
+# Import foreign SVG into the native document format
+svgsketch import artwork.svg -o artwork.svgs
+
 # Validate a document
 svgsketch validate design.svgs
 
@@ -33,3 +37,19 @@ svgsketch codegen icon.svgs -f react -o Icon.tsx --name Icon --typescript
 # Generate CSS+SVG markup
 svgsketch codegen design.svgs -f css -o design-snippet.svg
 ```
+
+## Render diagnostics
+
+`import`, `render`, and `codegen` report machine-readable diagnostics as `warning:` / `error:` lines on stderr.
+Import diagnostics also include their stable diagnostic code.
+Malformed SVG never produces a partial `.svgs` file.
+
+Render diagnostics include cases such as an unsupported shape type that was dropped from the output.
+The output is still written and the exit status stays `0`.
+Pass `--fail-on-warnings` to these commands to exit with a nonzero status when a warning is reported - useful in CI.
+
+```bash
+svgsketch import artwork.svg -o artwork.svgs --fail-on-warnings
+svgsketch render design.svgs -o out.svg --fail-on-warnings
+svgsketch codegen design.svgs -f react -o Icon.tsx --fail-on-warnings
+```

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@svgsketch/cli",
-  "version": "0.1.3",
+  "version": "0.2.1",
   "private": false,
-  "description": "CLI tool for rendering and validating SVGSketch documents",
+  "description": "CLI tool for importing SVG and working with SVGSketch documents",
+  "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "MIT",