Fix ts-node examples and introduce improved typescript eslint rules

.changeset/little-singers-try.md

@@ -0,0 +1,9 @@
+---
+"@colony/colony-js": patch
+"@colony/events": patch
+"@colony/tokens": patch
+"@colony/core": patch
+"@colony/sdk": patch
+---
+
+Introduce `tsx` instead of `ts-node` for esm compatibility reasons. This required some changes to how we import and export types from .ts files, so a lint rule was added for this.

.eslintrc

@@ -1,5 +1,8 @@
 {
     "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "sourceType": "module"
+    },
     "extends": [
         "plugin:@typescript-eslint/recommended",
         "@colony/eslint-config-colony"
@@ -23,6 +26,18 @@
         "@typescript-eslint/no-shadow": [
             "error"
         ],
+        "@typescript-eslint/consistent-type-imports": [
+            "error",
+            {
+                "fixStyle": "inline-type-imports"
+            }
+        ],
+        "@typescript-eslint/consistent-type-exports": [
+            "error",
+            {
+                "fixMixedExportsWithInlineTypeSpecifier": true
+            }
+        ],
         "import/prefer-default-export": "off",
         "import/no-unresolved": "off",
         "import/extensions": [

packages/colony-js/.eslintrc

@@ -1,4 +1,10 @@
 {
+    "parserOptions": {
+        "project": "./tsconfig.json"
+    },
+    "rules": {
+        "@typescript-eslint/no-explicit-any": "off"
+    },
     "overrides": [
         {
             "files": [

packages/colony-js/src/clients/ColonyNetworkClient.ts

@@ -1,4 +1,8 @@
-import { ContractTransaction, BigNumber, Overrides } from 'ethers';
+import {
+  type ContractTransaction,
+  type BigNumber,
+  type Overrides,
+} from 'ethers';
 import {
   type SignerOrProvider,
   ColonyNetworkAddress,
@@ -7,16 +11,16 @@ import {
 } from '@colony/core';
 import {
   getTokenLockingClient,
-  TokenLockingClient,
+  type TokenLockingClient,
   ColonyTokenFactory,
 } from '@colony/tokens';
 
 import {
-  IColonyNetwork,
+  type IColonyNetwork,
   IColonyNetwork__factory as IColonyNetworkFactory,
 } from '../contracts/index.js';
 import { ClientType } from '../constants.js';
-import { AnyColonyClient } from '../clients/Core/exports.js';
+import { type AnyColonyClient } from '../clients/Core/exports.js';
 import { getColonyClient } from './Core/exports.js';
 
 type NetworkEstimate = IColonyNetwork['estimateGas'];

packages/colony-js/src/clients/Core/ColonyClientV10.ts

@@ -1,8 +1,8 @@
 import type { SignerOrProvider } from '@colony/core';
 
 import { IColony__factory as IColonyFactory } from '../../contracts/IColony/10/factories/IColony__factory.js';
-import { ColonyNetworkClient } from '../ColonyNetworkClient.js';
-import { UnknownIColonyClient } from './augments/commonAugments.js';
+import { type ColonyNetworkClient } from '../ColonyNetworkClient.js';
+import { type UnknownIColonyClient } from './augments/commonAugments.js';
 import { addAugments } from './augments/augmentsV7.js';
 import { addAugmentsB as addAddDomainAugments } from './augments/AddDomain.js';
 import { addAugmentsB as addMoveFundsBetweenPotsAugments } from './augments/MoveFundsBetweenPots.js';

packages/colony-js/src/clients/Core/ColonyClientV11.ts

@@ -1,8 +1,8 @@
 import type { SignerOrProvider } from '@colony/core';
 
 import { IColony__factory as IColonyFactory } from '../../contracts/IColony/11/factories/IColony__factory.js';
-import { ColonyNetworkClient } from '../ColonyNetworkClient.js';
-import { UnknownIColonyClient } from './augments/commonAugments.js';
+import { type ColonyNetworkClient } from '../ColonyNetworkClient.js';
+import { type UnknownIColonyClient } from './augments/commonAugments.js';
 import { addAugments } from './augments/augmentsV7.js';
 import { addAugmentsB as addAddDomainAugments } from './augments/AddDomain.js';
 import { addAugmentsB as addMoveFundsBetweenPotsAugments } from './augments/MoveFundsBetweenPots.js';

packages/colony-js/src/clients/Core/ColonyClientV12.ts

@@ -1,29 +1,29 @@
 import type { SignerOrProvider } from '@colony/core';
 
 import { IColony__factory as IColonyFactory } from '../../contracts/IColony/12/factories/IColony__factory.js';
-import { IColony } from '../../contracts/IColony/12/IColony.js';
-import { ColonyNetworkClient } from '../ColonyNetworkClient.js';
+import { type IColony } from '../../contracts/IColony/12/IColony.js';
+import { type ColonyNetworkClient } from '../ColonyNetworkClient.js';
 import {
-  AugmentedIColony,
-  AugmentedEstimate,
+  type AugmentedIColony,
+  type AugmentedEstimate,
 } from './augments/commonAugments.js';
-import { ColonyAugmentsV3 } from './augments/augmentsV3.js';
-import { ColonyAugmentsV4 } from './augments/augmentsV4.js';
-import { ColonyAugmentsV5 } from './augments/augmentsV5.js';
-import { ColonyAugmentsV6 } from './augments/augmentsV6.js';
+import { type ColonyAugmentsV3 } from './augments/augmentsV3.js';
+import { type ColonyAugmentsV4 } from './augments/augmentsV4.js';
+import { type ColonyAugmentsV5 } from './augments/augmentsV5.js';
+import { type ColonyAugmentsV6 } from './augments/augmentsV6.js';
 import {
   addAugments,
-  ColonyAugmentsV7,
-  AugmentedEstimateV7,
+  type ColonyAugmentsV7,
+  type AugmentedEstimateV7,
 } from './augments/augmentsV7.js';
 import {
-  AddDomainAugmentsB,
-  AddDomainEstimateGasB,
+  type AddDomainAugmentsB,
+  type AddDomainEstimateGasB,
   addAugmentsB as addAddDomainAugments,
 } from './augments/AddDomain.js';
 import {
-  MoveFundsBetweenPotsAugmentsB,
-  MoveFundsBetweenPotsEstimateGasB,
+  type MoveFundsBetweenPotsAugmentsB,
+  type MoveFundsBetweenPotsEstimateGasB,
   addAugmentsB as addMoveFundsBetweenPotsAugments,
 } from './augments/MoveFundsBetweenPots.js';
 

packages/colony-js/src/clients/Core/ColonyClientV13.ts

@@ -1,29 +1,29 @@
-import { SignerOrProvider } from '@colony/core';
+import { type SignerOrProvider } from '@colony/core';
 
 import { IColony__factory as IColonyFactory } from '../../contracts/IColony/13/factories/IColony__factory.js';
-import { IColony } from '../../contracts/IColony/13/IColony.js';
-import { ColonyNetworkClient } from '../ColonyNetworkClient.js';
+import { type IColony } from '../../contracts/IColony/13/IColony.js';
+import { type ColonyNetworkClient } from '../ColonyNetworkClient.js';
 import {
-  AugmentedIColony,
-  AugmentedEstimate,
+  type AugmentedIColony,
+  type AugmentedEstimate,
 } from './augments/commonAugments.js';
-import { ColonyAugmentsV3 } from './augments/augmentsV3.js';
-import { ColonyAugmentsV4 } from './augments/augmentsV4.js';
-import { ColonyAugmentsV5 } from './augments/augmentsV5.js';
-import { ColonyAugmentsV6 } from './augments/augmentsV6.js';
+import { type ColonyAugmentsV3 } from './augments/augmentsV3.js';
+import { type ColonyAugmentsV4 } from './augments/augmentsV4.js';
+import { type ColonyAugmentsV5 } from './augments/augmentsV5.js';
+import { type ColonyAugmentsV6 } from './augments/augmentsV6.js';
 import {
   addAugments,
-  ColonyAugmentsV7,
-  AugmentedEstimateV7,
+  type ColonyAugmentsV7,
+  type AugmentedEstimateV7,
 } from './augments/augmentsV7.js';
 import {
-  AddDomainAugmentsB,
-  AddDomainEstimateGasB,
+  type AddDomainAugmentsB,
+  type AddDomainEstimateGasB,
   addAugmentsB as addAddDomainAugments,
 } from './augments/AddDomain.js';
 import {
-  MoveFundsBetweenPotsAugmentsB,
-  MoveFundsBetweenPotsEstimateGasB,
+  type MoveFundsBetweenPotsAugmentsB,
+  type MoveFundsBetweenPotsEstimateGasB,
   addAugmentsB as addMoveFundsBetweenPotsAugments,
 } from './augments/MoveFundsBetweenPots.js';
 

packages/colony-js/src/clients/Core/ColonyClientV14.ts

@@ -1,29 +1,29 @@
-import { SignerOrProvider } from '@colony/core';
+import { type SignerOrProvider } from '@colony/core';
 
 import { IColony__factory as IColonyFactory } from '../../contracts/IColony/14/factories/IColony__factory.js';
-import { IColony } from '../../contracts/IColony/14/IColony.js';
-import { ColonyNetworkClient } from '../ColonyNetworkClient.js';
+import { type IColony } from '../../contracts/IColony/14/IColony.js';
+import { type ColonyNetworkClient } from '../ColonyNetworkClient.js';
 import {
-  AugmentedIColony,
-  AugmentedEstimate,
+  type AugmentedIColony,
+  type AugmentedEstimate,
 } from './augments/commonAugments.js';
-import { ColonyAugmentsV3 } from './augments/augmentsV3.js';
-import { ColonyAugmentsV4 } from './augments/augmentsV4.js';
-import { ColonyAugmentsV5 } from './augments/augmentsV5.js';
-import { ColonyAugmentsV6 } from './augments/augmentsV6.js';
+import { type ColonyAugmentsV3 } from './augments/augmentsV3.js';
+import { type ColonyAugmentsV4 } from './augments/augmentsV4.js';
+import { type ColonyAugmentsV5 } from './augments/augmentsV5.js';
+import { type ColonyAugmentsV6 } from './augments/augmentsV6.js';
 import {
   addAugments,
-  ColonyAugmentsV7,
-  AugmentedEstimateV7,
+  type ColonyAugmentsV7,
+  type AugmentedEstimateV7,
 } from './augments/augmentsV7.js';
 import {
-  AddDomainAugmentsB,
-  AddDomainEstimateGasB,
+  type AddDomainAugmentsB,
+  type AddDomainEstimateGasB,
   addAugmentsB as addAddDomainAugments,
 } from './augments/AddDomain.js';
 import {
-  MoveFundsBetweenPotsAugmentsB,
-  MoveFundsBetweenPotsEstimateGasB,
+  type MoveFundsBetweenPotsAugmentsB,
+  type MoveFundsBetweenPotsEstimateGasB,
   addAugmentsB as addMoveFundsBetweenPotsAugments,
 } from './augments/MoveFundsBetweenPots.js';
 

packages/colony-js/src/clients/Core/ColonyClientV15.ts

@@ -1,29 +1,29 @@
-import { SignerOrProvider } from '@colony/core';
+import { type SignerOrProvider } from '@colony/core';
 
 import { IColony__factory as IColonyFactory } from '../../contracts/IColony/15/factories/IColony__factory.js';
-import { IColony } from '../../contracts/IColony/15/IColony.js';
-import { ColonyNetworkClient } from '../ColonyNetworkClient.js';
+import { type IColony } from '../../contracts/IColony/15/IColony.js';
+import { type ColonyNetworkClient } from '../ColonyNetworkClient.js';
 import {
-  AugmentedIColony,
-  AugmentedEstimate,
+  type AugmentedIColony,
+  type AugmentedEstimate,
 } from './augments/commonAugments.js';
-import { ColonyAugmentsV3 } from './augments/augmentsV3.js';
-import { ColonyAugmentsV4 } from './augments/augmentsV4.js';
-import { ColonyAugmentsV5 } from './augments/augmentsV5.js';
-import { ColonyAugmentsV6 } from './augments/augmentsV6.js';
+import { type ColonyAugmentsV3 } from './augments/augmentsV3.js';
+import { type ColonyAugmentsV4 } from './augments/augmentsV4.js';
+import { type ColonyAugmentsV5 } from './augments/augmentsV5.js';
+import { type ColonyAugmentsV6 } from './augments/augmentsV6.js';
 import {
   addAugments,
-  ColonyAugmentsV7,
-  AugmentedEstimateV7,
+  type ColonyAugmentsV7,
+  type AugmentedEstimateV7,
 } from './augments/augmentsV7.js';
 import {
-  AddDomainAugmentsB,
-  AddDomainEstimateGasB,
+  type AddDomainAugmentsB,
+  type AddDomainEstimateGasB,
   addAugmentsB as addAddDomainAugments,
 } from './augments/AddDomain.js';
 import {
-  MoveFundsBetweenPotsAugmentsB,
-  MoveFundsBetweenPotsEstimateGasB,
+  type MoveFundsBetweenPotsAugmentsB,
+  type MoveFundsBetweenPotsEstimateGasB,
   addAugmentsB as addMoveFundsBetweenPotsAugments,
 } from './augments/MoveFundsBetweenPots.js';
 

packages/colony-js/src/clients/Core/ColonyClientV16.ts

@@ -1,29 +1,29 @@
-import { SignerOrProvider } from '@colony/core';
+import { type SignerOrProvider } from '@colony/core';
 
 import { IColony__factory as IColonyFactory } from '../../contracts/IColony/16/factories/IColony__factory.js';
-import { IColony } from '../../contracts/IColony/16/IColony.js';
-import { ColonyNetworkClient } from '../ColonyNetworkClient.js';
+import { type IColony } from '../../contracts/IColony/16/IColony.js';
+import { type ColonyNetworkClient } from '../ColonyNetworkClient.js';
 import {
-  AugmentedIColony,
-  AugmentedEstimate,
+  type AugmentedIColony,
+  type AugmentedEstimate,
 } from './augments/commonAugments.js';
-import { ColonyAugmentsV3 } from './augments/augmentsV3.js';
-import { ColonyAugmentsV4 } from './augments/augmentsV4.js';
-import { ColonyAugmentsV5 } from './augments/augmentsV5.js';
-import { ColonyAugmentsV6 } from './augments/augmentsV6.js';
+import { type ColonyAugmentsV3 } from './augments/augmentsV3.js';
+import { type ColonyAugmentsV4 } from './augments/augmentsV4.js';
+import { type ColonyAugmentsV5 } from './augments/augmentsV5.js';
+import { type ColonyAugmentsV6 } from './augments/augmentsV6.js';
 import {
   addAugments,
-  ColonyAugmentsV7,
-  AugmentedEstimateV7,
+  type ColonyAugmentsV7,
+  type AugmentedEstimateV7,
 } from './augments/augmentsV7.js';
 import {
-  AddDomainAugmentsB,
-  AddDomainEstimateGasB,
+  type AddDomainAugmentsB,
+  type AddDomainEstimateGasB,
   addAugmentsB as addAddDomainAugments,
 } from './augments/AddDomain.js';
 import {
-  MoveFundsBetweenPotsAugmentsB,
-  MoveFundsBetweenPotsEstimateGasB,
+  type MoveFundsBetweenPotsAugmentsB,
+  type MoveFundsBetweenPotsEstimateGasB,
   addAugmentsB as addMoveFundsBetweenPotsAugments,
 } from './augments/MoveFundsBetweenPots.js';
 

packages/colony-js/src/clients/Core/ColonyClientV8.ts

@@ -1,8 +1,8 @@
 import type { SignerOrProvider } from '@colony/core';
 
 import { IColony__factory as IColonyFactory } from '../../contracts/IColony/8/factories/IColony__factory.js';
-import { ColonyNetworkClient } from '../ColonyNetworkClient.js';
-import { UnknownIColonyClient } from './augments/commonAugments.js';
+import { type ColonyNetworkClient } from '../ColonyNetworkClient.js';
+import { type UnknownIColonyClient } from './augments/commonAugments.js';
 import { addAugments } from './augments/augmentsV5.js';
 import { addAugmentsB as addAddDomainAugments } from './augments/AddDomain.js';
 import { addAugmentsB as addMoveFundsBetweenPotsAugments } from './augments/MoveFundsBetweenPots.js';

packages/colony-js/src/clients/Core/ColonyVersionClient.ts

@@ -1,5 +1,5 @@
 // A minimal version of the ColonyClient contract that only supports the `version` method
-import { BigNumber, Contract } from 'ethers';
+import { type BigNumber, Contract } from 'ethers';
 import type { SignerOrProvider } from '@colony/core';
 
 interface ColonyVersionClient extends Contract {

packages/colony-js/src/clients/Core/augments/AddDomain.ts

@@ -1,17 +1,21 @@
-import { BigNumber, BigNumberish, ContractTransaction } from 'ethers';
+import {
+  type BigNumber,
+  type BigNumberish,
+  type ContractTransaction,
+} from 'ethers';
 import {
   type TxOverrides,
   ColonyRole,
   getPermissionProofs,
 } from '@colony/core';
 
 import {
-  IColonyV4,
-  IColonyV12,
-  IColonyV13,
-  IColonyV14,
-  IColonyV15,
-  IColonyV16,
+  type IColonyV4,
+  type IColonyV12,
+  type IColonyV13,
+  type IColonyV14,
+  type IColonyV15,
+  type IColonyV16,
 } from '../contracts.js';
 import type {
   AugmentedIColony,