Support YAML config

[fregante]

It'd be nice if p-s supported YAML configuration alongside the JS one

CommonJS files are slightly easier to read/write than JSON, but JS objects are still full '{"\,}

module.exports = {
  scripts: {
    default: 'node index.js',
    lint: 'eslint .',
    test: {
      // learn more about Jest here: https://kcd.im/egghead-jest
      default: 'jest',
      watch: {
        script: 'jest --watch',
        description: 'run in the amazingly intelligent Jest watch mode'
      }
    },
    build: {
      default: 'webpack',
      prod: 'webpack -p',
    },
    validate: 'nps --parallel lint,test,build',
  },
}

in YAML it would just be

default: node index.js
lint: eslint .
test:
  # learn more about Jest here: https://kcd.im/egghead-jest
  default: jest
  watch:
    script: jest --watch
    description: run in the amazingly intelligent Jest watch mode
build:
  default: webpack
  prod: webpack -p
validate: nps --parallel lint,test,build

Plus, even the syntax highlighter is nicer to YAML :P

YAML isn't dynamic like JS, but probably most people don't use that (and if they do, they can just use the standard CJS syntax)

[kentcdodds]

I'd be ok with that. Mind filing a PR?

[fregante]

I can try, but not this week

[kentcdodds]

Sounds good to me. Let me know if you need a hand.

[sxn]

I may have time to look into it this week too, if needed. 😄

[kentcdodds]

I'm sure that @bfred-it would appreciate it :) It's unlikely that I'll work on this.

[sxn]

[fregante]

Looks great!

I was wonder though why that extra script: level was necessary, that's why I didn't include in my example

[kentcdodds]

Yeah, it's so you can specify options :)

[fregante]

Duh! Didn't even notice that. Thanks!

[sxn]

Yeah, sorry for doing that without asking! Initially I implemented it without the scripts level, but that felt a bit off, i.e. that it would have forced potential YAML fans to still go with the JS version due to the former being (artificially) limited. :)

As a side note: would it make sense to make it so that the init script can create a package-scripts.yml file too?

[kentcdodds]

Oh yeah, great idea! Feel free to file an issue for that 👍