tson 0.1.0

Terse JSON - a compact binary JSON format for microcontrollers and constrained environments
Documentation 
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

## TSON Build System
##
## Usage:
##   make help           Show this help
##   make pre-push       Run every CI gate locally (fmt, clippy, features, test)
##   make fmt            Format the code (rustfmt)
##   make fmt-check      Check formatting without modifying (CI gate)
##   make clippy         Lint with clippy, warnings-as-errors (CI gate)
##   make features       Check no_std / std / all-features build (CI gate)
##   make check          Cargo check (all features)
##   make build          Release build
##   make test           Run all tests (Rust + Python + Node)
##   make test-rust      Cargo test
##   make test-python    Build Python wheel + pytest
##   make test-node      Build Node addon + node tests
##   make bench          Run benchmarks
##   make bench-size     Compression benchmark
##   make bench-perf     Performance benchmark
##   make clean          Cargo clean

.DEFAULT_GOAL := help


# Rust targets

check:  ## Cargo check (all features)

	cargo check --all-features


fmt:  ## Format code (rustfmt)

	cargo fmt


fmt-check:  ## Check formatting (CI gate: cargo fmt --check)

	cargo fmt --check


clippy:  ## Lint, warnings-as-errors (CI gate: cargo clippy -- -D warnings)

	cargo clippy -- -D warnings


features:  ## Check no_std / std-only / all-features builds (CI gate)

	@echo "==> no_std (core only)..."   && cargo check --no-default-features

	@echo "==> std (no json/dict)..."   && cargo check --no-default-features --features std

	@echo "==> all-features..."         && cargo check --all-features


build:  ## Release build

	cargo build --release


test-rust:  ## Run Rust tests

	cargo test


bench-size:  ## Compression benchmark

	cargo run --release --bin tson-bench


bench-perf:  ## Performance benchmark

	cargo run --release --bin comp-bench -- examples/telemetry.json


bench: bench-size bench-perf  ## All benchmarks


bump-version:  ## Bump version (usage: make bump-version V=0.2.0)

	@if [ -z "$(V)" ]; then echo "Usage: make bump-version V=0.2.0"; exit 1; fi

	@bash scripts/bump-version.sh $(V)

clean:  ## Cargo clean

	cargo clean


# Python targets

python-build:  ## Build Python wheel

	@echo "==> Building Python wheel..."

	@pip install maturin 2>/dev/null || true

	@cargo check --features python || { echo "FAIL: cargo check"; exit 1; }

	@maturin build --release 2>&1 | grep -q "Built wheel" && echo "   ok" || { echo "FAIL: maturin build"; echo "   Last output:"; maturin build --release 2>&1; exit 1; }

	@pip install target/wheels/tson-*.whl 2>/dev/null || true


test-python: python-build  ## Build + run Python tests

	@echo "==> Running Python tests..."

	@pytest python/tests/ -v 2>/dev/null || { echo "FAIL: pytest"; echo "   Install: pip install pytest"; }


# Node.js targets

node-build:  ## Build Node.js addon

	@echo "==> Building Node.js addon..."

	@cargo check --features nodejs || { echo "FAIL: cargo check"; exit 1; }

	@cd js && npm install --no-audit --no-fund >/dev/null 2>&1 || true

	@js/node_modules/.bin/napi build --platform --release -c js/package.json --features nodejs --cargo-flags="--lib" js 2>/dev/null && echo "   ok" || { echo "FAIL: napi build"; echo "   Install: cd js && npm install"; exit 1; }


test-node: node-build  ## Build + run Node tests

	@echo "==> Running Node.js tests..."

	@node js/test.js


# Combined targets

test: test-rust test-python test-node  ## Run all tests


## Run every gate CI enforces, in CI order, before pushing.
## Mirrors the "Rust (stable)" + "Feature gates" CI jobs. Run this and get a
## green result and the PR's Rust/feature checks will pass too.
pre-push: fmt-check clippy features test-rust  ## Run all CI gates locally

	@echo ""

	@echo "==> All pre-push checks passed. Safe to push."


all: build python-build node-build  ## Build everything


# Help

help:  ## Show this help

	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | \

		sort | \

		awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[36m%-18s\033[0m %s\n", $$1, $$2}'