Skip to content

Add deprecation warnings for enums that need them. #1711

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
implausible merged 1 commit into from
Aug 8, 2019
Merged

Add deprecation warnings for enums that need them. #1711

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 20 additions & 0 deletions lib/attr.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
var util = require("util");
var NodeGit = require("../");

NodeGit.Attr.STATES = {};
var DEPRECATED_STATES = {
UNSPECIFIED_T: "UNSPECIFIED",
TRUE_T: "TRUE",
FALSE_T: "FALSE",
VALUE_T: "STRING"
};

Object.keys(DEPRECATED_STATES).forEach((key) => {
const newKey = DEPRECATED_STATES[key];
Object.defineProperty(NodeGit.Attr.STATES, key, {
get: util.deprecate(
() => NodeGit.Attr.VALUE[newKey],
`Use NodeGit.Attr.VALUE.${newKey} instead of NodeGit.Attr.STATES.${key}.`
)
});
});
17 changes: 17 additions & 0 deletions lib/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
var util = require("util");
var NodeGit = require("../");

var Config = NodeGit.Config;
Expand All @@ -6,3 +7,19 @@ var Config = NodeGit.Config;
Config.prototype.getString = function() {
return this.getStringBuf.apply(this, arguments);
};

NodeGit.Enums.CVAR = {};
var DEPRECATED_CVAR_ENUMS = [
"FALSE",
"TRUE",
"INT32",
"STRING"
];
DEPRECATED_CVAR_ENUMS.forEach((key) => {
Object.defineProperty(NodeGit.Enums.CVAR, key, {
get: util.deprecate(
() => Config.MAP[key],
`Use NodeGit.Config.MAP.${key} instead of NodeGit.Enums.CVAR.${key}.`
)
});
});
20 changes: 20 additions & 0 deletions lib/remote.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
var util = require("util");
var NodeGit = require("../");
var normalizeFetchOptions = NodeGit.Utils.normalizeFetchOptions;
var normalizeOptions = NodeGit.Utils.normalizeOptions;
Expand Down Expand Up @@ -182,3 +183,22 @@ Remote.prototype.upload = function(refSpecs, opts) {

return _upload.call(this, refSpecs, opts);
};


NodeGit.Remote.COMPLETION_TYPE = {};
var DEPRECATED_STATES = {
COMPLETION_DOWNLOAD: "DOWNLOAD",
COMPLETION_INDEXING: "INDEXING",
COMPLETION_ERROR: "ERROR"
};

Object.keys(DEPRECATED_STATES).forEach((key) => {
const newKey = DEPRECATED_STATES[key];
Object.defineProperty(NodeGit.Remote.COMPLETION_TYPE, key, {
get: util.deprecate(
() => NodeGit.Remote.COMPLETION[newKey],
`Use NodeGit.Remote.COMPLETION.${newKey} instead of ` +
`NodeGit.Remote.COMPLETION_TYPE.${key}.`
)
});
});