Skip to content

Commit 77a6a41

Browse files
committed
organized code quality tools documentation
1 parent b06b39a commit 77a6a41

File tree

6 files changed

+68
-1
lines changed

6 files changed

+68
-1
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,18 @@ pragmatic execution, and narrative continuity.
6363
HeraldStack operates on consent-based principles and follows clear ethical
6464
guidelines including those defined in LawsOfRobotics.json.
6565

66+
## Development Tools
67+
68+
- **Code Quality & Validation**: Scripts for checking and formatting code are
69+
available in `scripts/validation/`. See
70+
`scripts/validation/VALIDATION_TOOLS.md` for usage details.
71+
6672
## Further Information
6773

6874
See docs/DETAILED.md for more information.
6975

7076
---
7177

7278
© 2025 Bryan Chasko
79+
7380
# Git hook test

scripts/validation/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# HeraldStack Validation & Code Quality Tools
2+
3+
This directory contains scripts used for validating and formatting files in the
4+
HeraldStack project.
5+
6+
## Available Scripts
7+
8+
- `check-json.sh` - Validates and formats JSON files in the project using
9+
jsonlint and prettier
10+
- `check-rust.sh` - Runs formatting (rustfmt), linting (clippy), tests, and
11+
security audit on Rust code
12+
- `format-md.sh` - Formats Markdown files in the project using prettier
13+
14+
## Usage
15+
16+
Run these scripts from the project root for best results:
17+
18+
```bash
19+
# Validate and format JSON files
20+
./scripts/validation/check-json.sh
21+
22+
# Validate Rust code
23+
./scripts/validation/check-rust.sh
24+
25+
# Format Markdown files
26+
./scripts/validation/format-md.sh
27+
```
28+
29+
These scripts are designed to be used both locally during development and in
30+
CI/CD pipelines.
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# HeraldStack Validation & Code Quality Tools
2+
3+
This directory contains scripts used for validating and formatting files in the
4+
HeraldStack project.
5+
6+
## Available Scripts
7+
8+
- `check-json.sh` - Validates and formats JSON files in the project using
9+
jsonlint and prettier
10+
- `check-rust.sh` - Runs formatting (rustfmt), linting (clippy), tests, and
11+
security audit on Rust code
12+
- `format-md.sh` - Formats Markdown files in the project using prettier
13+
14+
## Usage
15+
16+
Run these scripts from the project root for best results:
17+
18+
```bash
19+
# Validate and format JSON files
20+
./scripts/validation/check-json.sh
21+
22+
# Validate Rust code
23+
./scripts/validation/check-rust.sh
24+
25+
# Format Markdown files
26+
./scripts/validation/format-md.sh
27+
```
28+
29+
These scripts are designed to be used both locally during development and in
30+
CI/CD pipelines.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
set -e
33

44
# Change to the rust_ingest directory where Cargo.toml is located
5-
cd "$(dirname "$0")/rust_ingest" || exit 1
5+
cd "$(dirname "$0")/../../rust_ingest" || exit 1
66
echo "Checking Rust files in $(pwd)..."
77

88
echo "Running rustfmt..."

0 commit comments

Comments
 (0)