question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Readme doesn't include "es" format

See original GitHub issue

The description of the format option, in the readme file is:

--format — format of the generated parser: amd, commonjs, globals, umd (default: commonjs)

But Peggy includes an es option as well.

It’s worth noting that the CLI documentation does have the es type listed:

Format of the generated parser: amd, commonjs, globals, umd, es (default: commonjs).

But, the dependencies section for the JS API says:

valid only when format is set to “amd”, “commonjs”, or “umd”

Where it should include es" in the list.

I could try and get a PR in to fix these things, but I’m not sure when I’ll get the time to do so.

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:9 (9 by maintainers)

github_iconTop GitHub Comments

2reactions
hildjjcommented, Apr 19, 2021

How about we just accept our status quo for now, document it, and clean it up later if it becomes a problem. We can always add an alias later.

0reactions
StoneCyphercommented, Apr 19, 2021

seems fine. i was just appealing for community norms, and it seems there isn’t one

Read more comments on GitHub >

github_iconTop Results From Across the Web

What is the difference between README and README.md in ...
README.md or .mkdn or .markdown denotes that the file is markdown formatted. Markdown is a markup language. With it you can easily display...
Read more >
Readme: the file type simply explained with examples - IONOS
You can write and save a readme file in any text file format you wish. Formats may include readme.txt, readme.doc, and readme.1st. Depending...
Read more >
Basic writing and formatting syntax - GitHub Docs
Create sophisticated formatting for your prose and code on GitHub with simple syntax.
Read more >
How to use Microsoft Word to write a README.md file for your ...
Now you have your README file in Markdown format, and you need to add it into your GitHub project. Go to the GitHub...
Read more >
About package README files - npm Docs
In a text editor, in your package root directory, create a file called README.md . In the README.md file, add useful information about...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found