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

feat(cli): better error messages for wrong or missing options #2970

Merged
merged 1 commit into from
Jan 9, 2025

Conversation

unekinn
Copy link
Contributor

@unekinn unekinn commented Jan 9, 2025

To facilitate better errors, the CLI option names that also exist in JSON config are now defined in a cliOptions object that we can use to look up the mapping between JSON path and CLI option through mapPathToOptionName(path)

Before this change:
Screenshot 2025-01-09 at 10 45 47

After:
Screenshot 2025-01-09 at 10 49 27

Copy link

changeset-bot bot commented Jan 9, 2025

🦋 Changeset detected

Latest commit: 2053e7c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages
Name Type
@digdir/designsystemet Minor
@digdir/designsystemet-css Minor
@digdir/designsystemet-theme Minor
@digdir/designsystemet-react Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

github-actions bot commented Jan 9, 2025

Preview deployments for this pull request:

Storybook - 9. Jan 2025 - 11:56

Theme - 9. Jan 2025 - 11:57

@unekinn unekinn force-pushed the feat/cli-better-json-error-msg branch from c59ced7 to 2053e7c Compare January 9, 2025 10:54
Copy link
Contributor

github-actions bot commented Jan 9, 2025

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 55.42% 3190 / 5756
🔵 Statements 55.42% 3190 / 5756
🔵 Functions 86.25% 182 / 211
🔵 Branches 77.25% 523 / 677
File CoverageNo changed files found.
Generated in workflow #1548 for commit 2053e7c by the Vitest Coverage Report Action

@unekinn unekinn merged commit bcd50d9 into next Jan 9, 2025
11 checks passed
mimarz pushed a commit that referenced this pull request Jan 14, 2025
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to next, this PR will
be updated.

⚠️⚠️⚠️⚠️⚠️⚠️

`next` is currently in **pre mode** so this branch has prereleases
rather than normal releases. If you want to exit prereleases, run
`changeset pre exit` on `next`.

⚠️⚠️⚠️⚠️⚠️⚠️

# Releases
## @digdir/designsystemet@1.0.0-next.46

### Minor Changes

- Add JSON schema for CLI config file, which enables editor hints. To
use it, do something like this:
([#2972](#2972))

    ```jsonc
    {
"$schema":
"node_modules/@digdir/designsystemet/dist/config.schema.json",
      // ...config options here...
    }
    ```

- cli: better error messages for wrong or missing options
([#2970](#2970))

### Patch Changes

- tokens: fix wrong reference for focus color.
([#2989](#2989))

- refactor: Changed border-radius token to dimension type
([#2990](#2990))

- Add json config file support for `tokens create`
([#2847](#2847))

- Changed focus color to use neutral instead of accent color
([#2989](#2989))

- tokens build: fix invalid values in --ds-size calculations
([#2975](#2975))

- outDir option was required, but it should have a default value
([#2969](#2969))

## @digdir/designsystemet-css@1.0.0-next.46

### Patch Changes

- Helptext: Remove component
([#2956](#2956))

- Field: Don't show as disabled when option is disabled
([#2980](#2980))

- Changed focus color to use neutral instead of accent color
([#2989](#2989))

- Tabs: Rework component CSS
([#2991](#2991))

## @digdir/designsystemet-react@1.0.0-next.46

### Patch Changes

- Input: Add whitelist for `type`
([#2974](#2974))

- Helptext: Remove component
([#2956](#2956))

- Textfield: Add whitelist for `type`
([#2974](#2974))

- Tabs: Content will get focus when it has no focusable elements
([#2991](#2991))

## @digdir/designsystemet-theme@1.0.0-next.46

### Patch Changes

- Changed focus color to use neutral instead of accent color
([#2989](#2989))

Co-authored-by: github-actions[bot] <github-actions[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.

2 participants