whatisgithub

What is yorkie?

yyx990803/yorkie — explained in plain English

Analysis updated 2026-07-18 · repo last pushed 2022-07-26

609JavaScriptAudience · developerComplexity · 2/5DormantSetup · easy

In one sentence

Yorkie lets you set up Git hooks like linting or tests before a commit just by adding a section to your package.json.

Mindmap

mindmap
  root((repo))
    What it does
      Easy Git hooks
      Configured in package.json
      Fork of Husky
    Tech stack
      JavaScript
      Git hooks
    Use cases
      Run tests before commit
      Format before push
      Monorepo support
    Audience
      JS developers
      Monorepo teams
    Setup
      Add gitHooks field
      No hidden config

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Automatically run linters or tests before every Git commit without remembering to do it manually.

USE CASE 2

Format code automatically before pushing to a shared repository.

USE CASE 3

Keep Git hooks working correctly across multiple nested packages in a monorepo.

USE CASE 4

Replace manual .git/hooks management with a simple package.json configuration.

What is it built with?

JavaScriptGit

How does it compare?

yyx990803/yorkiewithkynam/vibecode-pro-max-kitstephenlthorn/auto-identity-remove
Stars609621576
LanguageJavaScriptJavaScriptJavaScript
Last pushed2022-07-26
MaintenanceDormant
Setup difficultyeasyeasymoderate
Complexity2/52/53/5
Audiencedevelopervibe codergeneral

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

So what is it?

Yorkie is a tool that makes it easy to set up Git hooks, automated actions that run at specific points in your Git workflow. If you've ever wanted to automatically run tests before you commit code, or format your files before pushing, Git hooks let you do that. Yorkie makes setting them up painless by letting you define them right in your project's package.json file instead of dealing with hidden configuration files. Normally, Git hooks live in a special .git/hooks folder and can be tricky to manage, especially when working on a team. With yorkie, you just add a section called gitHooks to your package.json, list the actions you want to run, and you're done. For example, you might want to run a linter before every commit to catch style issues early, or run tests to make sure nothing breaks. Yorkie automatically sets up Git to call those commands at the right time. This project is specifically designed to solve problems that come up in larger projects where you have multiple packages nested inside each other (a setup called a monorepo). If you have a main project and sub-projects that all use the same Git hooks tool, they can sometimes step on each other and cause confusion. Yorkie fixes this by looking for the package.json file that's closest to your actual Git repository, avoiding those conflicts. It's a small but important improvement for teams managing complex project structures. The README mentions this is a fork of an existing project called Husky, meaning someone took that tool and made improvements specifically to handle these edge cases. You'd use yorkie if you're building a JavaScript project, especially if it's structured as a monorepo with multiple packages, and you want your team to automatically run code quality checks before commits without having to remember to do it manually.

Copy-paste prompts

Prompt 1
Show me how to add a gitHooks section to my package.json using yorkie to run tests before every commit.
Prompt 2
Help me configure yorkie in a monorepo so sub-packages don't conflict over Git hooks.
Prompt 3
Set up yorkie to run a linter as a pre-commit hook and prettier as a pre-push hook.
Prompt 4
What's the difference between yorkie and Husky, and why would I pick yorkie for my project?

Frequently asked questions

What is yorkie?

Yorkie lets you set up Git hooks like linting or tests before a commit just by adding a section to your package.json.

What language is yorkie written in?

Mainly JavaScript. The stack also includes JavaScript, Git.

Is yorkie actively maintained?

Dormant — no commits in 2+ years (last push 2022-07-26).

How hard is yorkie to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is yorkie for?

Mainly developer.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.