@@ -6,6 +6,8 @@
const { CALL, CONSTRUCT, READ, ReferenceTracker } = require("eslint-utils")
const enumeratePropertyNames = require("../util/enumerate-property-names")
+const getConfiguredNodeVersion = require("../util/get-configured-node-version")
+const getSemverRange = require("../util/get-semver-range")
const modules = {
_linklist: {
@@ -19,28 +21,40 @@
deepEqual: {
[READ]: {
since: "10.0.0",
- replacedBy:
- "'assert.deepStrictEqual' or 'assert.strict.deepEqual'",
+ replacedBy: [
+ { name: "'assert.deepStrictEqual'", supported: "1.2.0" },
+ { name: "'assert.strict.deepEqual'", supported: "9.9.0" },
+ ],
},
},
equal: {
[READ]: {
since: "10.0.0",
- replacedBy: "'assert.strictEqual' or 'assert.strict.equal'",
+ replacedBy: [
+ { name: "'assert.strictEqual'", supported: "0.1.21" },
+ { name: "'assert.strict.equal'", supported: "9.9.0" },
+ ],
},
},
notDeepEqual: {
[READ]: {
since: "10.0.0",
- replacedBy:
- "'assert.notDeepStrictEqual' or 'assert.strict.notDeepEqual'",
+ replacedBy: [
+ { name: "'assert.notDeepStrictEqual'", supported: "1.2.0" },
+ {
+ name: "'assert.strict.notDeepEqual'",
+ supported: "9.9.0",
+ },
+ ],
},
},
notEqual: {
[READ]: {
since: "10.0.0",
- replacedBy:
- "'assert.notStrictEqual' or 'assert.strict.notEqual'",
+ replacedBy: [
+ { name: "'assert.notStrictEqual'", supported: "0.1.21" },
+ { name: "'assert.strict.notEqual'", supported: "9.9.0" },
+ ],
},
},
},
@@ -49,7 +63,12 @@
currentId: {
[READ]: {
since: "8.2.0",
- replacedBy: "'async_hooks.executionAsyncId()'",
+ replacedBy: [
+ {
+ name: "'async_hooks.executionAsyncId()'",
+ supported: "8.1.0",
+ },
+ ],
},
},
triggerId: {
@@ -63,17 +82,28 @@
Buffer: {
[CONSTRUCT]: {
since: "6.0.0",
- replacedBy: "'buffer.Buffer.alloc()' or 'buffer.Buffer.from()'",
+ replacedBy: [
+ { name: "'buffer.Buffer.alloc()'", supported: "5.10.0" },
+ { name: "'buffer.Buffer.from()'", supported: "5.10.0" },
+ ],
},
[CALL]: {
since: "6.0.0",
- replacedBy: "'buffer.Buffer.alloc()' or 'buffer.Buffer.from()'",
+ replacedBy: [
+ { name: "'buffer.Buffer.alloc()'", supported: "5.10.0" },
+ { name: "'buffer.Buffer.from()'", supported: "5.10.0" },
+ ],
},
},
SlowBuffer: {
[READ]: {
since: "6.0.0",
- replacedBy: "'buffer.Buffer.allocUnsafeSlow()'",
+ replacedBy: [
+ {
+ name: "'buffer.Buffer.allocUnsafeSlow()'",
+ supported: "5.12.0",
+ },
+ ],
},
},
},
@@ -96,35 +126,67 @@
createCipher: {
[READ]: {
since: "10.0.0",
- replacedBy: "'crypto.createCipheriv()'",
+ replacedBy: [
+ { name: "'crypto.createCipheriv()'", supported: "0.1.94" },
+ ],
},
},
createCredentials: {
[READ]: {
since: "0.12.0",
- replacedBy: "'tls.createSecureContext()'",
+ replacedBy: [
+ {
+ name: "'tls.createSecureContext()'",
+ supported: "0.11.13",
+ },
+ ],
},
},
createDecipher: {
[READ]: {
since: "10.0.0",
- replacedBy: "'crypto.createDecipheriv()'",
+ replacedBy: [
+ {
+ name: "'crypto.createDecipheriv()'",
+ supported: "0.1.94",
+ },
+ ],
},
},
fips: {
[READ]: {
since: "10.0.0",
- replacedBy: "'crypto.getFips()' and 'crypto.setFips()'",
+ replacedBy: [
+ {
+ name: "'crypto.getFips()' and 'crypto.setFips()'",
+ supported: "10.0.0",
+ },
+ ],
},
},
prng: {
- [READ]: { since: "11.0.0", replacedBy: "'crypto.randomBytes()'" },
+ [READ]: {
+ since: "11.0.0",
+ replacedBy: [
+ { name: "'crypto.randomBytes()'", supported: "0.5.8" },
+ ],
+ },
},
pseudoRandomBytes: {
- [READ]: { since: "11.0.0", replacedBy: "'crypto.randomBytes()'" },
+ [READ]: {
+ since: "11.0.0",
+ replacedBy: [
+ { name: "'crypto.randomBytes()'", supported: "0.5.8" },
+ ],
+ },
},
rng: {
- [READ]: { since: "11.0.0", replacedBy: "'crypto.randomBytes()'" },
+ [READ]: {
+ since: "11.0.0",
+ replacedBy: [
+ { name: "'crypto.randomBytes()'", supported: "0.5.8" },
+ ],
+ },
},
},
domain: {
@@ -135,14 +197,24 @@
listenerCount: {
[READ]: {
since: "4.0.0",
- replacedBy: "'events.EventEmitter#listenerCount()'",
+ replacedBy: [
+ {
+ name: "'events.EventEmitter#listenerCount()'",
+ supported: "3.2.0",
+ },
+ ],
},
},
},
listenerCount: {
[READ]: {
since: "4.0.0",
- replacedBy: "'events.EventEmitter#listenerCount()'",
+ replacedBy: [
+ {
+ name: "'events.EventEmitter#listenerCount()'",
+ supported: "3.2.0",
+ },
+ ],
},
},
},
@@ -156,7 +228,10 @@
exists: {
[READ]: {
since: "4.0.0",
- replacedBy: "'fs.stat()' or 'fs.access()'",
+ replacedBy: [
+ { name: "'fs.stat()'", supported: "0.0.2" },
+ { name: "'fs.access()'", supported: "0.11.15" },
+ ],
},
},
lchmod: {
@@ -174,20 +249,29 @@
},
http: {
createClient: {
- [READ]: { since: "0.10.0", replacedBy: "'http.request()'" },
+ [READ]: {
+ since: "0.10.0",
+ replacedBy: [{ name: "'http.request()'", supported: "0.3.6" }],
+ },
},
},
module: {
Module: {
requireRepl: {
- [READ]: { since: "6.0.0", replacedBy: "'require(\"repl\")'" },
+ [READ]: {
+ since: "6.0.0",
+ replacedBy: "'require(\"repl\")'",
+ },
},
_debug: {
[READ]: { since: "9.0.0", replacedBy: null },
},
},
requireRepl: {
- [READ]: { since: "6.0.0", replacedBy: "'require(\"repl\")'" },
+ [READ]: {
+ since: "6.0.0",
+ replacedBy: "'require(\"repl\")'",
+ },
},
_debug: {
[READ]: { since: "9.0.0", replacedBy: null },
@@ -200,30 +284,52 @@
},
os: {
getNetworkInterfaces: {
- [READ]: { since: "0.6.0", replacedBy: "'os.networkInterfaces()'" },
+ [READ]: {
+ since: "0.6.0",
+ replacedBy: [
+ { name: "'os.networkInterfaces()'", supported: "0.6.0" },
+ ],
+ },
},
tmpDir: {
- [READ]: { since: "7.0.0", replacedBy: "'os.tmpdir()'" },
+ [READ]: {
+ since: "7.0.0",
+ replacedBy: [{ name: "'os.tmpdir()'", supported: "0.9.9" }],
+ },
},
},
path: {
_makeLong: {
- [READ]: { since: "9.0.0", replacedBy: "'path.toNamespacedPath()'" },
+ [READ]: {
+ since: "9.0.0",
+ replacedBy: [
+ { name: "'path.toNamespacedPath()'", supported: "9.0.0" },
+ ],
+ },
},
},
process: {
EventEmitter: {
- [READ]: { since: "0.6.0", replacedBy: "'require(\"events\")'" },
+ [READ]: {
+ since: "0.6.0",
+ replacedBy: "'require(\"events\")'",
+ },
},
assert: {
- [READ]: { since: "10.0.0", replacedBy: "'require(\"assert\")'" },
+ [READ]: {
+ since: "10.0.0",
+ replacedBy: "'require(\"assert\")'",
+ },
},
binding: {
[READ]: { since: "10.9.0", replacedBy: null },
},
env: {
NODE_REPL_HISTORY_FILE: {
- [READ]: { since: "4.0.0", replacedBy: "'NODE_REPL_HISTORY'" },
+ [READ]: {
+ since: "4.0.0",
+ replacedBy: "'NODE_REPL_HISTORY'",
+ },
},
},
report: {
@@ -261,34 +367,54 @@
Buffer: {
[CONSTRUCT]: {
since: "6.0.0",
- replacedBy: "'buffer.Buffer.alloc()' or 'buffer.Buffer.from()'",
+ replacedBy: [
+ { name: "'buffer.Buffer.alloc()'", supported: "5.10.0" },
+ { name: "'buffer.Buffer.from()'", supported: "5.10.0" },
+ ],
},
[CALL]: {
since: "6.0.0",
- replacedBy: "'buffer.Buffer.alloc()' or 'buffer.Buffer.from()'",
+ replacedBy: [
+ { name: "'buffer.Buffer.alloc()'", supported: "5.10.0" },
+ { name: "'buffer.Buffer.from()'", supported: "5.10.0" },
+ ],
},
},
SlowBuffer: {
[READ]: {
since: "6.0.0",
- replacedBy: "'buffer.Buffer.allocUnsafeSlow()'",
+ replacedBy: [
+ {
+ name: "'buffer.Buffer.allocUnsafeSlow()'",
+ supported: "5.12.0",
+ },
+ ],
},
},
},
sys: {
- [READ]: { since: "0.3.0", replacedBy: "'util' module" },
+ [READ]: {
+ since: "0.3.0",
+ replacedBy: "'util' module",
+ },
},
timers: {
enroll: {
[READ]: {
since: "10.0.0",
- replacedBy: "'setTimeout()' or 'setInterval()'",
+ replacedBy: [
+ { name: "'setTimeout()'", supported: "0.0.1" },
+ { name: "'setInterval()'", supported: "0.0.1" },
+ ],
},
},
unenroll: {
[READ]: {
since: "10.0.0",
- replacedBy: "'clearTimeout()' or 'clearInterval()'",
+ replacedBy: [
+ { name: "'clearTimeout()'", supported: "0.0.1" },
+ { name: "'clearInterval()'", supported: "0.0.1" },
+ ],
},
},
},
@@ -297,19 +423,33 @@
[READ]: { since: "0.10.0", replacedBy: null },
},
CryptoStream: {
- [READ]: { since: "0.12.0", replacedBy: "'tls.TLSSocket'" },
+ [READ]: {
+ since: "0.12.0",
+ replacedBy: [{ name: "'tls.TLSSocket'", supported: "0.11.4" }],
+ },
},
SecurePair: {
- [READ]: { since: "6.0.0", replacedBy: "'tls.TLSSocket'" },
+ [READ]: {
+ since: "6.0.0",
+ replacedBy: [{ name: "'tls.TLSSocket'", supported: "0.11.4" }],
+ },
},
convertNPNProtocols: {
[READ]: { since: "10.0.0", replacedBy: null },
},
createSecurePair: {
- [READ]: { since: "6.0.0", replacedBy: "'tls.TLSSocket'" },
+ [READ]: {
+ since: "6.0.0",
+ replacedBy: [{ name: "'tls.TLSSocket'", supported: "0.11.4" }],
+ },
},
parseCertString: {
- [READ]: { since: "8.6.0", replacedBy: "'querystring.parse()'" },
+ [READ]: {
+ since: "8.6.0",
+ replacedBy: [
+ { name: "'querystring.parse()'", supported: "0.1.25" },
+ ],
+ },
},
},
tty: {
@@ -323,27 +463,57 @@
},
url: {
parse: {
- [READ]: { since: "11.0.0", replacedBy: "'url.URL' constructor" },
+ [READ]: {
+ since: "11.0.0",
+ replacedBy: [
+ { name: "'url.URL' constructor", supported: "6.13.0" },
+ ],
+ },
},
resolve: {
- [READ]: { since: "11.0.0", replacedBy: "'url.URL' constructor" },
+ [READ]: {
+ since: "11.0.0",
+ replacedBy: [
+ { name: "'url.URL' constructor", supported: "6.13.0" },
+ ],
+ },
},
},
util: {
debug: {
- [READ]: { since: "0.12.0", replacedBy: "'console.error()'" },
+ [READ]: {
+ since: "0.12.0",
+ replacedBy: [
+ { name: "'console.error()'", supported: "0.1.100" },
+ ],
+ },
},
error: {
- [READ]: { since: "0.12.0", replacedBy: "'console.error()'" },
+ [READ]: {
+ since: "0.12.0",
+ replacedBy: [
+ { name: "'console.error()'", supported: "0.1.100" },
+ ],
+ },
},
isArray: {
- [READ]: { since: "4.0.0", replacedBy: "'Array.isArray()'" },
+ [READ]: {
+ since: "4.0.0",
+ replacedBy: [
+ { name: "'Array.isArray()'", supported: "0.1.100" },
+ ],
+ },
},
isBoolean: {
[READ]: { since: "4.0.0", replacedBy: null },
},
isBuffer: {
- [READ]: { since: "4.0.0", replacedBy: "'Buffer.isBuffer()'" },
+ [READ]: {
+ since: "4.0.0",
+ replacedBy: [
+ { name: "'Buffer.isBuffer()'", supported: "0.1.101" },
+ ],
+ },
},
isDate: {
[READ]: { since: "4.0.0", replacedBy: null },
@@ -385,16 +555,30 @@
[READ]: { since: "6.0.0", replacedBy: "a third party module" },
},
print: {
- [READ]: { since: "0.12.0", replacedBy: "'console.log()'" },
+ [READ]: {
+ since: "0.12.0",
+ replacedBy: [{ name: "'console.log()'", supported: "0.1.100" }],
+ },
},
pump: {
- [READ]: { since: "0.10.0", replacedBy: "'stream.Readable#pipe()'" },
+ [READ]: {
+ since: "0.10.0",
+ replacedBy: [
+ { name: "'stream.Readable#pipe()'", supported: "0.9.4" },
+ ],
+ },
},
puts: {
- [READ]: { since: "0.12.0", replacedBy: "'console.log()'" },
+ [READ]: {
+ since: "0.12.0",
+ replacedBy: [{ name: "'console.log()'", supported: "0.1.100" }],
+ },
},
_extend: {
- [READ]: { since: "6.0.0", replacedBy: "'Object.assign()'" },
+ [READ]: {
+ since: "6.0.0",
+ replacedBy: [{ name: "'Object.assign()'", supported: "4.0.0" }],
+ },
},
},
vm: {
@@ -407,11 +591,17 @@
Buffer: {
[CONSTRUCT]: {
since: "6.0.0",
- replacedBy: "'Buffer.alloc()' or 'Buffer.from()'",
+ replacedBy: [
+ { name: "'Buffer.alloc()'", supported: "5.10.0" },
+ { name: "'Buffer.from()'", supported: "5.10.0" },
+ ],
},
[CALL]: {
since: "6.0.0",
- replacedBy: "'Buffer.alloc()' or 'Buffer.from()'",
+ replacedBy: [
+ { name: "'Buffer.alloc()'", supported: "5.10.0" },
+ { name: "'Buffer.from()'", supported: "5.10.0" },
+ ],
},
},
COUNTER_NET_SERVER_CONNECTION: {
@@ -433,7 +623,10 @@
[READ]: { since: "11.0.0", replacedBy: null },
},
GLOBAL: {
- [READ]: { since: "6.0.0", replacedBy: "'global'" },
+ [READ]: {
+ since: "6.0.0",
+ replacedBy: [{ name: "'global'", supported: "0.1.27" }],
+ },
},
Intl: {
v8BreakIterator: {
@@ -449,7 +642,10 @@
},
},
root: {
- [READ]: { since: "6.0.0", replacedBy: "'global'" },
+ [READ]: {
+ since: "6.0.0",
+ replacedBy: [{ name: "'global'", supported: "0.1.27" }],
+ },
},
process: modules.process,
}
@@ -457,11 +653,26 @@
/**
* Makes a replacement message.
*
- * @param {string|null} replacedBy - The text of substitute way.
+ * @param {string|array|null} replacedBy - The text of substitute way.
+ * @param {Range} version - The configured version range
* @returns {string} Replacement message.
*/
-function toReplaceMessage(replacedBy) {
- return replacedBy ? `. Use ${replacedBy} instead` : ""
+function toReplaceMessage(replacedBy, version) {
+ let message = replacedBy
+
+ if (Array.isArray(replacedBy)) {
+ message = replacedBy
+ .reduce(
+ (collector, { name, supported }) =>
+ version.intersects(getSemverRange(`>=${supported}`))
+ ? collector.concat(name)
+ : collector,
+ []
+ )
+ .join(" or ")
+ }
+
+ return message ? `. Use ${message} instead` : ""
}
/**
@@ -479,6 +690,22 @@
: baseName
}
+/**
+ * Parses the options.
+ * @param {RuleContext} context The rule context.
+ * @returns {{version:Range,ignoredGlobalItems:Set<string>,ignoredModuleItems:Set<string>}} Parsed
+ * value.
+ */
+function parseOptions(context) {
+ const raw = context.options[0] || {}
+ const filePath = context.getFilename()
+ const version = getConfiguredNodeVersion(raw.version, filePath)
+ const ignoredModuleItems = new Set(raw.ignoreModuleItems || [])
+ const ignoredGlobalItems = new Set(raw.ignoreGlobalItems || [])
+
+ return Object.freeze({ version, ignoredGlobalItems, ignoredModuleItems })
+}
+
module.exports = {
meta: {
docs: {
@@ -486,7 +713,7 @@
category: "Best Practices",
recommended: true,
url:
- "https://github.com/mysticatea/eslint-plugin-node/blob/v9.0.1/docs/rules/no-deprecated-api.md",
+ "https://github.com/mysticatea/eslint-plugin-node/blob/v9.1.0/docs/rules/no-deprecated-api.md",
},
type: "problem",
fixable: null,
@@ -494,6 +721,9 @@
{
type: "object",
properties: {
+ version: {
+ type: "string",
+ },
ignoreModuleItems: {
type: "array",
items: {
@@ -519,9 +749,11 @@
],
},
create(context) {
- const options = context.options[0] || {}
- const ignoredModuleItems = new Set(options.ignoreModuleItems || [])
- const ignoredGlobalItems = new Set(options.ignoreGlobalItems || [])
+ const {
+ ignoredModuleItems,
+ ignoredGlobalItems,
+ version,
+ } = parseOptions(context)
/**
* Reports a use of a deprecated API.
@@ -540,7 +772,7 @@
data: {
name,
version: info.since,
- replace: toReplaceMessage(info.replacedBy),
+ replace: toReplaceMessage(info.replacedBy, version),
},
})
}