Skip to content

feat: add BOOTSTRAP_VUE_NO_WARN environment variable to hide warnings #2826

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

Merged
merged 19 commits into from Mar 25, 2019
Merged

feat: add BOOTSTRAP_VUE_NO_WARN environment variable to hide warnings #2826

merged 19 commits into from Mar 25, 2019

Conversation

ghost
Copy link

@ghost ghost commented Mar 12, 2019

Description of Pull Request:

This uses an environment variable BOOTSTRAP_VUE_NO_WARN to hide warnings logged by Boostrap Vue. This is useful in a test environment when incomplete test setup leads to false positives or in a production environment.

A second iteration of this would be to add a config option similar to Vue.config.warnHandler to allow making tests fail.

PR checklist:

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

  • Bugfix
  • Feature
  • Enhancement to an existing feature
  • ARIA accessibility
  • Documentation update
  • Other, please describe:

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

  • Yes
  • No

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 #xxxx[,#xxxx], where "xxxx" is the issue number)
  • The PR 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.
  • PR titles should following the
    Conventional Commits naming convention (i.e.
    "fix(alert): not alerting during SSR render", "docs(badge): Updated pill examples, fix typos",
    "chore: fix typo in docs", 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)
  • 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)

@ghost
Copy link
Author

ghost commented Mar 12, 2019

I'm happy to provide documentation and tests (if wanted) in case this is an acceptable way to solve the problem.

In case there are other ways to provide a global config, I'm happy to hear and change this approach.

@codecov
Copy link

codecov bot commented Mar 12, 2019

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##              dev    #2826      +/-   ##
==========================================
+ Coverage   90.78%   90.78%   +<.01%     
==========================================
  Files         202      202              
  Lines        3234     3235       +1     
  Branches      971      972       +1     
==========================================
+ Hits         2936     2937       +1     
  Misses        215      215              
  Partials       83       83
Impacted Files Coverage Δ
src/utils/env.js 100% <100%> (ø) ⬆️

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 a17de35...3a424e6. Read the comment docs.

@ghost ghost changed the title feat: add configurable global warnHandler feat: add BOOTSTRAP_VUE_NO_WARN environment variable to hide warnings Mar 13, 2019
@ghost
Copy link
Author

ghost commented Mar 13, 2019

@tmorehouse I have squashed the commits now and added tests. I'm not quite sure where the docs would go though. Do you have a suggestion?

@tmorehouse
Copy link
Member

@gitlab-winnie I think this is ready for merging.

I'm not sure where this should be documented. I think maybe a new reference section page on miscellaneous settings?

@tmorehouse
Copy link
Member

Added some rudimentary documentation.

@jacobmllr95 jacobmllr95 self-requested a review March 24, 2019 22:25
@tmorehouse tmorehouse merged commit 44d0351 into bootstrap-vue:dev Mar 25, 2019
@ghost
Copy link
Author

ghost commented Mar 25, 2019

Thank you @tmorehouse and @jackmu95 for completing this! ❤️

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.

2 participants