Assessify

This repo contains Assessify, an accessibility fixer for Git hooks and local files.

Quick start (using Bun):

# install dependencies with bun
bun install

# run in dev (TypeScript run via bun)
bun run src/index.ts

# initialize a project
bun run src/cli.ts init

Publish To npm

To publish Assessify on npm:

npm login
npm run build
npm version patch
npm publish

If you want to test the package first, run npm pack to create a local tarball and inspect the published contents before releasing.

Use In A Project

A developer can add Assessify to a frontend project with npm:

npm install --save-dev assessify
npx assessify init

During init, Assessify asks for the API key and other config details, writes .assessify.json, and installs the selected Git hook. For frontend projects the default is pre-commit, so the scan runs automatically before every commit.

What happens on commit:

1. Git calls the installed pre-commit hook.
2. The hook runs npx assessify fix --stage staged.
3. Assessify scans the configured file types, checks accessibility issues, and applies fixes when possible.
4. If changes are made, the hook stages them so the commit includes the updates.

If the developer wants push-time checks too, assessify init can install pre-push or both hooks instead of only pre-commit.

Next steps:

• Run assessify init in a frontend project to collect API key and config details, then install the chosen hook
• Configure your API key with --api-key, A11Y_CLI_API_KEY, or the key in .assessify.json
• Implement LLM integration in src/core/llm.ts
• Implement patcher in src/core/patcher.ts
• Flesh out CLI in bin/cli.js or TypeScript source