Skip to content

Commit bded20b

Browse files
theDakshJaitlytheDakshJaitly
committed
Add CI, CONTRIBUTING, CHANGELOG, and prep for npm publish
- GitHub Actions CI running typecheck + test + build on Node 18/20/22 - CONTRIBUTING.md with setup, dev workflow, and PR guidelines - CHANGELOG.md with 0.1.0 and 0.2.0 entries - package.json: bump to 0.2.0, add files/keywords/repository/author fields - README: CI badge, npm badge, links to contributing and changelog - Remove empty test_2/ directory - Add Thumbs.db to .gitignore
1 parent 68b66cd commit bded20b

6 files changed

Lines changed: 136 additions & 2 deletions

File tree

‎.github/workflows/ci.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
check:
11+
runs-on: ubuntu-latest
12+
strategy:
13+
matrix:
14+
node-version: [18, 20, 22]
15+
steps:
16+
- uses: actions/checkout@v4
17+
- uses: actions/setup-node@v4
18+
with:
19+
node-version: ${{ matrix.node-version }}
20+
cache: npm
21+
- run: npm ci
22+
- run: npm run typecheck
23+
- run: npm run test
24+
- run: npm run build

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,6 @@
66
# Node
77
node_modules/
88
dist/
9+
10+
# OS
11+
Thumbs.db

‎CHANGELOG.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
## [0.2.0] - 2026-03-29
6+
7+
### Fixed
8+
- False positive `DEPENDENCY_MISSING` warnings for versioned dependencies with semver prefixes (`^`, `~`, `>=`)
9+
10+
### Changed
11+
- Sync now sends all drift issues to Claude in a single session instead of one session per file — reduces token usage and eliminates repeated session restarts
12+
13+
## [0.1.0] - 2026-03-21
14+
15+
### Added
16+
- Initial release
17+
- 8 drift checkers: path, edges, index-sync, staleness, command, dependency, cross-file, script-coverage
18+
- `mex check` with `--quiet`, `--json`, `--fix` flags
19+
- `mex sync` with interactive and prompt modes, dry-run support
20+
- `mex init` codebase pre-scanner
21+
- `mex watch` post-commit hook
22+
- `setup.sh` for first-time scaffold population
23+
- `sync.sh` interactive menu
24+
- Multi-tool support (Claude Code, Cursor, Windsurf, GitHub Copilot)

‎CONTRIBUTING.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Contributing to mex
2+
3+
Thanks for your interest in contributing! Here's how to get started.
4+
5+
## Setup
6+
7+
```bash
8+
git clone https://github.com/theDakshJaitly/mex.git
9+
cd mex
10+
npm install
11+
npm run build
12+
```
13+
14+
## Development
15+
16+
```bash
17+
npm run dev # watch mode — rebuilds on changes
18+
npm run test:watch # run tests in watch mode
19+
npm run typecheck # type check without emitting
20+
```
21+
22+
## Before submitting a PR
23+
24+
1. Run the full check suite:
25+
```bash
26+
npm run typecheck && npm run test && npm run build
27+
```
28+
2. Keep changes focused — one fix or feature per PR.
29+
3. Add tests for new checkers or bug fixes when possible.
30+
4. Don't refactor surrounding code unless that's the point of the PR.
31+
32+
## Project structure
33+
34+
```
35+
src/
36+
cli.ts # CLI entry point (commander)
37+
config.ts # Project/scaffold root detection
38+
drift/
39+
claims.ts # Extract claims from markdown files
40+
checkers/ # Individual drift checkers
41+
scoring.ts # Score computation
42+
index.ts # Orchestrates drift check
43+
scanner/ # Codebase pre-scanner (used by mex init)
44+
sync/ # AI-targeted sync (brief builder + interactive loop)
45+
reporter.ts # Terminal output formatting
46+
test/ # Vitest tests
47+
```
48+
49+
## Reporting bugs
50+
51+
Open an issue using the bug report template. Include the output of `mex check --json` if relevant.
52+
53+
## License
54+
55+
By contributing, you agree that your contributions will be licensed under the MIT License.

‎README.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@
1313

1414
**mex**
1515

16+
[![CI](https://github.com/theDakshJaitly/mex/actions/workflows/ci.yml/badge.svg)](https://github.com/theDakshJaitly/mex/actions/workflows/ci.yml)
1617
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
18+
[![npm version](https://img.shields.io/npm/v/mex.svg)](https://www.npmjs.com/package/mex)
1719

1820
</div>
1921

@@ -213,7 +215,11 @@ All config files contain identical content. `setup.sh` asks which tool you use a
213215

214216
## Contributing
215217

216-
Contributions welcome. Open an issue or submit a PR.
218+
Contributions welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for setup and guidelines.
219+
220+
## Changelog
221+
222+
See [CHANGELOG.md](CHANGELOG.md) for release history.
217223

218224
## License
219225

‎package.json‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,33 @@
11
{
22
"name": "mex",
3-
"version": "0.1.0",
3+
"version": "0.2.0",
44
"description": "CLI engine for mex scaffold — drift detection, pre-analysis, and targeted sync",
55
"type": "module",
66
"bin": {
77
"mex": "./dist/cli.js"
88
},
9+
"files": [
10+
"dist",
11+
"LICENSE",
12+
"README.md"
13+
],
14+
"keywords": [
15+
"ai",
16+
"agents",
17+
"scaffold",
18+
"drift-detection",
19+
"documentation",
20+
"cli",
21+
"claude",
22+
"cursor",
23+
"copilot"
24+
],
25+
"repository": {
26+
"type": "git",
27+
"url": "https://github.com/theDakshJaitly/mex.git"
28+
},
29+
"author": "Daksh Jaitly",
30+
"license": "MIT",
931
"scripts": {
1032
"build": "tsup",
1133
"dev": "tsup --watch",

0 commit comments

Comments
 (0)