Lint: enforce an order for imports

.prettierignore

@@ -10,4 +10,7 @@ src/mina/
 # These files are generated by proof-systems
 # no need to run prettier on it
 src/bindings/crypto/test-vectors/poseidon-kimchi.ts
-src/bindings/crypto/test-vectors/poseidon-legacy.ts
+src/bindings/crypto/test-vectors/poseidon-legacy.ts
+# Files with parser issues
+# See https://github.com/trivago/prettier-plugin-sort-imports/issues/287
+src/lib/mina/v1/zkapp.ts

.prettierrc.cjs

@@ -13,4 +13,14 @@ module.exports = {
       },
     },
   ],
+  plugins: ['@trivago/prettier-plugin-sort-imports'],
+  importOrder: [
+    '<THIRD_PARTY_MODULES>', // External libraries
+    '^@/.*', // Absolute aliases (e.g., `@/components`)
+    '^\\.\\./.*', // Relative parent imports
+    '^\\./.*', // Relative sibling imports
+  ],
+  importOrderSeparation: true,
+  importOrderSortSpecifiers: true,
+  importOrderParserPlugins: ['typescript', 'decorators-legacy'],
 };

npmDepsHash

@@ -1 +1 @@
-sha256-Mw7ibGb8ljvls5AqkPPgvMRcz5LWvuWz2KZv2Sdby3I=
+sha256-r0ZjpxOUTTADFnNWhA6sGeibP8rbsJavze+5qf+rWBA=

package.json

@@ -87,6 +87,7 @@
     "@noble/curves": "1.8.1",
     "@noble/hashes": "^1.3.2",
     "@playwright/test": "^1.48.0",
+    "@trivago/prettier-plugin-sort-imports": "^5.2.2",
     "@types/jest": "^27.0.0",
     "@types/libsodium-wrappers-sumo": "^0.7.8",
     "@types/node": "^18.14.2",

run-in-browser.js

@@ -1,8 +1,9 @@
 #!/usr/bin/env node
+import minimist from 'minimist';
 import fs from 'node:fs/promises';
-import path from 'node:path';
 import http from 'node:http';
-import minimist from 'minimist';
+import path from 'node:path';
+
 import { build } from './src/build/build-example.js';
 
 let {

src/bindings.web.js

@@ -1,5 +1,5 @@
 import './bindings/crypto/bindings.js';
-import { initializeBindings as init, withThreadPool, wasm } from './bindings/js/web/web-backend.js';
+import { initializeBindings as init, wasm, withThreadPool } from './bindings/js/web/web-backend.js';
 
 let Snarky, Ledger, Pickles, Test_;
 let isInitialized = false;

src/bindings/crypto/benchmarks/inverse.ts

@@ -1,5 +1,5 @@
-import { Fp, p, inverse } from '../finite-field.js';
 import { tic, toc } from '../../../lib/util/tic-toc.js';
+import { Fp, inverse, p } from '../finite-field.js';
 
 const N = 10000;
 

src/bindings/crypto/bigint.unit-test.ts

@@ -1,13 +1,15 @@
 import { expect } from 'expect';
+
+import { Random, test } from '../../lib/testing/property.js';
+
 import {
-  bytesToBigInt,
   bigIntToBytes,
   bigintToBytes32,
+  bytesToBigInt,
   bytesToBigint32,
   parseHexString32,
 } from './bigint-helpers.js';
 import { Fp } from './finite-field.js';
-import { Random, test } from '../../lib/testing/property.js';
 
 function testBigintRoundtrip(x: bigint, size: number) {
   let bytes = bigIntToBytes(x, size);

src/bindings/crypto/bindings.ts

@@ -3,19 +3,20 @@
  * It is exposed to JSOO by populating a global variable with an object.
  * It gets imported as the first thing in ../../bindings.js so that the global variable is ready by the time JSOO code gets executed.
  */
+import type * as wasmNamespace from '../compiled/node_bindings/plonk_wasm.cjs';
 import { prefixHashes, prefixHashesLegacy } from '../crypto/constants.js';
+
 import { Bigint256Bindings } from './bindings/bigint256.js';
-import { PallasBindings, VestaBindings } from './bindings/curve.js';
-import { FpBindings, FqBindings } from './bindings/field.js';
-import { FpVectorBindings, FqVectorBindings } from './bindings/vector.js';
-import type * as wasmNamespace from '../compiled/node_bindings/plonk_wasm.cjs';
 import { fieldsFromRustFlat, fieldsToRustFlat } from './bindings/conversion-base.js';
-import { proofConversion } from './bindings/conversion-proof.js';
 import { conversionCore } from './bindings/conversion-core.js';
-import { verifierIndexConversion } from './bindings/conversion-verifier-index.js';
 import { oraclesConversion } from './bindings/conversion-oracles.js';
+import { proofConversion } from './bindings/conversion-proof.js';
+import { verifierIndexConversion } from './bindings/conversion-verifier-index.js';
+import { PallasBindings, VestaBindings } from './bindings/curve.js';
 import { jsEnvironment } from './bindings/env.js';
+import { FpBindings, FqBindings } from './bindings/field.js';
 import { srs } from './bindings/srs.js';
+import { FpVectorBindings, FqVectorBindings } from './bindings/vector.js';
 
 export { getRustConversion, RustConversion, Wasm };