search

silverstripeltd / bespoke-standards

Silverstripe PHPCS standards for Bespoke squads
BSD 3-Clause "New" or "Revised" License
2 stars 0 forks source link

✨ Add report generation scripts #28

Closed n8-dev closed 7 months ago

n8-dev commented 10 months ago

PHP version: 8.0+

Description

Adding two new scripts:

  1. bespoke-phpcs-report-source
  2. bespoke-phpcs-report-summary

Reason for the change

A new usecase from @poyjavier was the ability to see how other PHP code adhears to our coding standards as code review is sometimes a task done.

The ability to do the following

  1. Add this project as a dependancy
  2. Run a script to get the report
  3. Present said report

Will vastly streamline things and gives some reference-able data.

Note.

Ability to pass these commands dynamically can be looked at in the future.

Also, this is including the error of passed commands that is present in #27

Plan for Wiki update post merge:

Final checklist for reviewer

n8-dev commented 10 months ago

What do you mean @satrun77 ? Its here? https://github.com/silverstripeltd/bespoke-standards/pull/28/files#diff-d2ab9925cad7eac58e0ff4cc0d251a937ecf49e4b6bf57f8b95aab76648a9d34

FYIW: This is just a quick win for Innovation week. Future goal will look at overhauling, param passing and setting.

satrun77 commented 7 months ago

@n8-dev is there anything in here that we are waiting for? or is this ready for merge

n8-dev commented 7 months ago

I want to look a rebuilding the CLI mechanics to properly support arguments at some point, but having these function as two additional commands for now is good enough, and brings the useful feature into the limelight.

I'd say good for an MVP.

So yes, ready for merge @satrun77