Suppress logging with NODE_ENV (digitalocean#332)

Author: MattIPv4

.github/workflows/do-spaces-workflow.yml

@@ -28,6 +28,8 @@ jobs:
 
       - name: Build tool
         run: npm run build
+        env:
+          NODE_ENV: production
 
       - name: Deploy commit to DigitalOcean Spaces
         run: aws s3 sync ./dist s3://${{ secrets.SPACES_BUCKET }}/commits/nginxconfig/${{ github.sha }} --endpoint=https://${{ secrets.SPACES_REGION }}.digitaloceanspaces.com --acl public-read --content-encoding utf8

.github/workflows/gh-pages-workflow.yml

@@ -34,6 +34,8 @@ jobs:
 
       - name: Build tool
         run: npm run build
+        env:
+          NODE_ENV: production
 
       - name: Deploy master to GitHub Pages
         uses: JamesIves/[email protected]

package-lock.json

@@ -85,6 +85,7 @@
     "stylelint-config-standard-scss": "^3.0.0",
     "stylelint-order": "^5.0.0",
     "vue-template-compiler": "^2.6.14",
+    "webpack": "^5.69.1",
     "webpack-bundle-analyzer": "^4.5.0"
   },
   "overrides": {

package.json

@@ -1,5 +1,5 @@
 /*
-Copyright 2021 DigitalOcean
+Copyright 2022 DigitalOcean
 
 This code is licensed under the MIT License.
 You may obtain a copy of the License at
@@ -24,8 +24,10 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 */
 
+import { info } from '../util/log';
+
 const originalSrcDir = document.currentScript.src.split('/').slice(0, -2).join('/') + '/';
 window.__webpackDynamicImportURL = () => {
-    console.info(`Using ${originalSrcDir} for webpack dynamic import`);
+    info(`Using ${originalSrcDir} for webpack dynamic import`);
     return originalSrcDir;
 };

src/nginxconfig/build/webpack-dynamic-import.js

@@ -134,6 +134,7 @@ THE SOFTWARE.
     import analytics from '../util/analytics';
     import browserLanguage from '../util/browser_language';
     import { defaultPack, availablePacks } from '../util/language_packs';
+    import { info, error } from '../util/log';
 
     import { setLanguagePack } from '../i18n/setup';
     import generators from '../generators';
@@ -243,16 +244,15 @@ THE SOFTWARE.
                     // Update the locale
                     setLanguagePack(data.computed).then(() => {
                         // Done
-                        console.log('Language set to', data.computed);
+                        info('Language set to', data.computed);
                         this.$data.languagePrevious = data.computed;
                         this.$data.languageLoading = false;
 
                         // Analytics
                         this.languageSetEvent(!interactive);
                     }).catch((err) => {
                         // Error
-                        console.log('Failed to set language to', data.computed);
-                        console.error(err);
+                        error(`Failed to set language to ${data.computed}`, err);
 
                         // Fallback to last known good
                         data.value = this.$data.languagePrevious;
@@ -358,9 +358,9 @@ THE SOFTWARE.
                             file,
                         ];
                     });
-                } catch (e) {
+                } catch (err) {
                     // If diff generation goes wrong, don't show any diff
-                    console.error(e);
+                    error('Failed to compute and highlight diff', err);
                     this.$data.confFilesOutput = Object.entries(newConf).map(([ name, content ]) => {
                         const safeName = escape(name);
                         const safeContent = escape(content);

src/nginxconfig/templates/app.vue

@@ -1,5 +1,5 @@
 <!--
-Copyright 2021 DigitalOcean
+Copyright 2022 DigitalOcean
 
 This code is licensed under the MIT License.
 You may obtain a copy of the License at
@@ -31,13 +31,15 @@ THE SOFTWARE.
 </template>
 
 <script>
+    import { info } from '../../util/log';
+
     export default {
         name: 'BashPrism',
         props: {
             cmd: String,
         },
         mounted() {
-            console.info(`Highlighting ${this.$props.cmd}...`);
+            info(`Highlighting ${this.$props.cmd}...`);
             window.Prism.highlightAllUnder(this.$el);
         },
         methods: {

src/nginxconfig/templates/prism/bash.vue

@@ -1,5 +1,5 @@
 <!--
-Copyright 2021 DigitalOcean
+Copyright 2022 DigitalOcean
 
 This code is licensed under the MIT License.
 You may obtain a copy of the License at
@@ -33,6 +33,7 @@ THE SOFTWARE.
 
 <script>
     import 'prismjs/components/prism-docker';
+    import { info } from '../../util/log';
 
     export default {
         name: 'DockerPrism',
@@ -42,7 +43,7 @@ THE SOFTWARE.
             half: Boolean,
         },
         mounted() {
-            console.info(`Highlighting ${this.$props.name}...`);
+            info(`Highlighting ${this.$props.name}...`);
             window.Prism.highlightAllUnder(this.$el);
         },
         methods: {

src/nginxconfig/templates/prism/docker.vue

@@ -1,5 +1,5 @@
 <!--
-Copyright 2021 DigitalOcean
+Copyright 2022 DigitalOcean
 
 This code is licensed under the MIT License.
 You may obtain a copy of the License at
@@ -32,6 +32,8 @@ THE SOFTWARE.
 </template>
 
 <script>
+    import { info } from '../../util/log';
+
     export default {
         name: 'NginxPrism',
         props: {
@@ -40,7 +42,7 @@ THE SOFTWARE.
             half: Boolean,
         },
         mounted() {
-            console.info(`Highlighting ${this.$props.name}...`);
+            info(`Highlighting ${this.$props.name}...`);
             window.Prism.highlightAllUnder(this.$el);
         },
         methods: {

src/nginxconfig/templates/prism/nginx.vue

@@ -1,5 +1,5 @@
 <!--
-Copyright 2021 DigitalOcean
+Copyright 2022 DigitalOcean
 
 This code is licensed under the MIT License.
 You may obtain a copy of the License at
@@ -33,6 +33,7 @@ THE SOFTWARE.
 
 <script>
     import 'prismjs/components/prism-yaml';
+    import { info } from '../../util/log';
 
     export default {
         name: 'YamlPrism',
@@ -42,7 +43,7 @@ THE SOFTWARE.
             half: Boolean,
         },
         mounted() {
-            console.info(`Highlighting ${this.$props.name}...`);
+            info(`Highlighting ${this.$props.name}...`);
             window.Prism.highlightAllUnder(this.$el);
         },
         methods: {

src/nginxconfig/templates/prism/yaml.vue

@@ -1,5 +1,5 @@
 /*
-Copyright 2021 DigitalOcean
+Copyright 2022 DigitalOcean
 
 This code is licensed under the MIT License.
 You may obtain a copy of the License at
@@ -24,8 +24,10 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 */
 
+import { info } from './log';
+
 export default ({ category, action, label, value, nonInteraction }) => {
-    console.info('Analytics event:', { category, action, label, value, nonInteraction });
+    info('Analytics event:', { category, action, label, value, nonInteraction });
 
     /*try {
         // Google Analytics

src/nginxconfig/util/analytics.js

@@ -0,0 +1,31 @@
+/*
+Copyright 2022 DigitalOcean
+
+This code is licensed under the MIT License.
+You may obtain a copy of the License at
+https://github.com/digitalocean/nginxconfig.io/blob/master/LICENSE or https://mit-license.org/
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions :
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+*/
+
+export const info = process.env.NODE_ENV !== 'production' ? console.info.bind(console) : () => {};
+export const log = process.env.NODE_ENV !== 'production' ? console.log.bind(console) : () => {};
+
+export const warn = console.warn.bind(console);
+export const error = console.error.bind(console);