mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-01-17 13:38:37 +01:00
Code Issues Releases Wiki Activity

Comment lintstagedrc properly so we know how and why it is there and the process for removing it in the future

Browse Source
This commit is contained in:
Sunny Hirai 2021-07-08 23:02:02 -07:00
parent f4168e28d3
commit e79f238c76
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
.lintstagedrc.js
View File

@ -1,13 +1,23 @@
const escape = require('shell-quote').quote
/**
* Need this to fix a bug where we can't commit `pages/examples/[example].tsx`.
* Need this to fix a bug where we can't commit this:
*
* `pages/examples/[example].tsx`.
*
* because of the square brackets `[` and `]`.
*
* <https://github.com/okonet/lint-staged/issues/676#issuecomment-574764713>
*
* NOTE:
*
* We can remove this entire file if/when we upgrade to Prettier 2+ where this
* is no longer necessary according to the `lint-staged` issue.
* is no longer necessary according to the `lint-staged` issue shown above.
*
* Currently, the same configuration without the escaping of the filename
* still exists in `package.json` but this takes precedence over that.
*
* Once this file is removed, `package.json` configuration will be used.
*/
module.exports = {