Feat/export package version constant

Gruntfile.js

@@ -1,3 +1,4 @@
+// eslint-disable-next-line strict
 module.exports = function(grunt) {
   require('load-grunt-tasks')(grunt);
 
@@ -37,6 +38,10 @@ module.exports = function(grunt) {
       }
     },
 
+    package2env: {
+      all: {}
+    },
+
     usebanner: {
       all: {
         options: {
@@ -70,8 +75,8 @@ module.exports = function(grunt) {
         src: ['test/unit/**/*.js']
       },
       options: {
-        timeout: 30000,
-      },
+        timeout: 30000
+      }
     },
 
     watch: {
@@ -88,20 +93,30 @@ module.exports = function(grunt) {
     webpack: require('./webpack.config.js')
   });
 
-  grunt.registerMultiTask('package2bower', 'Sync package.json to bower.json', function () {
+  grunt.registerMultiTask('package2bower', 'Sync package.json to bower.json', function() {
     var npm = grunt.file.readJSON('package.json');
     var bower = grunt.file.readJSON('bower.json');
     var fields = this.data.fields || [];
 
-    for (var i=0, l=fields.length; i<l; i++) {
+    for (var i = 0, l = fields.length; i < l; i++) {
       var field = fields[i];
       bower[field] = npm[field];
     }
 
     grunt.file.write('bower.json', JSON.stringify(bower, null, 2));
   });
 
+  grunt.registerMultiTask('package2env', 'Sync package.json to env.json', function() {
+    var npm = grunt.file.readJSON('package.json');
+    grunt.file.write('./lib/env/data.js', [
+      'module.exports = ',
+      JSON.stringify({
+        version: npm.version
+      }, null, 2),
+      ';'].join(''));
+  });
+
   grunt.registerTask('test', 'Run the jasmine and mocha tests', ['eslint', 'mochaTest', 'karma:single', 'ts']);
   grunt.registerTask('build', 'Run webpack and bundle the source', ['clean', 'webpack']);
-  grunt.registerTask('version', 'Sync version info for a release', ['usebanner', 'package2bower']);
+  grunt.registerTask('version', 'Sync version info for a release', ['usebanner', 'package2bower', 'package2env']);
 };

index.d.ts

@@ -162,6 +162,7 @@ export interface AxiosStatic extends AxiosInstance {
   Cancel: CancelStatic;
   CancelToken: CancelTokenStatic;
   Axios: typeof Axios;
+  readonly VERSION: string;
   isCancel(value: any): boolean;
   all<T>(values: (T | Promise<T>)[]): Promise<T[]>;
   spread<T, R>(callback: (...args: T[]) => R): (array: T[]) => R;

lib/adapters/http.js

@@ -10,7 +10,7 @@ var httpFollow = require('follow-redirects').http;
 var httpsFollow = require('follow-redirects').https;
 var url = require('url');
 var zlib = require('zlib');
-var pkg = require('./../../package.json');
+var VERSION = require('./../env/data').version;
 var createError = require('../core/createError');
 var enhanceError = require('../core/enhanceError');
 
@@ -68,7 +68,7 @@ module.exports = function httpAdapter(config) {
       // Otherwise, use specified value
     } else {
       // Only set header if it hasn't been set in config
-      headers['User-Agent'] = 'axios/' + pkg.version;
+      headers['User-Agent'] = 'axios/' + VERSION;
     }
 
     if (data && !utils.isStream(data)) {

lib/axios.js

@@ -40,6 +40,7 @@ axios.Axios = Axios;
 axios.Cancel = require('./cancel/Cancel');
 axios.CancelToken = require('./cancel/CancelToken');
 axios.isCancel = require('./cancel/isCancel');
+axios.VERSION = require('./env/data').version;
 
 // Expose all/spread
 axios.all = function all(promises) {

lib/core/Axios.js

@@ -51,9 +51,9 @@ Axios.prototype.request = function request(config) {
 
   if (transitional !== undefined) {
     validator.assertOptions(transitional, {
-      silentJSONParsing: validators.transitional(validators.boolean, '1.0.0'),
-      forcedJSONParsing: validators.transitional(validators.boolean, '1.0.0'),
-      clarifyTimeoutError: validators.transitional(validators.boolean, '1.0.0')
+      silentJSONParsing: validators.transitional(validators.boolean),
+      forcedJSONParsing: validators.transitional(validators.boolean),
+      clarifyTimeoutError: validators.transitional(validators.boolean)
     }, false);
   }
 

lib/env/README.md

@@ -0,0 +1,3 @@
+# axios // env
+
+The `data.js` file is updated automatically when the package version is upgrading. Please do not edit it manually.

lib/env/data.js

@@ -0,0 +1,3 @@
+module.exports = {
+  "version": "0.21.4"
+};

lib/helpers/validator.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var pkg = require('./../../package.json');
+var VERSION = require('../env/data').version;
 
 var validators = {};
 
@@ -12,48 +12,26 @@ var validators = {};
 });
 
 var deprecatedWarnings = {};
-var currentVerArr = pkg.version.split('.');
-
-/**
- * Compare package versions
- * @param {string} version
- * @param {string?} thanVersion
- * @returns {boolean}
- */
-function isOlderVersion(version, thanVersion) {
-  var pkgVersionArr = thanVersion ? thanVersion.split('.') : currentVerArr;
-  var destVer = version.split('.');
-  for (var i = 0; i < 3; i++) {
-    if (pkgVersionArr[i] > destVer[i]) {
-      return true;
-    } else if (pkgVersionArr[i] < destVer[i]) {
-      return false;
-    }
-  }
-  return false;
-}
 
 /**
  * Transitional option validator
- * @param {function|boolean?} validator
- * @param {string?} version
- * @param {string} message
+ * @param {function|boolean?} validator - set to false if the transitional option has been removed
+ * @param {string?} version - deprecated version / removed since version
+ * @param {string?} message - some message with additional info
  * @returns {function}
  */
 validators.transitional = function transitional(validator, version, message) {
-  var isDeprecated = version && isOlderVersion(version);
-
   function formatMessage(opt, desc) {
-    return '[Axios v' + pkg.version + '] Transitional option \'' + opt + '\'' + desc + (message ? '. ' + message : '');
+    return '[Axios v' + VERSION + '] Transitional option \'' + opt + '\'' + desc + (message ? '. ' + message : '');
   }
 
   // eslint-disable-next-line func-names
   return function(value, opt, opts) {
     if (validator === false) {
-      throw new Error(formatMessage(opt, ' has been removed in ' + version));
+      throw new Error(formatMessage(opt, ' has been removed' + (version ? ' in ' + version : '')));
     }
 
-    if (isDeprecated && !deprecatedWarnings[opt]) {
+    if (version && !deprecatedWarnings[opt]) {
       deprecatedWarnings[opt] = true;
       // eslint-disable-next-line no-console
       console.warn(
@@ -99,7 +77,6 @@ function assertOptions(options, schema, allowUnknown) {
 }
 
 module.exports = {
-  isOlderVersion: isOlderVersion,
   assertOptions: assertOptions,
   validators: validators
 };

test/specs/helpers/validator.spec.js

@@ -2,23 +2,8 @@
 
 var validator = require('../../../lib/helpers/validator');
 
-describe('validator::isOlderVersion', function () {
-  it('should return true if dest version is older than the package version', function () {
-    expect(validator.isOlderVersion('0.0.1', '1.0.0')).toEqual(true);
-    expect(validator.isOlderVersion('0.0.1', '0.1.0')).toEqual(true);
-    expect(validator.isOlderVersion('0.0.1', '0.0.1')).toEqual(false);
-
-
-    expect(validator.isOlderVersion('100.0.0', '1.0.0')).toEqual(false);
-    expect(validator.isOlderVersion('100.0.0', '0.1.0')).toEqual(false);
-    expect(validator.isOlderVersion('100.0.0', '0.0.1')).toEqual(false);
-
-    expect(validator.isOlderVersion('0.10000.0', '1000.0.1')).toEqual(true);
-  });
-});
-
-describe('validator::assertOptions', function () {
-  it('should throw only if unknown an option was passed', function () {
+describe('validator::assertOptions', function() {
+  it('should throw only if unknown an option was passed', function() {
     expect(function() {
       validator.assertOptions({
         x: true
@@ -37,7 +22,7 @@ describe('validator::assertOptions', function () {
     }).not.toThrow(new Error('Unknown option x'));
   });
 
-  it('should throw TypeError only if option type doesn\'t match', function () {
+  it('should throw TypeError only if option type doesn\'t match', function() {
     expect(function() {
       validator.assertOptions({
         x: 123

test/specs/instance.spec.js

@@ -20,6 +20,7 @@ describe('instance', function () {
         'all',
         'spread',
         'isAxiosError',
+        'VERSION',
         'default'].indexOf(prop) > -1) {
         continue;
       }