zkapp-cli icon indicating copy to clipboard operation
zkapp-cli copied to clipboard

Add `check` command

Open jasongitmail opened this issue 4 years ago • 2 comments
trafficstars

To check the project against current conventions and best practices. Why current and not "current for the version of SnarkyJS used"...to encourage consistency in the ecosystem.

Codify the current conventions and automatically check the current dir for:

  • [ ] expected dir structure & files
  • [ ] .prettierrc exists & follows current format (and code passes?)
  • [ ] lint config file exists & follows current rules (and code passes?)
  • [ ] package-lock.json exists in Git (b/c it's required by the npm ci command used in CI templates)
  • [ ] tests exist (and pass?)
  • [ ] test coverage above x%? or function call coverage at 100%?

Could add a CI file for this too. Write this in JS and it can be used by both the CLI & CI workflow.

For failures, we might want to give a link to a conventions.md (to the proper section header within it) which explains 1.) the expected convention, and 2.) why.

jasongitmail avatar Jul 14 '21 01:07 jasongitmail

  • [ ] Add --fixor as a separate command to automatically update the user's project to current recommendations for Prettier/Eslint/etc configs, ignore files, etc.

jasongitmail avatar Jul 19 '21 04:07 jasongitmail

To discuss. We may not take this approach

jasongitmail avatar May 12 '22 01:05 jasongitmail

Closing to clean up. Not realistic that we prioritize this anytime soon. Need for it hasn't been seen in practice yet

jasongitmail avatar Jan 05 '23 19:01 jasongitmail