Skip to content

Commit 2991302

Browse files
ferossmysticatea
feross
authored and
mysticatea
committed
Fix: New Buffer APIs are available in 4.5.0 (#64)
The new Buffer APIs were backported to 4.5.0, so we should update the error message so users who don't care about <4.5.0 can avoid using safe-buffer.
1 parent 5fdb19a commit 2991302

File tree

3 files changed

+27
-27
lines changed

3 files changed

+27
-27
lines changed

‎docs/rules/no-deprecated-api.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ const {exists} = require("fs"); /*ERROR: 'fs.exists' was deprecated since
2424
This rule reports the following deprecated API.
2525

2626
- buffer
27-
- [Buffer constructors](https://nodejs.org/dist/v6.0.0/docs/api/buffer.html#buffer_class_buffer) (Use [safe-buffer](https://www.npmjs.com/package/safe-buffer) module for `Node@<6.0.0`)
27+
- [Buffer constructors](https://nodejs.org/dist/v6.0.0/docs/api/buffer.html#buffer_class_buffer) (Use [safe-buffer](https://www.npmjs.com/package/safe-buffer) module for `Node@<4.5.0`)
2828
- [SlowBuffer class](https://nodejs.org/dist/v6.0.0/docs/api/buffer.html#buffer_class_slowbuffer)
2929
- crypto
3030
- [createCredentials](https://nodejs.org/dist/v0.12.0/docs/api/crypto.html#crypto_crypto_createcredentials_details)

‎lib/util/deprecated-apis.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ module.exports = {
1616
$constructor: {
1717
$deprecated: true,
1818
since: 6,
19-
replacedBy: "'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0')",
19+
replacedBy: "'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0')",
2020
},
2121
$call: {
2222
$deprecated: true,
2323
since: 6,
24-
replacedBy: "'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0')",
24+
replacedBy: "'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0')",
2525
},
2626
},
2727
SlowBuffer: {
@@ -266,13 +266,13 @@ module.exports = {
266266
$deprecated: true,
267267
global: true,
268268
since: 6,
269-
replacedBy: "'Buffer.alloc()' or 'Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0')",
269+
replacedBy: "'Buffer.alloc()' or 'Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0')",
270270
},
271271
$call: {
272272
$deprecated: true,
273273
global: true,
274274
since: 6,
275-
replacedBy: "'Buffer.alloc()' or 'Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0')",
275+
replacedBy: "'Buffer.alloc()' or 'Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0')",
276276
},
277277
},
278278
Intl: {

‎tests/lib/rules/no-deprecated-api.js‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -169,60 +169,60 @@ ruleTester.run("no-deprecated-api", rule, {
169169
{
170170
code: "new (require('buffer').Buffer)()",
171171
env: {node: true},
172-
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0') instead."],
172+
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0') instead."],
173173
},
174174
{
175175
code: "require('buffer').Buffer()",
176176
env: {node: true},
177-
errors: ["'buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0') instead."],
177+
errors: ["'buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0') instead."],
178178
},
179179
{
180180
code: "var b = require('buffer'); new b.Buffer()",
181181
env: {node: true},
182-
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0') instead."],
182+
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0') instead."],
183183
},
184184
{
185185
code: "var b = require('buffer'); new b['Buffer']()",
186186
env: {node: true},
187-
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0') instead."],
187+
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0') instead."],
188188
},
189189
{
190190
code: "var b = require('buffer'); new b[`Buffer`]()",
191191
env: {node: true, es6: true},
192-
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0') instead."],
192+
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0') instead."],
193193
},
194194
{
195195
code: "var b = require('buffer').Buffer; new b()",
196196
env: {node: true},
197-
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0') instead."],
197+
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0') instead."],
198198
},
199199
{
200200
code: "var b; new ((b = require('buffer')).Buffer)(); new b.Buffer()",
201201
env: {node: true},
202202
errors: [
203-
"'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0') instead.",
204-
"'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0') instead.",
203+
"'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0') instead.",
204+
"'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0') instead.",
205205
],
206206
},
207207
{
208208
code: "var {Buffer: b} = require('buffer'); new b()",
209209
env: {node: true, es6: true},
210-
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0') instead."],
210+
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0') instead."],
211211
},
212212
{
213213
code: "var {['Buffer']: b = null} = require('buffer'); new b()",
214214
env: {node: true, es6: true},
215-
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0') instead."],
215+
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0') instead."],
216216
},
217217
{
218218
code: "var {'Buffer': b = null} = require('buffer'); new b()",
219219
env: {node: true, es6: true},
220-
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0') instead."],
220+
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0') instead."],
221221
},
222222
{
223223
code: "var {Buffer: b = require('buffer').Buffer} = {}; new b()",
224224
env: {node: true, es6: true},
225-
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0') instead."],
225+
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0') instead."],
226226
},
227227
{
228228
code: "require('buffer').SlowBuffer",
@@ -451,25 +451,25 @@ ruleTester.run("no-deprecated-api", rule, {
451451
code: "import b from 'buffer'; new b.Buffer()",
452452
env: {es6: true},
453453
parserOptions: {sourceType: "module"},
454-
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0') instead."],
454+
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0') instead."],
455455
},
456456
{
457457
code: "import * as b from 'buffer'; new b.Buffer()",
458458
env: {es6: true},
459459
parserOptions: {sourceType: "module"},
460-
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0') instead."],
460+
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0') instead."],
461461
},
462462
{
463463
code: "import * as b from 'buffer'; new b.default.Buffer()",
464464
env: {es6: true},
465465
parserOptions: {sourceType: "module"},
466-
errors: ["'new buffer.default.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0') instead."],
466+
errors: ["'new buffer.default.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0') instead."],
467467
},
468468
{
469469
code: "import {Buffer as b} from 'buffer'; new b()",
470470
env: {es6: true},
471471
parserOptions: {sourceType: "module"},
472-
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0') instead."],
472+
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0') instead."],
473473
},
474474
{
475475
code: "import b from 'buffer'; b.SlowBuffer",
@@ -509,7 +509,7 @@ ruleTester.run("no-deprecated-api", rule, {
509509
ignoreModuleItems: ["buffer.Buffer()"],
510510
ignoreGlobalItems: ["Buffer()", "new Buffer()"],
511511
}],
512-
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0') instead."],
512+
errors: ["'new buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0') instead."],
513513
},
514514
{
515515
code: "require('buffer').Buffer()",
@@ -518,7 +518,7 @@ ruleTester.run("no-deprecated-api", rule, {
518518
ignoreModuleItems: ["new buffer.Buffer()"],
519519
ignoreGlobalItems: ["Buffer()", "new Buffer()"],
520520
}],
521-
errors: ["'buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0') instead."],
521+
errors: ["'buffer.Buffer()' was deprecated since v6. Use 'buffer.Buffer.alloc()' or 'buffer.Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0') instead."],
522522
},
523523

524524
//----------------------------------------------------------------------
@@ -527,12 +527,12 @@ ruleTester.run("no-deprecated-api", rule, {
527527
{
528528
code: "new Buffer;",
529529
env: {node: true},
530-
errors: ["'new Buffer()' was deprecated since v6. Use 'Buffer.alloc()' or 'Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0') instead."],
530+
errors: ["'new Buffer()' was deprecated since v6. Use 'Buffer.alloc()' or 'Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0') instead."],
531531
},
532532
{
533533
code: "Buffer();",
534534
env: {node: true},
535-
errors: ["'Buffer()' was deprecated since v6. Use 'Buffer.alloc()' or 'Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0') instead."],
535+
errors: ["'Buffer()' was deprecated since v6. Use 'Buffer.alloc()' or 'Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0') instead."],
536536
},
537537
{
538538
code: "Intl.v8BreakIterator;",
@@ -581,7 +581,7 @@ ruleTester.run("no-deprecated-api", rule, {
581581
ignoreModuleItems: ["buffer.Buffer()", "new buffer.Buffer()"],
582582
ignoreGlobalItems: ["Buffer()"],
583583
}],
584-
errors: ["'new Buffer()' was deprecated since v6. Use 'Buffer.alloc()' or 'Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0') instead."],
584+
errors: ["'new Buffer()' was deprecated since v6. Use 'Buffer.alloc()' or 'Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0') instead."],
585585
},
586586
{
587587
code: "Buffer()",
@@ -590,7 +590,7 @@ ruleTester.run("no-deprecated-api", rule, {
590590
ignoreModuleItems: ["buffer.Buffer()", "new buffer.Buffer()"],
591591
ignoreGlobalItems: ["new Buffer()"],
592592
}],
593-
errors: ["'Buffer()' was deprecated since v6. Use 'Buffer.alloc()' or 'Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<6.0.0') instead."],
593+
errors: ["'Buffer()' was deprecated since v6. Use 'Buffer.alloc()' or 'Buffer.from()' (use 'https://www.npmjs.com/package/safe-buffer' for '<4.5.0') instead."],
594594
},
595595
],
596596
})

0 commit comments

Comments
 (0)