Merge branch 'dev' into tmorehouse/config

tmorehouse · web-flow · commit 73d7ce4f6474 · 2019-03-24T21:26:38.000-03:00
diff --git a/docs/markdown/misc/settings/README.md b/docs/markdown/misc/settings/README.md
@@ -0,0 +1,21 @@
+# Miscellaneous Settings
+
+## Disabling BootstrapVue console warnings
+
+BootstrapVue will warn (via `console.warn`) when you try and use a depreated prop, or pass
+an invalid value to certain props. These warnings are provided to help you ensure that your
+application is using the correct props and values.
+
+In some cases, you may want to disable these warnings (not recommended). You can do so by
+setting the following process envinronment variable:
+
+<!-- eslint-disable no-unused-vars -->
+
+```js
+process.env.BOOTSTRAP_VUE_NO_WARN = true
+```
+
+By ignoring warnings, you may find that your project fails/breaks when using future releases
+of bootstrapVue where deprecated props have been removed.
+
+Warnings should be corrected before moving your project into production!
diff --git a/docs/markdown/misc/settings/meta.json b/docs/markdown/misc/settings/meta.json
@@ -0,0 +1,3 @@
+{
+  "title": "Settings"
+}
diff --git a/package.json b/package.json
@@ -118,7 +118,7 @@
     "nuxt": "^2.5.1",
     "postcss-cli": "^6.1.2",
     "prettier": "1.14.3",
-    "rollup": "^1.7.0",
+    "rollup": "^1.7.2",
     "rollup-plugin-babel": "^4.3.2",
     "rollup-plugin-commonjs": "^9.2.1",
     "rollup-plugin-node-resolve": "^4.0.1",
diff --git a/src/utils/env.js b/src/utils/env.js
@@ -1,5 +1,7 @@
 // Info about the current environment
 
+// Constants
+
 export const inBrowser = typeof document !== 'undefined' && typeof window !== 'undefined'
 
 export const isServer = !inBrowser
@@ -8,3 +10,7 @@ export const hasTouchSupport =
   inBrowser && ('ontouchstart' in document.documentElement || navigator.maxTouchPoints > 0)
 
 export const hasPointerEvent = inBrowser && Boolean(window.PointerEvent || window.MSPointerEvent)
+
+// Getters
+
+export const getNoWarn = () => process && process.env && process.env.BOOTSTRAP_VUE_NO_WARN
diff --git a/src/utils/warn.js b/src/utils/warn.js
@@ -1,10 +1,14 @@
+import { getNoWarn } from './env'
+
 /**
  * Log a warning message to the console with bootstrap-vue formatting sugar.
  * @param {string} message
  */
 /* istanbul ignore next */
 const warn = message => {
-  console.warn(`[BootstrapVue warn]: ${message}`)
+  if (!getNoWarn()) {
+    console.warn(`[BootstrapVue warn]: ${message}`)
+  }
 }
 
 export default warn
diff --git a/src/utils/warn.spec.js b/src/utils/warn.spec.js
@@ -0,0 +1,45 @@
+import warn from './warn'
+
+describe('utils/warn', () => {
+  const dummyWarning = 'A Rush Of Blood To The Head'
+
+  let originalProcess
+
+  beforeAll(() => {
+    jest.spyOn(console, 'warn').mockImplementation(() => {})
+    originalProcess = global.process
+  })
+
+  afterEach(() => {
+    console.warn.mockClear()
+    global.process = originalProcess
+  })
+
+  describe('with BOOTSTRAP_VUE_NO_WARN environment variable set', () => {
+    beforeEach(() => {
+      global.process = {
+        env: {
+          BOOTSTRAP_VUE_NO_WARN: true
+        }
+      }
+    })
+
+    it('does not call console.warn()', () => {
+      warn(dummyWarning)
+
+      expect(console.warn).not.toHaveBeenCalled()
+    })
+  })
+
+  describe('without process object', () => {
+    beforeEach(() => {
+      global.process = null
+    })
+
+    it('calls console.warn()', () => {
+      warn(dummyWarning)
+
+      expect(console.warn).toHaveBeenCalledWith(`[BootstrapVue warn]: ${dummyWarning}`)
+    })
+  })
+})
diff --git a/yarn.lock b/yarn.lock
@@ -1472,11 +1472,16 @@
   resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-3.0.3.tgz#3dca0e3f33b200fc7d1139c0cd96c1268cadfd9d"
   integrity sha512-tHq6qdbT9U1IRSGf14CL0pUlULksvY9OZ+5eEgl1N7t+OA3tGvNpxJCzuKQlsNgCVwbAs670L1vcVQi8j9HjnA==
 
-"@types/node@*", "@types/node@^11.9.5":
+"@types/node@*":
   version "11.11.4"
   resolved "https://registry.yarnpkg.com/@types/node/-/node-11.11.4.tgz#8808bd5a82bbf6f5d412eff1c228d178e7c24bb3"
   integrity sha512-02tIL+QIi/RW4E5xILdoAMjeJ9kYq5t5S2vciUdFPXv/ikFTb0zK8q9vXkg4+WAJuYXGiVT1H28AkD2C+IkXVw==
 
+"@types/node@^11.11.6":
+  version "11.11.6"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-11.11.6.tgz#df929d1bb2eee5afdda598a41930fe50b43eaa6a"
+  integrity sha512-Exw4yUWMBXM3X+8oqzJNRqZSwUAaS4+7NdvHqQuFi/d+synz++xmX3QIf+BFqneW8N31R8Ky+sikfZUXq07ggQ==
+
 "@types/q@^1.5.1":
   version "1.5.2"
   resolved "https://registry.yarnpkg.com/@types/q/-/q-1.5.2.tgz#690a1475b84f2a884fd07cd797c00f5f31356ea8"
@@ -9493,13 +9498,13 @@ rollup-watch@^4.3.1:
     require-relative "0.8.7"
     rollup-pluginutils "^2.0.1"
 
-rollup@^1.7.0:
-  version "1.7.0"
-  resolved "https://registry.yarnpkg.com/rollup/-/rollup-1.7.0.tgz#2f5063c0f344f2225d1077655dc54d105a512bb2"
-  integrity sha512-hjuWSCgoQsFSTsmsNP4AH1l1kfkFqW82gW00V9nL81Zr3JtnKn3rvxh18jUAAEMb7qNoHj21PR5SqbK2mhBgMg==
+rollup@^1.7.2:
+  version "1.7.2"
+  resolved "https://registry.yarnpkg.com/rollup/-/rollup-1.7.2.tgz#6a2c50843915cba2c1432028e741f2ccb39e8ca3"
+  integrity sha512-HdbjbHsvoLDwJU/lWEyktVlLdXR7mtnNxRnzaDb+fiNiboAxDYCpwLz1zLGI3+k890PacAptSGrqJLJnABMKJg==
   dependencies:
     "@types/estree" "0.0.39"
-    "@types/node" "^11.9.5"
+    "@types/node" "^11.11.6"
     acorn "^6.1.1"
 
 rsvp@^4.8.4:
