diff --git a/NEWS.md b/NEWS.md index cb050f75..2a4c40a1 100644 --- a/NEWS.md +++ b/NEWS.md @@ -7,6 +7,10 @@ * Promise support for `packager` - function returns a Promise instead of the return value of the callback (#658) +### Removed + +* `version` is removed in favor of `electronVersion` (CLI: `--electron-version`) (#665) + ## [8.7.0] - 2017-05-01 ### Added diff --git a/docs/api.md b/docs/api.md index 710cc0b2..0591a577 100644 --- a/docs/api.md +++ b/docs/api.md @@ -263,11 +263,6 @@ application. This does *not* disable errors. The base directory to use as a temp directory. Set to `false` to disable use of a temporary directory. -##### `version` - -*String* (**deprecated** and will be removed in a future major version, please use the -[`electronVersion`](#electronversion) parameter instead) - #### OS X/Mac App Store targets only ##### `app-bundle-id` diff --git a/index.js b/index.js index 5d1eef30..44d043c5 100644 --- a/index.js +++ b/index.js @@ -148,8 +148,6 @@ module.exports = pify(function packager (opts, cb) { debug(`Target Platforms: ${platforms.join(', ')}`) debug(`Target Architectures: ${archs.join(', ')}`) - common.deprecatedParameter(opts, 'version', 'electronVersion', 'electron-version') - common.camelCase(opts, true) getMetadataFromPackageJSON(opts, path.resolve(process.cwd(), opts.dir) || process.cwd(), function (err) { diff --git a/test/basic.js b/test/basic.js index 2d41f262..5cfbf40f 100644 --- a/test/basic.js +++ b/test/basic.js @@ -299,6 +299,24 @@ test('cannot build apps where the name ends in " Helper"', (t) => { ) }) +test('deprecatedParameter moves value in deprecated param to new param if new param is not set', (t) => { + let opts = { + old: 'value' + } + common.deprecatedParameter(opts, 'old', 'new', 'new-value') + + t.false(opts.hasOwnProperty('old'), 'old property is not set') + t.true(opts.hasOwnProperty('new'), 'new property is set') + + opts.not_overwritten_old = 'another' + common.deprecatedParameter(opts, 'not_overwritten_old', 'new', 'new-value') + + t.false(opts.hasOwnProperty('not_overwritten_old'), 'not_overwritten_old property is not set') + t.true(opts.hasOwnProperty('new'), 'new property is set') + t.equal('value', opts.new, 'new property is not overwritten') + t.end() +}) + util.testSinglePlatform('defaults test', createDefaultsTest) util.testSinglePlatform('out test', createOutTest) util.testSinglePlatform('overwrite test', createOverwriteTest) @@ -344,31 +362,6 @@ util.packagerTest('fails with invalid version', invalidOptionTest({ } })) -util.packagerTest('electronVersion overrides deprecated version', (t) => { - const opts = { - electronVersion: '0.1.2', - version: '1.2.3' - } - - common.deprecatedParameter(opts, 'version', 'electronVersion') - - t.equal(opts.electronVersion, '0.1.2', 'electronVersion should not change') - t.equal(opts.version, undefined, 'version should be deleted') - t.end() -}) - -util.packagerTest('version used if electronVersion not set', (t) => { - const opts = { - version: '1.2.3' - } - - common.deprecatedParameter(opts, 'version', 'electronVersion') - - t.equal(opts.electronVersion, '1.2.3', 'electronVersion have version value') - t.equal(opts.version, undefined, 'version should be deleted') - t.end() -}) - util.packagerTest('dir argument test: should work with relative path', (t) => { const opts = { name: 'ElectronTest', diff --git a/usage.txt b/usage.txt index a5daa13e..7ffeeda2 100644 --- a/usage.txt +++ b/usage.txt @@ -57,7 +57,6 @@ platform all, or one or more of: darwin, linux, mas, win32 (comma-deli quiet Do not print informational or warning messages tmpdir temp directory. Defaults to system temp directory, use --tmpdir=false to disable use of a temporary directory. -version an alias for electron-version (deprecated) * darwin/mas target platforms only *