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

Idea for clarity for folks unfamiliar with p-s #1

Closed
DavidWells opened this issue Apr 26, 2016 · 2 comments
Closed

Idea for clarity for folks unfamiliar with p-s #1

DavidWells opened this issue Apr 26, 2016 · 2 comments

Comments

@DavidWells
Copy link
Contributor

Kent love this idea!

One issue that I have seen by all of the 'better npm scripts' setups is new folks not grokking what exactly the abstraction is doing or what it is running.

A.k.a the "p-s... what in the..." reaction from people unaware of this package

Has a proposal to potentially help folks looking at the package.json

before:

{
  "scripts": {
    "start": "p-s"
  }
}

after:

{
  "scripts": {
    "start": "p-s && echo 'Look in package-scripts.js for script information'"
  }
}

Just my 2 cents!

@kentcdodds
Copy link
Collaborator

Good point! Yet another example of the fundamental problem with JSON's lack of comments! We cannot escape it!

What if we exposed the binary as package-scripts in addition to the existing p-s?

Feel free to file a pull request! Just an update to the bin in the package.json ought to do it!

@DavidWells
Copy link
Contributor Author

sounds good. I will take a stab at it.

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

No branches or pull requests

2 participants