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

Clean up yargs and consola imports #51

Merged
merged 3 commits into from
Feb 12, 2024
Merged

Conversation

tzyl
Copy link
Contributor

@tzyl tzyl commented Feb 12, 2024

  • Consistently name argv as the yargs.Argv builder type and args as the parsed yargs.Arguments type
  • Make all consola imports static imports at the moment there's a big mix of both and consola is always going to be needed immediately in the CLI
  • Add description for top level unstable command so that it actually shows up in the default generated help text
  • Simplify custom fail logging verbose logic to just log stack in debug level
  • Print CLI errors as consola error for consistency and more visibility at end of CLI

@changelog-app
Copy link

changelog-app bot commented Feb 12, 2024

Generate changelog in packages/cli/changelog/@unreleased

What do the change types mean?
  • feature: A new feature of the service.
  • improvement: An incremental improvement in the functionality or operation of the service.
  • fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
  • break: Has the potential to break consumers of this service's API, inclusive of both Palantir services
    and external consumers of the service's API (e.g. customer-written software or integrations).
  • deprecation: Advertises the intention to remove service functionality without any change to the
    operation of the service itself.
  • manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration,
    performing database surgery, ...) at the time of upgrade for it to succeed.
  • migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?
  • ❗The break and manual task changelog types will result in a major release!
  • 🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
  • ✨ All others will result in a minor version release.

Type

  • Feature
  • Improvement
  • Fix
  • Break
  • Deprecation
  • Manual task
  • Migration

Description

Clean up yargs handling and consola imports

Check the box to generate changelog(s)

  • Generate changelog entry

Copy link
Member

@zeyadkhaled zeyadkhaled left a comment

Choose a reason for hiding this comment

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

I like the simplification of logging the stack for ExitProcessError 👍

packages/cli/src/cli.ts Outdated Show resolved Hide resolved
Co-authored-by: Zeyad Abuamer <35533361+zeyadkhaled@users.noreply.github.com>
@bulldozer-bot bulldozer-bot bot merged commit 21b31f8 into main Feb 12, 2024
6 checks passed
@bulldozer-bot bulldozer-bot bot deleted the tl/cleanup-consola-yargs branch February 12, 2024 11:44
ericanderson added a commit that referenced this pull request Feb 13, 2024
* origin/main:
  Autorelease
  Increase CLI max width to 150 columns (#47)
  Debug log site zip stats (#49)
  Clean up yargs and consola imports (#51)
  Autorelease
  Add generated changelog entries
  Breaking: force dollar sign in osdk verbs for where
  Display errors more consistently in @osdk/cli (#41)
  Fix tagPrefix
  Add generated changelog entries
  Create foundry.config.json in create-app
  [3/] Improvement: Use loadedToken for fetching data (#17)
  Move argv override logging to middleware (#42)
  Make sure to run all tests (#39)
  Update create-app to use FOUNDRY_TOKEN in templates (#40)
  Add generated changelog entries
  Fix intellisense for aggregations and fill in more number types
  [2/] Improvement: Introduce new command structure  (#16)
  Autorelease
  Refactor create-app prompts with tests (#32)
  Refactor create-app dotfile generation (#31)
  add changelog
  Add generated changelog entries
  Add generated changelog entries
  put mkdir in right place
  remove generated files
  add ignore for legacy client
  remove deleted file
  added
  add back mkdir
  move mkdir
  fix
  fixes
  keep trying
  remove module
  shared testing infra for legacy
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants