Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup scripts #588

Merged
merged 10 commits into from
Jan 28, 2021
Merged

Cleanup scripts #588

merged 10 commits into from
Jan 28, 2021

Conversation

TimothyJones
Copy link
Contributor

Looking at #584 highlighted that it's not super clear when things are triggered with our package.json scripts. I've started to clean up and consolidate them to hopefully make it clearer - thoughts welcome.

I like the guideline that the scripts are named after what they're for, not what they invoke. Like test instead of jest. Under that guideline, there's still a bit of work to do here.

(Matt, I know you don't have a lot of time atm, I'm mostly tagging you in case you're interested)

Things I'm thinking about:

  • Do we need all the examples listed in package-json? We don't use those scripts in CI.
  • I'm not sure whether the output of jscpd is used
  • We're still generating coverage for coveralls, but aren't sending it to them (this is probably an easy fix, if we want to keep publishing those).
  • I think we can also remove the webpack script

All thoughts and comments welcome.

@TimothyJones
Copy link
Contributor Author

@individual-it : I wanted to add you as a reviewer, but you didn't come up in the drop down for some reason. Would be keen to know what you think.

@mefellows
Copy link
Member

Do we need all the examples listed in package-json? We don't use those scripts in CI.

I don't think so. We just want to be able run the examples as part of our CI process as a form of feature spec (and of course to make sure they are actually runnable and therefore something people can use). To be honest though, we ought to have a more dedicated feature suite - for another time.

I'm not sure whether the output of jscpd is used

It used to be, it's quite frankly not something I'm too concerned about so I'm happy to see it removed. I think between us we'll be able to judge with PRs etc. if we're badly duplicating code. There is one area of the code base (pact-web) which could be refactored, I don't need jscpd to help me recognise that.

We're still generating coverage for coveralls, but aren't sending it to them (this is probably an easy fix, if we want to keep publishing those).

I'm not super concerned about sending the coverage reports to coveralls (although I did think they were still working, not that I've looked recently). The main value is having some guidance around testing and %'s just give us a sense of that. Don't need coveralls to do that for us.

I think we can also remove the webpack script

Webpack was needed by the pact-web distribution. As long as that can still build and release then the script step can go.

@mefellows
Copy link
Member

BTW the script directory cleanup looks much nicer - thanks heaps for doing it.

Copy link
Contributor

@individual-it individual-it left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I cannot see where lint and format are run in CI
I actually would propose to run them directly as first steps in CI, so its very obvious for the developers

package.json Outdated Show resolved Hide resolved
package.json Show resolved Hide resolved
@TimothyJones TimothyJones merged commit 4508416 into master Jan 28, 2021
@TimothyJones TimothyJones deleted the cleanup-scripts branch January 28, 2021 07:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants