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

fix(b-form-file): fix prop type checking for `value` prop #4168

Merged
merged 20 commits into from Sep 30, 2019

Conversation

@tmorehouse
Copy link
Member

commented Sep 29, 2019

Describe the PR

When creating the new props docs and web-types (for yet to be released v2.0.3), the value type was changed to [File, Array] from Any (undefined) for better prop docs generation.

The resetting of the file control can be done by setting to null, and empty array, or an empty string, and when doing so Vue would emit an prop type check warning (when using empty string to reset the input).

This adds a deprecation message to have users switch to setting to null instead of empty string, and uses a custom validator to check the prop type/value

PR checklist

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Enhancement
  • ARIA accessibility
  • Documentation update
  • Other (please describe) Minor fix/refactor

Does this PR introduce a breaking change? (check one)

  • No
  • Yes (please describe)

The PR fulfills these requirements:

  • It's submitted to the dev branch, not the master branch
  • When resolving a specific issue, it's referenced in the PR's title (i.e. [...] (fixes #xxx[,#xxx]), where "xxx" is the issue number)
  • It should address only one issue or feature. If adding multiple features or fixing a bug and adding a new feature, break them into separate PRs if at all possible.
  • The title should follow the Conventional Commits naming convention (i.e. fix(alert): not alerting during SSR render, docs(badge): update pill examples, fix typos, chore: fix typo in README, etc). This is very important, as the CHANGELOG is generated from these messages.

If new features/enhancement/fixes are added or changed:

  • Includes documentation updates (including updating the component's package.json for slot and event changes)
  • Includes any needed TypeScript declaration file updates
  • New/updated tests are included and passing (if required)
  • Existing test suites are passing
  • The changes have not impacted the functionality of other components or directives
  • ARIA Accessibility has been taken into consideration (Does it affect screen reader users or keyboard only users? Clickable items should be in the tab index, etc.)

If adding a new feature, or changing the functionality of an existing feature, the PR's
description above includes:

  • A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)
tmorehouse added 2 commits Sep 29, 2019
Allow empty string to be passed.

When creating the new props docs and web-types (not yet released), the value type was changed to `[File, Array]` from Any (`undefined`).

The resetting of the file control can be done by setting to an empty string, and when doing so Vue would emit an prop type check warning.  This adds back in the type String to prevent the warning.
@codecov

This comment has been minimized.

Copy link

commented Sep 29, 2019

Codecov Report

Merging #4168 into dev will increase coverage by <.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##              dev    #4168      +/-   ##
==========================================
+ Coverage   99.86%   99.86%   +<.01%     
==========================================
  Files         237      237              
  Lines        4493     4495       +2     
  Branches     1258     1258              
==========================================
+ Hits         4487     4489       +2     
  Misses          5        5              
  Partials        1        1
Impacted Files Coverage Δ
src/utils/inspect.js 100% <100%> (ø) ⬆️
src/components/form-file/form-file.js 96% <100%> (+0.08%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 152fefc...dd40e44. Read the comment docs.

tmorehouse added 2 commits Sep 29, 2019
@tmorehouse tmorehouse changed the title chore(b-form-file): Fix types allowed by value (Vue prop type check) fix(b-form-file): fix prop type checking for `value` Sep 29, 2019
@tmorehouse tmorehouse changed the title fix(b-form-file): fix prop type checking for `value` fix(b-form-file): fix prop type checking for `value` prop Sep 29, 2019
tmorehouse added 3 commits Sep 29, 2019
@tmorehouse tmorehouse marked this pull request as ready for review Sep 29, 2019
@tmorehouse tmorehouse requested a review from jackmu95 Sep 29, 2019
tmorehouse added 12 commits Sep 29, 2019
@tmorehouse tmorehouse merged commit a8e2e56 into dev Sep 30, 2019
8 of 9 checks passed
8 of 9 checks passed
License Compliance FOSSA is analyzing this commit
Details
ci/circleci: build Your tests passed on CircleCI!
Details
ci/circleci: lint Your tests passed on CircleCI!
Details
ci/circleci: setup Your tests passed on CircleCI!
Details
ci/circleci: test Your tests passed on CircleCI!
Details
codecov/patch 100% of diff hit (target 99.86%)
Details
codecov/project 99.86% (+<.01%) compared to 152fefc
Details
deploy/netlify Deploy preview ready!
Details
security/snyk - package.json (pi0) No manifest changes detected
@tmorehouse tmorehouse deleted the tmorehouse/b-form-file-value branch Sep 30, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.