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

Document babili option in README #8

Closed
pdehaan opened this issue Aug 8, 2017 · 6 comments
Closed

Document babili option in README #8

pdehaan opened this issue Aug 8, 2017 · 6 comments

Comments

@pdehaan
Copy link
Contributor

pdehaan commented Aug 8, 2017

I was getting errors on the 2-3 repos I tried this with, until I started trolling the existing projects using the library and seeing the Boolean babili option.

Awesome project, by the way! 💯

@pdehaan pdehaan changed the title Document babili option Document babili option in README Aug 8, 2017
@pdehaan
Copy link
Contributor Author

pdehaan commented Aug 8, 2017

Current --help output:

$(npm bin)/size-limit -h
/Users/pdehaan/dev/github/mozilla/something-awesome/node_modules/.bin/size-limit

Options:
  --why, -w      Show package content                                  [boolean]
  --version, -v  Show version number                                   [boolean]
  --help, -h     Show help                                             [boolean]

Size Limit will read size-limit section from package.json.
Configurtion example:

  "size-limit": [
    {
      "path": "index.js",
      "limit": "9 KB",
      "babili": true
    }
  ]

@ai
Copy link
Owner

ai commented Aug 8, 2017

Done #11

@ai ai closed this as completed Aug 8, 2017
@pdehaan
Copy link
Contributor Author

pdehaan commented Aug 8, 2017

I think #11 only changed the CLI --help documentation. You still may want to mention the babili option in the README.md file. 🤷‍♀️

@ai
Copy link
Owner

ai commented Aug 8, 2017

@pdehaan should we? There is a "babili" docs for package.json config and it is the main use case for Size Limit.

--babili option needs only when you call size-limit --babili index.es6.js and it is rare case.

@ai
Copy link
Owner

ai commented Aug 8, 2017

I added "babili": true docs to README.md 1360416

Is it good right now? Does my English is correct? :D.

@pdehaan
Copy link
Contributor Author

pdehaan commented Aug 8, 2017

Yeah, that looks great, thanks! 😍
I think my issue was that all the projects I was testing on were using ES6 features so I needed that flag.

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