Content should be just a single yaml file
martinrybak opened this issue · comments
Since this will be installed together with pedantic, all we need is a single yaml file with our VGV analysis rules.
There's still a file in tool/tag...is that needed?
I really like having a tool folder with build, release, etc. scripts that spare me typing (and remembering!) various esoteric CLI / DSL's. It's nice to have the muscle memory for, say, ./tool/analyze that's portable between pure Dart libs and Flutter apps.
I think it helps share knowledge, too. A new dev might lack confidence with git or bash, but they can always study a script to see what good practice looks like.
https://github.com/VGVentures/nitpicky/blob/master/tool/tag
FWIW, it's an officially blessed convention:
https://dart.dev/tools/pub/package-layout#internal-tools-and-scripts
Mature packages often have little helper scripts and programs that people run while developing the package itself. Think things like test runners, documentation generators, or other bits of automation.
Unlike the scripts in bin, these are not for external users of the package. If you have any of these, place them in a directory called
tool.