Skip to content

A light-hearted linter + AI-assisted auto-fixer that integrates with your CI/CD to ensure that your documentation and READMEs are sanitized of emojis

License

Notifications You must be signed in to change notification settings

hesreallyhim/emoji-free-zone

Repository files navigation

Emoji-Free Zone Monorepo

This workspace houses two sibling packages under packages/:

  • emoji-free-zone (packages/emoji-free-zone/): core CLI + GitHub Action to keep markdown emoji-free. Node >=18.
  • emoji-free-zone-agent (packages/emoji-free-zone-agent/): optional LLM-powered fixer that consumes the linter's --json output. Node >=18.

Getting Started

  • Install deps: npm install (installs both workspaces).
  • Run all tests: npm test (runs each package's test suite).
  • Lint the packages themselves: npm run lint.
  • Work on a single package:
    • Linter: npm test --workspace packages/emoji-free-zone
    • Agent: npm test --workspace packages/emoji-free-zone-agent

Publishing

See PUBLISHING.md for:

  • GitHub Action release steps (root action.ymluses: hesreallyhim/emoji-free-zone@v1)
  • npm publish commands for each workspace package

About

A light-hearted linter + AI-assisted auto-fixer that integrates with your CI/CD to ensure that your documentation and READMEs are sanitized of emojis

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published