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

chore: Remove config from README programmatic usage options #475

Merged

Conversation

adamhamlin
Copy link
Contributor

@adamhamlin adamhamlin commented Oct 21, 2023

Removes the config option from the README's programmatic options. The config option is only relevant to CLI usage.

A possible related enhancement could be to error for any "unknown" options (for example, passing config for programmatic usage is silently ignored at the moment).

Resolves #429

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

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

lgtm

@mcollina mcollina merged commit 66cb1b1 into pinojs:master Oct 22, 2023
@adamhamlin adamhamlin deleted the fail-option-config-programmatic-use branch October 22, 2023 13:44
renovate bot referenced this pull request in fwouts/previewjs Dec 14, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [pino-pretty](https://github.com/pinojs/pino-pretty) | [`^10.2.3` ->
`^10.3.0`](https://renovatebot.com/diffs/npm/pino-pretty/10.2.3/10.3.0)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/pino-pretty/10.3.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/pino-pretty/10.3.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/pino-pretty/10.2.3/10.3.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/pino-pretty/10.2.3/10.3.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>pinojs/pino-pretty (pino-pretty)</summary>

###
[`v10.3.0`](https://github.com/pinojs/pino-pretty/releases/tag/v10.3.0)

[Compare
Source](https://github.com/pinojs/pino-pretty/compare/v10.2.3...v10.3.0)

#### What's Changed

- chore: Remove `config` from README programmatic usage options by
[@&#8203;adamhamlin](https://github.com/adamhamlin) in
[https://github.com/pinojs/pino-pretty/pull/475](https://github.com/pinojs/pino-pretty/pull/475)
- Bump actions/setup-node from 3 to 4 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/pinojs/pino-pretty/pull/476](https://github.com/pinojs/pino-pretty/pull/476)
- Minior Doc. Update Readme.md. Fix commas. by
[@&#8203;grigals](https://github.com/grigals) in
[https://github.com/pinojs/pino-pretty/pull/479](https://github.com/pinojs/pino-pretty/pull/479)
- Update to latest help-me by
[@&#8203;mcollina](https://github.com/mcollina) in
[https://github.com/pinojs/pino-pretty/pull/482](https://github.com/pinojs/pino-pretty/pull/482)

#### New Contributors

- [@&#8203;adamhamlin](https://github.com/adamhamlin) made their first
contribution in
[https://github.com/pinojs/pino-pretty/pull/475](https://github.com/pinojs/pino-pretty/pull/475)
- [@&#8203;grigals](https://github.com/grigals) made their first
contribution in
[https://github.com/pinojs/pino-pretty/pull/479](https://github.com/pinojs/pino-pretty/pull/479)

**Full Changelog**:
pinojs/pino-pretty@v10.2.3...v10.3.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about these
updates again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/fwouts/previewjs).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy45My4xIiwidXBkYXRlZEluVmVyIjoiMzcuOTMuMSIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
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.

RC config file support for programmatic usage
2 participants