New config structure docs #96
Conversation
There was a problem hiding this comment.
Thanks for the detailed write-up!
One major concern I have here is the size of the README. Ideally, I'd like to keep the README short, and have a separate resource for plugin authors and people who want to quickly write a rule or two. In the near future, it will probably amount to a documentation site. That's why I don't think we should go into details about concepts like GlobArray, Config Object, etc. These are implementation details and terms rather than public facing components, in my opinion.
So maybe we can just keep the README to one example that includes fsd.configs.recommended, a global ignore, and then a change of severity for a certain glob?
As for the docs about writing plugins, I think we should hold on with this for now. Since we still have some technical and design issues to iron out (mostly on my side, with the toolkit stuff), I don't think we're ready to write docs just yet.
|
I fixed all the issues. I decided not to delete the examples completely and moved them to a separate page. |
|
Sorry for not finding these comments before, the fixes for the previous comments are good, thanks! |
Co-authored-by: Lev Chelyadinov <[email protected]>
Co-authored-by: Lev Chelyadinov <[email protected]>
Co-authored-by: Lev Chelyadinov <[email protected]>
|
Yes, your suggestions were completely reasonable, so I committed them |
|
Also, I thought about merging this PR last, because:
|
|
Makes sense. Let's wait with this then |
|
@illright |
README.md
Outdated
| ### Glob matching | ||
|
|
||
| All globs are matched only against files, folder severities are computed based on the files inside them. The formula is simple: the folder severity is the highest severity of files inside it (from highest to lowest: error, warn, off). | ||
|
|
||
| **Glob examples**: | ||
|
|
||
| - `./src/shared/**` - matches all files in the `shared` folder and its subfolders | ||
| - `./src/shared/*` - matches all files that are direct children of the `shared` folder | ||
| - `./src/shared` - based on the fact that globs are matched against files, this one matches only `shared` file (without an extension) inside the `src` folder | ||
| - `**/__mocks__/**` - matches all files in all `__mocks__` folders throughout the project | ||
| - `**/*.{test,spec}.{ts,tsx}` - matches all test files in the project |
There was a problem hiding this comment.
issue: again, I believe this is a more technical description, and I forecast that most people will just disable entire folders, so people are unlikely to run up against a case where one file made the whole folder be error.
suggestion: let's just get rid of this entire section
There was a problem hiding this comment.
Decided to move it to CONFIG_EXAMPLES.md so far. Let me know if you think it should not be even there
There was a problem hiding this comment.
I personally think it shouldn't be even there, but I also don't mind it being there. As long as it's not up front in the README, I'm fine with it
Co-authored-by: Lev Chelyadinov <[email protected]>
…pa/steiger into feature/new-config-docs
|
You don't need to be sorry for these corrections. They are completely reasonable and improve the documentation. Thanks for reviewing! |
|
There's still some instances of |
|
Thanks for catching that! Yes, I forgot to update some examples based on the new glob-matching approach |
Resolves #89
Hi @illright
I added several new sections to README to describe the new structure, its concepts, and how to work with it. Also, I added a migration guide in a separate file, as you requested.
Let me know if you have any suggestions/corrections. Thank you in advance!