docs: base Testing Rules documentation #8033
Conversation
|
Thanks for the PR, @c0sta! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| - `npm run lint` | ||
| - `yarn lint` |
There was a problem hiding this comment.
The problem with explicitly listing out "lint" scripts is that there are so many different ways folks can do it, it's hard to express all of them. What about pnpm users? What about folks who have different "lint" scripts?
Suggestion: instead of saying lint and then this list, use a more casual phrase like "your repository's lint script".
There was a problem hiding this comment.
Hmm got it, I was trying something like the commands listed on the Global Linking but that's right, just pointing out that the user needs to run the repo lint script sounds better.
There was a problem hiding this comment.
Makes sense. Something already existing in our docs in one way is no guarantee that that's the right way 😄
There was a problem hiding this comment.
Thanks for the early peek @c0sta, looking good so far! Left some early stage comments. Definitely open to talking about any+all of them if you have thoughts! :)
…o disable-type-checked (typescript-eslint#8038) fix: add no-unsafe-unary-minus, prefer-destructuring to disable-type-checked
…hod names (typescript-eslint#8062) docs: streamline
Co-authored-by: typescript-eslint[bot] <typescript-eslint[bot]@users.noreply.github.com>
|
I'm putting this PR on Ready for Review, any kinda of suggestion/idea just let me know and I'll be happy to help with it. |
…ow-to-test-changes
Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>
|
Oh and:
That's where you'd typically put the |
…t-eslint into docs/how-to-test-changes
…ow-to-test-changes
|
At a glance this is looking great! I'll hold off reviewing again until explicitly re-requested. (just posting in case you'd meant to click the re-request button) |
PR Checklist
Overview
Fixes: #4875
Submitting this as a draft to gather some suggestions/ideas and understand if I'm going the right way here.
I did all these steps inside Local Linking and I was able to see my console.log running at my downstream repository, from what I've tried these steps are very straightforward so I'm not sure if there any more steps or more examples that I could point out here.
Tonight I aim to review and be more descriptive on the "run your
lintscript" step because it seems kinda "empty".