circuitscript 0.5.5 → 0.5.6

package/README.md

@@ -1,3 +1,106 @@
-# circuitscript
+# Circuitscript
 
-CLI tool for the [circuitscript language](https://circuitscript.net)
+A code-based language for creating electronic schematics. Instead of clicking through GUI tools, you write Circuitscript to describe circuits — and get SVG/PDF schematics and KiCAD-compatible netlists as output.
+
+**Homepage:** https://circuitscript.net
+
+---
+
+## Features
+
+- **Code-first design** — capture schematics using a simple scripting language
+- **Version control friendly** — plain text files work naturally with git
+- **SVG and PDF output** — high-quality schematic diagrams
+- **KiCAD netlist export** — use generated netlists directly in KiCAD layout
+- **Bill of Materials** — export BOM as CSV
+- **Programmatic constructs** — loops, functions, conditionals, and modules for reusable circuit blocks
+- **Standard library of components** — resistors, capacitors, inductors, LEDs, etc.
+- **Custom components** — define components with arbitrary pin layouts and graphics
+- **ERC** — basic electrical rules check (more to be added)
+
+---
+
+## Installation
+
+Requires Node.js 16 or later.
+
+```bash
+npm install -g circuitscript
+```
+
+Or install locally as a library:
+
+```bash
+npm install circuitscript
+```
+
+---
+
+## Quick Start
+
+Create a file `circuit.cst`:
+
+```
+from "std" import *
+
+v5 = supply("5V")
+gnd = dgnd()
+
+at v5
+wire down 100
+add res(100k)
+wire down 100
+to gnd
+
+at v5
+wire down 100
+add cap(100n)
+wire down 100
+to gnd
+```
+
+Generate a schematic:
+
+```bash
+circuitscript circuit.cst output.svg
+```
+
+---
+
+## CLI Usage
+
+```
+circuitscript [input path] [output path] [options]
+```
+
+### Options
+
+| Option | Description |
+|--------|-------------|
+| `-w, --watch` | Watch for file changes and regenerate |
+| `-u, --update-source` | Update source file with reference designator annotation |
+| `-j, --annotated-path [file]` | Save annotated source file at given path |
+| `-n, --dump-nets` | Print net information |
+| `-d, --dump-data` | Dump data during parsing |
+| `-s, --stats` | Show stats during generation |
+| `-x, --skip-output` | Skip output generation |
+| `-e, --erc` | Enable ERC output |
+| `-b, --bom [output-path]` | Generate Bill of Materials as CSV |
+| `-i, --input text <text>` | Provide input text directly instead of a file |
+| `--version` | Show version |
+
+### Examples
+
+```bash
+# Generate SVG
+circuitscript schematic.cst schematic.svg
+
+# Generate PDF
+circuitscript schematic.cst schematic.pdf
+
+# Generate BOM
+circuitscript schematic.cst schematic.svg --bom bom.csv
+
+# Print to stdout
+circuitscript schematic.cst
+```

package/dist/cjs/index.js

@@ -31,6 +31,7 @@ __exportStar(require("./parser.js"), exports);
 __exportStar(require("./utils.js"), exports);
 __exportStar(require("./visitor.js"), exports);
 __exportStar(require("./sizing.js"), exports);
+__exportStar(require("./errors.js"), exports);
 __exportStar(require("./objects/types.js"), exports);
 __exportStar(require("./builtinMethods.js"), exports);
 __exportStar(require("./validate/SymbolTable.js"), exports);

package/dist/esm/index.js

@@ -15,6 +15,7 @@ export * from './parser.js';
 export * from './utils.js';
 export * from './visitor.js';
 export * from './sizing.js';
+export * from './errors.js';
 export * from './objects/types.js';
 export * from './builtinMethods.js';
 export * from './validate/SymbolTable.js';

package/dist/types/index.d.ts

@@ -15,6 +15,7 @@ export * from './parser.js';
 export * from './utils.js';
 export * from './visitor.js';
 export * from './sizing.js';
+export * from './errors.js';
 export * from './objects/types.js';
 export * from './builtinMethods.js';
 export * from './validate/SymbolTable.js';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "circuitscript",
-    "version": "0.5.5",
+    "version": "0.5.6",
     "description": "Interpreter for the circuitscript language",
     "homepage": "https://circuitscript.net",
     "engines": {
@@ -39,6 +39,7 @@
         "eslint-config-prettier": "~8.8",
         "eslint-plugin-jest": "~27.2",
         "jest": "~29.5",
+        "license-check-and-add": "^4.0.5",
         "prettier": "~2.8",
         "rimraf": "~5.0",
         "source-map-support": "^0.5.21",
@@ -76,7 +77,9 @@
         "changelog": "auto-changelog --handlebars-setup ../changelog/helper.js -p",
         "preversion": "npm run test",
         "version": "npm run changelog && git add CHANGELOG.md",
-        "copy-assets": "mkdir -p dist/fonts && mkdir -p dist/libs && cp -r fonts dist/ && cp -r libs dist/"
+        "copy-assets": "mkdir -p dist/fonts && mkdir -p dist/libs && cp -r fonts dist/ && cp -r libs dist/",
+        "license:check": "license-check-and-add check -f licensecheck.json",
+        "license:add": "license-check-and-add add -f licensecheck.json"
     },
     "boilerplate_author": "Jakub Synowiec <jsynowiec@users.noreply.github.com>",
     "license": "MIT",