diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs new file mode 100644 index 0000000000..b138d5493f --- /dev/null +++ b/.git-blame-ignore-revs @@ -0,0 +1,5 @@ +# .git-blame-ignore-revs + +# Ran `npx prettier@2.7.1 --write .` on the entire codebase + +## TODO: update this line with the commit hash of the `prettier --write .` commit once it lands in develop diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8c2bdffde3..78ed295301 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,6 +11,8 @@ - `cd ganache` - `npm install` (use npm v6) - On Linux and macOS: run `source completions.sh` to enable autocomplete for npm scripts. +- For better local `git diff` results run `git config blame.ignoreRevsFile .git-blame-ignore-revs` to automatically ignore + large formatting/style revisions. ## Solving node-gyp issues diff --git a/scripts/postinstall.ts b/scripts/postinstall.ts index fbc7f2aa39..47a0bb1c3d 100644 --- a/scripts/postinstall.ts +++ b/scripts/postinstall.ts @@ -30,7 +30,11 @@ require("./link-ts-references"); execSync("npm run tsc", execArgs); console.log(""); +console.log(chalk`{bold.cyan Tips:}`); console.log( - chalk`{bold.cyan Tip:} {cyan run} {bold.yellow.dim source completions.sh} {cyan to supply bash completions for npm scripts}` + chalk` {cyan run} {bold.yellow.dim source completions.sh} {cyan to supply bash completions for npm scripts}` +); +console.log( + chalk` {cyan run} {bold.yellow.dim git config blame.ignoreRevsFile .git-blame-ignore-revs} {cyan to ignore large formatting/style revisions from local {bold.yellow.dim git diff} results}` ); console.log("");