make WaveSurfer.VERSION available (katspaugh#1431)

armedoctopus · Aug 20, 2018 · ac84115 · ac84115
1 parent e99d724
commit ac84115
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 2 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -8,7 +8,8 @@ module.exports = {
         Uint32Array: true,
         Promise: true,
         Uint8Array: true,
-        ArrayBuffer: true
+        ArrayBuffer: true,
+        __VERSION__: true
     },
     env: {
         browser: true,

diff --git a/CHANGES.md b/CHANGES.md
@@ -5,6 +5,7 @@ wavesurfer.js changelog
 ------------------
 
 - Add wavesurfer.js logo, created by @entonbiba (#1409)
+- Library version number is now available as `WaveSurfer.VERSION` (#1430)
 - Fix `setSinkId` that used deprecated API (#1428)
 - Set `isReady` attribute to false when emptying wavesufer (#1396, #1403)
 

diff --git a/build-config/fragments/common.js b/build-config/fragments/common.js
@@ -17,6 +17,11 @@ const jsBannerPlugin = new webpack.BannerPlugin({
     test: /\.js$/
 });
 
+// inject JS version number
+const jsVersionPlugin = new webpack.DefinePlugin({
+    __VERSION__: JSON.stringify(pckg.version)
+});
+
 module.exports = {
     context: rootDir,
     mode: 'development',
@@ -50,5 +55,5 @@ module.exports = {
             }
         ]
     },
-    plugins: [jsBannerPlugin]
+    plugins: [jsBannerPlugin, jsVersionPlugin]
 };
diff --git a/spec/wavesurfer.spec.js b/spec/wavesurfer.spec.js
@@ -1,6 +1,7 @@
 /* eslint-env jasmine */
 
 import TestHelpers from './test-helpers.js';
+import WaveSurfer from '../src/wavesurfer.js';
 
 /** @test {WaveSurfer} */
 describe('WaveSurfer/playback:', function() {
@@ -34,6 +35,14 @@ describe('WaveSurfer/playback:', function() {
         expect(wavesurfer.isReady).toBeFalse();
     });
 
+    /**
+     * @test {WaveSurfer#VERSION}
+     */
+    it('should have version number', function() {
+        let version = require('../package.json').version;
+        expect(WaveSurfer.VERSION).toEqual(version);
+    });
+
     /**
      * @test {WaveSurfer#play}
      * @test {WaveSurfer#isPlaying}

diff --git a/src/wavesurfer.js b/src/wavesurfer.js
@@ -232,6 +232,16 @@ export default class WaveSurfer extends util.Observer {
         return wavesurfer.init();
     }
 
+    /**
+     * The library version number is available as a static property of the
+     * WaveSurfer class
+     *
+     * @type {String}
+     * @example
+     * console.log('Using wavesurfer.js ' + WaveSurfer.VERSION);
+     */
+    static VERSION = __VERSION__;
+
     /**
      * Functions in the `util` property are available as a prototype property to
      * all instances