tools: add lint rule to keep primordials in ASCII order

PR-URL: #52592 Reviewed-By: Yagiz Nizipli <yagiz.nizipli@sentry.io> Reviewed-By: Jacob Smith <jacob@frende.me> Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
nodejs · Apr 29, 2024 · f9ddd77 · f9ddd77
1 parent eeb80ad
commit f9ddd77
Show file tree

Hide file tree

Showing 96 changed files with 336 additions and 189 deletions.
diff --git a/lib/.eslintrc.yaml b/lib/.eslintrc.yaml
@@ -185,6 +185,7 @@ rules:
     - groups: [['&&', '||']]
 
   # Custom rules in tools/eslint-rules
+  node-core/alphabetize-primordials: error
   node-core/avoid-prototype-pollution: error
   node-core/lowercase-name-for-primitive: error
   node-core/non-ascii-character: error
@@ -266,3 +267,7 @@ globals:
   module: false
   internalBinding: false
   primordials: false
+overrides:
+  - files: [internal/per_context/primordials.js]
+    rules:
+      node-core/alphabetize-primordials: [error, {enforceTopPosition: false}]
diff --git a/lib/_http_common.js b/lib/_http_common.js
@@ -23,8 +23,8 @@
 
 const {
   MathMin,
-  Symbol,
   RegExpPrototypeExec,
+  Symbol,
 } = primordials;
 const { setImmediate } = require('timers');
 

diff --git a/lib/_http_outgoing.js b/lib/_http_outgoing.js
@@ -29,9 +29,9 @@ const {
   NumberPrototypeToString,
   ObjectDefineProperty,
   ObjectKeys,
-  ObjectValues,
   ObjectPrototypeHasOwnProperty,
   ObjectSetPrototypeOf,
+  ObjectValues,
   RegExpPrototypeExec,
   SafeSet,
   StringPrototypeToLowerCase,

diff --git a/lib/_http_server.js b/lib/_http_server.js
@@ -28,8 +28,8 @@ const {
   MathMin,
   ObjectKeys,
   ObjectSetPrototypeOf,
-  RegExpPrototypeExec,
   ReflectApply,
+  RegExpPrototypeExec,
   Symbol,
   SymbolAsyncDispose,
   SymbolFor,

diff --git a/lib/_tls_common.js b/lib/_tls_common.js
@@ -21,14 +21,14 @@
 
 'use strict';
 
-const tls = require('tls');
-
 const {
   ArrayPrototypePush,
   JSONParse,
   RegExpPrototypeSymbolReplace,
 } = primordials;
 
+const tls = require('tls');
+
 const {
   codes: {
     ERR_TLS_INVALID_PROTOCOL_VERSION,

diff --git a/lib/async_hooks.js b/lib/async_hooks.js
@@ -9,10 +9,10 @@ const {
   FunctionPrototypeBind,
   NumberIsSafeInteger,
   ObjectDefineProperties,
+  ObjectFreeze,
   ObjectIs,
   ReflectApply,
   Symbol,
-  ObjectFreeze,
 } = primordials;
 
 const {

diff --git a/lib/buffer.js b/lib/buffer.js
@@ -41,10 +41,10 @@ const {
   StringPrototypeTrim,
   SymbolSpecies,
   SymbolToPrimitive,
+  TypedArrayPrototypeFill,
   TypedArrayPrototypeGetBuffer,
   TypedArrayPrototypeGetByteLength,
   TypedArrayPrototypeGetByteOffset,
-  TypedArrayPrototypeFill,
   TypedArrayPrototypeGetLength,
   TypedArrayPrototypeSet,
   TypedArrayPrototypeSlice,

diff --git a/lib/child_process.js b/lib/child_process.js
@@ -28,11 +28,11 @@ const {
   ArrayPrototypeJoin,
   ArrayPrototypeLastIndexOf,
   ArrayPrototypePush,
+  ArrayPrototypePushApply,
   ArrayPrototypeSlice,
   ArrayPrototypeSort,
   ArrayPrototypeSplice,
   ArrayPrototypeUnshift,
-  ArrayPrototypePushApply,
   NumberIsInteger,
   ObjectAssign,
   ObjectDefineProperty,

diff --git a/lib/crypto.js b/lib/crypto.js
@@ -25,8 +25,8 @@
 'use strict';
 
 const {
-  ObjectDefineProperty,
   ObjectDefineProperties,
+  ObjectDefineProperty,
 } = primordials;
 
 const {

diff --git a/lib/diagnostics_channel.js b/lib/diagnostics_channel.js
@@ -5,15 +5,15 @@ const {
   ArrayPrototypeIndexOf,
   ArrayPrototypePush,
   ArrayPrototypeSplice,
-  SafeFinalizationRegistry,
   ObjectDefineProperty,
   ObjectGetPrototypeOf,
   ObjectSetPrototypeOf,
   Promise,
   PromisePrototypeThen,
-  PromiseResolve,
   PromiseReject,
+  PromiseResolve,
   ReflectApply,
+  SafeFinalizationRegistry,
   SafeMap,
   SymbolHasInstance,
 } = primordials;

diff --git a/lib/events.js b/lib/events.js
@@ -34,8 +34,8 @@ const {
   FunctionPrototypeBind,
   FunctionPrototypeCall,
   NumberMAX_SAFE_INTEGER,
-  ObjectDefineProperty,
   ObjectDefineProperties,
+  ObjectDefineProperty,
   ObjectGetPrototypeOf,
   ObjectSetPrototypeOf,
   Promise,
@@ -46,9 +46,9 @@ const {
   String,
   StringPrototypeSplit,
   Symbol,
-  SymbolFor,
   SymbolAsyncIterator,
   SymbolDispose,
+  SymbolFor,
 } = primordials;
 const kRejection = SymbolFor('nodejs.rejection');
 

diff --git a/lib/internal/async_hooks.js b/lib/internal/async_hooks.js
@@ -3,8 +3,8 @@
 const {
   ArrayPrototypeSlice,
   ErrorCaptureStackTrace,
-  ObjectPrototypeHasOwnProperty,
   ObjectDefineProperty,
+  ObjectPrototypeHasOwnProperty,
   Symbol,
 } = primordials;
 

diff --git a/lib/internal/blob.js b/lib/internal/blob.js
@@ -10,8 +10,8 @@ const {
   PromiseReject,
   RegExpPrototypeExec,
   RegExpPrototypeSymbolReplace,
-  StringPrototypeToLowerCase,
   StringPrototypeSplit,
+  StringPrototypeToLowerCase,
   Symbol,
   SymbolIterator,
   SymbolToStringTag,

diff --git a/lib/internal/bootstrap/node.js b/lib/internal/bootstrap/node.js
@@ -59,9 +59,9 @@ const {
   Number,
   NumberIsNaN,
   ObjectDefineProperty,
+  ObjectFreeze,
   ObjectGetPrototypeOf,
   ObjectSetPrototypeOf,
-  ObjectFreeze,
   SymbolToStringTag,
   globalThis,
 } = primordials;

diff --git a/lib/internal/bootstrap/realm.js b/lib/internal/bootstrap/realm.js
@@ -64,8 +64,8 @@ const {
   SafeMap,
   SafeSet,
   String,
-  StringPrototypeStartsWith,
   StringPrototypeSlice,
+  StringPrototypeStartsWith,
   TypeError,
 } = primordials;
 

diff --git a/lib/internal/bootstrap/switches/is_main_thread.js b/lib/internal/bootstrap/switches/is_main_thread.js
@@ -1,6 +1,9 @@
 'use strict';
 
-const { ObjectDefineProperty } = primordials;
+const {
+  ObjectDefineProperty,
+} = primordials;
+
 const rawMethods = internalBinding('process_methods');
 const {
   namespace: {

diff --git a/lib/internal/bootstrap/switches/is_not_main_thread.js b/lib/internal/bootstrap/switches/is_not_main_thread.js
@@ -1,6 +1,8 @@
 'use strict';
 
-const { ObjectDefineProperty } = primordials;
+const {
+  ObjectDefineProperty,
+} = primordials;
 
 delete process._debugProcess;
 delete process._debugEnd;

diff --git a/lib/internal/bootstrap/web/exposed-window-or-worker.js b/lib/internal/bootstrap/web/exposed-window-or-worker.js
@@ -9,8 +9,8 @@
  */
 
 const {
-  globalThis,
   ObjectDefineProperty,
+  globalThis,
 } = primordials;
 
 const {

diff --git a/lib/internal/child_process/serialization.js b/lib/internal/child_process/serialization.js
@@ -1,10 +1,10 @@
 'use strict';
 
 const {
+  ArrayPrototypePush,
   JSONParse,
   JSONStringify,
   StringPrototypeSplit,
-  ArrayPrototypePush,
   Symbol,
   TypedArrayPrototypeSubarray,
 } = primordials;

diff --git a/lib/internal/cluster/shared_handle.js b/lib/internal/cluster/shared_handle.js
@@ -1,5 +1,9 @@
 'use strict';
-const { SafeMap } = primordials;
+
+const {
+  SafeMap,
+} = primordials;
+
 const assert = require('internal/assert');
 const dgram = require('internal/dgram');
 const net = require('net');

diff --git a/lib/internal/console/constructor.js b/lib/internal/console/constructor.js
@@ -26,8 +26,8 @@ const {
   RegExpPrototypeSymbolReplace,
   SafeArrayIterator,
   SafeMap,
-  SafeWeakMap,
   SafeSet,
+  SafeWeakMap,
   StringPrototypeIncludes,
   StringPrototypePadStart,
   StringPrototypeRepeat,

diff --git a/lib/internal/crypto/aes.js b/lib/internal/crypto/aes.js
@@ -7,6 +7,7 @@ const {
   ArrayPrototypeIncludes,
   ArrayPrototypePush,
   MathFloor,
+  PromiseReject,
   SafeSet,
   TypedArrayPrototypeSlice,
 } = primordials;
@@ -47,8 +48,6 @@ const {
   promisify,
 } = require('internal/util');
 
-const { PromiseReject } = primordials;
-
 const {
   InternalCryptoKey,
   SecretKeyObject,

diff --git a/lib/internal/crypto/keys.js b/lib/internal/crypto/keys.js
@@ -3,8 +3,8 @@
 const {
   ArrayFrom,
   ArrayPrototypeSlice,
-  ObjectDefineProperty,
   ObjectDefineProperties,
+  ObjectDefineProperty,
   ObjectSetPrototypeOf,
   Symbol,
   SymbolToStringTag,

diff --git a/lib/internal/dns/callback_resolver.js b/lib/internal/dns/callback_resolver.js
@@ -1,9 +1,9 @@
 'use strict';
 
 const {
+  ArrayPrototypeMap,
   ObjectDefineProperty,
   ReflectApply,
-  ArrayPrototypeMap,
   Symbol,
 } = primordials;
 

diff --git a/lib/internal/error_serdes.js b/lib/internal/error_serdes.js
@@ -1,6 +1,5 @@
 'use strict';
 
-const Buffer = require('buffer').Buffer;
 const {
   ArrayPrototypeForEach,
   Error,
@@ -19,15 +18,17 @@ const {
   SafeSet,
   StringFromCharCode,
   StringPrototypeSubstring,
+  SymbolFor,
   SymbolToStringTag,
   SyntaxError,
-  SymbolFor,
   TypeError,
   TypedArrayPrototypeGetBuffer,
-  TypedArrayPrototypeGetByteOffset,
   TypedArrayPrototypeGetByteLength,
+  TypedArrayPrototypeGetByteOffset,
   URIError,
 } = primordials;
+
+const { Buffer } = require('buffer');
 const { inspect: { custom: customInspectSymbol } } = require('util');
 
 const kSerializedError = 0;

diff --git a/lib/internal/errors.js b/lib/internal/errors.js
@@ -33,10 +33,10 @@ const {
   Number,
   NumberIsInteger,
   ObjectAssign,
-  ObjectDefineProperty,
   ObjectDefineProperties,
-  ObjectIsExtensible,
+  ObjectDefineProperty,
   ObjectGetOwnPropertyDescriptor,
+  ObjectIsExtensible,
   ObjectKeys,
   ObjectPrototypeHasOwnProperty,
   RangeError,

diff --git a/lib/internal/freeze_intrinsics.js b/lib/internal/freeze_intrinsics.js
@@ -103,6 +103,8 @@ const {
   TypeErrorPrototype,
   TypedArray,
   TypedArrayPrototype,
+  URIError,
+  URIErrorPrototype,
   Uint16Array,
   Uint16ArrayPrototype,
   Uint32Array,
@@ -111,8 +113,6 @@ const {
   Uint8ArrayPrototype,
   Uint8ClampedArray,
   Uint8ClampedArrayPrototype,
-  URIError,
-  URIErrorPrototype,
   WeakMap,
   WeakMapPrototype,
   WeakRef,

diff --git a/lib/internal/fs/glob.js b/lib/internal/fs/glob.js
@@ -1,23 +1,10 @@
 'use strict';
-const { lstatSync, readdirSync } = require('fs');
-const { lstat, readdir } = require('fs/promises');
-const { join, resolve } = require('path');
-
-const {
-  kEmptyObject,
-} = require('internal/util');
-const {
-  validateFunction,
-  validateObject,
-  validateString,
-  validateStringArray,
-} = require('internal/validators');
 
 const {
   ArrayFrom,
   ArrayPrototypeAt,
-  ArrayPrototypeMap,
   ArrayPrototypeFlatMap,
+  ArrayPrototypeMap,
   ArrayPrototypePop,
   ArrayPrototypePush,
   ArrayPrototypeSome,
@@ -27,6 +14,20 @@ const {
   StringPrototypeEndsWith,
 } = primordials;
 
+const { lstatSync, readdirSync } = require('fs');
+const { lstat, readdir } = require('fs/promises');
+const { join, resolve } = require('path');
+
+const {
+  kEmptyObject,
+} = require('internal/util');
+const {
+  validateFunction,
+  validateObject,
+  validateString,
+  validateStringArray,
+} = require('internal/validators');
+
 let minimatch;
 function lazyMinimatch() {
   minimatch ??= require('internal/deps/minimatch/index');