tools: add polyfilled option to prefer-primordials rule

PR-URL: #55318 Backport-PR-URL: #55264 Reviewed-By: Michaël Zasso <[email protected]>

Author: aduh95

lib/.eslintrc.yaml

@@ -243,6 +243,9 @@ rules:
 into: Safe
  - name: String
  - name: Symbol
+polyfilled:
+ - asyncDispose
+ - dispose
  - name: SyntaxError
  - name: TypeError
  - name: Uint16Array

test/parallel/test-eslint-prefer-primordials.js

@@ -176,6 +176,22 @@ new RuleTester({
 options: [{name: 'Symbol'}],
 errors: [{message: /const{SymbolIterator}=primordials/}]
 },
+{
+code: `
+ const{SymbolAsyncDispose } = primordials;
+ const a ={[SymbolAsyncDispose] (){} }
+ `,
+options: [{name: 'Symbol',polyfilled: ['asyncDispose','dispose']}],
+errors: [{message: /const{SymbolAsyncDispose}=require\("internal\/util"\)/}]
+},
+{
+code: `
+ const{SymbolDispose } = primordials;
+ const a ={[SymbolDispose] (){} }
+ `,
+options: [{name: 'Symbol',polyfilled: ['asyncDispose','dispose']}],
+errors: [{message: /const{SymbolDispose}=require\("internal\/util"\)/}]
+},
 {
 code: `
  const{ObjectDefineProperty, Symbol } = primordials;

tools/eslint-rules/prefer-primordials.js

@@ -74,6 +74,7 @@ module.exports ={
 meta: {
 messages: {
 error: 'Use `const{{{name}} } = primordials;` instead of the global.',
+errorPolyfill: 'Use `const{{{name}} } = require("internal/util");` instead of the primordial.',
 },
 schema: {
 type: 'array',
@@ -88,6 +89,10 @@ module.exports ={
 items: {type: 'string'},
 },
 into: {type: 'string'},
+polyfilled: {
+type: 'array',
+items: {type: 'string'},
+},
 },
 additionalProperties: false,
 },
@@ -99,6 +104,7 @@ module.exports ={
 
 constnameMap=newMap();
 constrenameMap=newMap();
+constpolyfilledSet=newSet();
 
 for(constoptionofcontext.options){
 constnames=option.ignore||[];
@@ -109,6 +115,11 @@ module.exports ={
 if(option.into){
 renameMap.set(option.name,option.into);
 }
+if(option.polyfilled){
+for(constpropertyNameofoption.polyfilled){
+polyfilledSet.add(`${option.name}${propertyName[0].toUpperCase()}${propertyName.slice(1)}`);
+}
+}
 }
 
 letreported;
@@ -186,6 +197,17 @@ module.exports ={
 },
 VariableDeclarator(node){
 constname=node.init?.name;
+if(name==='primordials'&&node.id.type==='ObjectPattern'){
+constname=node.id.properties.find(({ key })=>polyfilledSet.has(key.name))?.key.name;
+if(name){
+context.report({
+ node,
+messageId: 'errorPolyfill',
+data: { name },
+});
+return;
+}
+}
 if(name!==undefined&&isTarget(nameMap,name)&&
 node.id.type==='Identifier'&&
 !globalScope.set.get(name)?.defs.length){