Escape-Technologies / mookme

A pre-commit tool designed for monorepos.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Fix `--only-hook[s]` typo

MatthewScholefield opened this issue · comments

The docs say --only-hooks but the CLI and reference docs use --only-hook .

I would create a PR but I'm not sure which one to use and how to regenerate the docs.

That's completely a mistake from me indeed !

I'm fixing this right now. In order to know which one to use, when there is a doubt, the information from the mookme --help are the most up-to-date since it is generated by commander (our CLI helper) itself. (it is --only-hook)

I did not have time yet to elaborate the contribution guide and developer's documentation but now that there is an external contributor this becomes critical, so I will address this ASAP.

In the meantime, the documentation is written in vuepress and stored under the docs package. If you intend to generate the documentation in your local environment, you just have to cd into that package, run npm i and then npm run dev.
I invite you to consult the documentation of Vuepress in order to have a better understanding of the structure of this package :)

You'll have it here : #17