search

VGVentures / nitpicky

Provides VGV style lints, similar to package:pedantic.
MIT License
2 stars 0 forks source link

Content should be just a single yaml file #1

Open martinrybak opened 4 years ago

martinrybak commented 4 years ago

Since this will be installed together with pedantic, all we need is a single yaml file with our VGV analysis rules.

mockturtl commented 4 years ago

I should have made a PR -- see https://github.com/VGVentures/nitpicky/commit/02660dad98228b7bad98c909a39630b8fc453dca

martinrybak commented 4 years ago

There's still a file in tool/tag...is that needed?

mockturtl commented 4 years ago

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.