Skip to content

Add a process.emitWarning for deprecated #202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 6, 2016
Merged

Add a process.emitWarning for deprecated #202

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ce25c0b
Add a console.log call for @deprecated
sigv Oct 3, 2016
98fa973
Prefer process.emitWarning for @deprecated
sigv Oct 3, 2016
f83795a
Inform about @deprecated only once
sigv Oct 3, 2016
86b1123
Do not repeat the same string twice
sigv Oct 3, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions lib/core.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ var Archiver = function(format, options) {
};

this._streams = [];

this._loggedBulkDeprecation = false;
};

inherits(Archiver, Transform);
Expand Down Expand Up @@ -555,6 +557,16 @@ Archiver.prototype.append = function(source, data) {
* @return {this}
*/
Archiver.prototype.bulk = function(mappings) {
if (!this._loggedBulkDeprecation) {
this._loggedBulkDeprecation = true;
var warning = 'Archiver.bulk() deprecated since 0.21.0';
if (typeof process !== 'undefined' && typeof process.emitWarning !== 'undefined') {
process.emitWarning(warning, 'DeprecationWarning');
} else {
console.warn(warning);
}
Copy link
Contributor

@soyuka soyuka Oct 3, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh sorry there's been a misunderstanding,

I was thinking into something like:

var warning = 'Archiver.bulk() deprecated since 0.21.0'
if (typeof process !== 'undefined' && typeof process.emitWarning !== 'undefined') {
    process.emitWarning(warning, 'DeprecationWarning');
} else {
    console.warn(warning);
}

Copy link
Contributor Author

@sigv sigv Oct 3, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, that can be done as well. Do you want me to leave the _loggedBulkDeprecation in there or do you want me to log on each call?

Copy link
Contributor Author

@sigv sigv Oct 3, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pushed 86b1123 which deals with the repeated string. If you want me to drop the _loggedBulkDeprecation, let me know.

Copy link
Contributor

@soyuka soyuka Oct 4, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a nice improvement imo, let's see what @ctalkington thinks

}
Copy link
Contributor

@soyuka soyuka Oct 3, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 test of console is overkill, also you might want to declare a variable for the error string to avoid repeating it.

Then 👍

Copy link
Contributor Author

@sigv sigv Oct 3, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got ya.


if (this._state.finalize || this._state.aborted) {
this.emit('error', new Error('bulk: queue closed'));
return this;
Expand Down