refactor: simplify test exec packages/cashscript

hereje · hereje · commit 857ac9665e05 · 2025-09-02T17:49:50.000Z
- remove tests scripts from package.json
- delete tsconfig.test.json config file no longer needed
- add vitest api as global so that import is no required such as
describe, expect, it, etc.
diff --git a/packages/cashscript/package.json b/packages/cashscript/package.json
@@ -33,15 +33,11 @@
   },
   "scripts": {
     "build": "yarn clean && yarn compile",
-    "build:test": "yarn clean:test && yarn compile:test",
     "clean": "rm -rf ./dist",
-    "clean:test": "rm -rf ./dist-test",
     "compile": "tsc -p tsconfig.build.json",
-    "compile:test": "tsc -p tsconfig.test.json",
     "lint": "eslint . --ext .ts --ignore-path ../../.eslintignore",
     "prepare": "yarn build",
     "prepublishOnly": "yarn test && yarn lint",
-    "pretest": "yarn build:test",
     "test": "vitest run"
   },
   "dependencies": {
diff --git a/packages/cashscript/src/test/VitestExtensions.ts b/packages/cashscript/src/test/VitestExtensions.ts
@@ -1,5 +1,4 @@
 import { DebugResults } from '../debugging.js';
-import { vi, expect } from 'vitest';
 
 interface Debuggable {
   debug(): DebugResults | Promise<DebugResults>;
diff --git a/packages/cashscript/test/Contract.test.ts b/packages/cashscript/test/Contract.test.ts
@@ -17,7 +17,7 @@ import hodlVaultArtifact from './fixture/hodl_vault.artifact.js';
 import mecenasArtifact from './fixture/mecenas.artifact.js';
 import deprecatedMecenasArtifact from './fixture/deprecated/mecenas-v0.6.0.json' with { type: 'json' };
 import boundedBytesArtifact from './fixture/bounded_bytes.artifact.js';
-import { describe, expect, it, beforeEach } from 'vitest';
+
 
 describe('Contract', () => {
   describe('new', () => {
diff --git a/packages/cashscript/test/TransactionBuilder.test.ts b/packages/cashscript/test/TransactionBuilder.test.ts
@@ -19,7 +19,7 @@ import twtArtifact from './fixture/transfer_with_timeout.artifact.js';
 import { TransactionBuilder } from '../src/TransactionBuilder.js';
 import { gatherUtxos, getTxOutputs } from './test-util.js';
 import { generateWcTransactionObjectFixture } from './fixture/walletconnect/fixtures.js';
-import { describe, expect, it, beforeAll } from 'vitest';
+
 
 describe('Transaction Builder', () => {
   const provider = process.env.TESTS_USE_CHIPNET
diff --git a/packages/cashscript/test/debugging-old-artifacts.test.ts b/packages/cashscript/test/debugging-old-artifacts.test.ts
@@ -1,6 +1,5 @@
 import { Contract, MockNetworkProvider, randomUtxo, SignatureTemplate, TransactionBuilder } from '../src/index.js';
 import { alicePkh, alicePriv, alicePub, bobPriv } from './fixture/vars.js';
-import { describe, expect, it } from 'vitest';
 
 const artifact = {
   contractName: 'P2PKH',
diff --git a/packages/cashscript/test/debugging.test.ts b/packages/cashscript/test/debugging.test.ts
@@ -13,7 +13,6 @@ import {
   artifactTestZeroHandling,
 } from './fixture/debugging/debugging_contracts.js';
 import { sha256 } from '@cashscript/utils';
-import { describe, it, expect } from 'vitest';
 
 describe('Debugging tests', () => {
   describe('console.log statements', () => {
diff --git a/packages/cashscript/test/e2e/Announcement.test.ts b/packages/cashscript/test/e2e/Announcement.test.ts
@@ -4,7 +4,7 @@ import { FailedRequireError } from '../../src/Errors.js';
 import { createOpReturnOutput, randomUtxo } from '../../src/utils.js';
 import { aliceAddress } from '../fixture/vars.js';
 import artifact from '../fixture/announcement.artifact.js';
-import { describe, expect, it, beforeAll } from 'vitest';
+
 
 describe('Announcement', () => {
   const provider = process.env.TESTS_USE_CHIPNET
diff --git a/packages/cashscript/test/e2e/BigInt.test.ts b/packages/cashscript/test/e2e/BigInt.test.ts
@@ -9,7 +9,7 @@ import {
 import artifact from '../fixture/bigint.artifact.js';
 import { randomUtxo } from '../../src/utils.js';
 import { gatherUtxos } from '../test-util.js';
-import { describe, expect, it, beforeAll } from 'vitest';
+
 
 describe('BigInt', () => {
   const provider = process.env.TESTS_USE_CHIPNET
diff --git a/packages/cashscript/test/e2e/HodlVault.test.ts b/packages/cashscript/test/e2e/HodlVault.test.ts
@@ -16,7 +16,7 @@ import { gatherUtxos, getTxOutputs } from '../test-util.js';
 import { FailedRequireError } from '../../src/Errors.js';
 import artifact from '../fixture/hodl_vault.artifact.js';
 import { randomUtxo } from '../../src/utils.js';
-import { describe, expect, it, beforeAll } from 'vitest';
+
 
 describe('HodlVault', () => {
   const provider = process.env.TESTS_USE_CHIPNET
diff --git a/packages/cashscript/test/e2e/Mecenas.test.ts b/packages/cashscript/test/e2e/Mecenas.test.ts
@@ -9,7 +9,7 @@ import { getLargestUtxo, getTxOutputs } from '../test-util.js';
 import { FailedRequireError } from '../../src/Errors.js';
 import artifact from '../fixture/mecenas.artifact.js';
 import { randomUtxo } from '../../src/utils.js';
-import { describe, expect, it, beforeAll } from 'vitest';
+
 
 // Mecenas has this.age check omitted for testing
 describe('Mecenas', () => {
diff --git a/packages/cashscript/test/e2e/MultiContract.test.ts b/packages/cashscript/test/e2e/MultiContract.test.ts
@@ -24,7 +24,7 @@ import p2pkhArtifact from '../fixture/p2pkh.artifact.js';
 import twtArtifact from '../fixture/transfer_with_timeout.artifact.js';
 import { getTxOutputs } from '../test-util.js';
 import SiblingIntrospectionArtifact from '../fixture/SiblingIntrospection.artifact.js';
-import { describe, expect, it, beforeAll } from 'vitest';
+
 
 describe('Multi Contract', () => {
   const provider = process.env.TESTS_USE_CHIPNET
diff --git a/packages/cashscript/test/e2e/P2PKH-tokens.test.ts b/packages/cashscript/test/e2e/P2PKH-tokens.test.ts
@@ -10,7 +10,7 @@ import {
 import { getTxOutputs } from '../test-util.js';
 import { Network, TokenDetails, Utxo } from '../../src/interfaces.js';
 import artifact from '../fixture/p2pkh.artifact.js';
-import { describe, expect, it, beforeAll } from 'vitest';
+
 
 describe('P2PKH-tokens', () => {
   let p2pkhInstance: Contract<typeof artifact>;
diff --git a/packages/cashscript/test/e2e/P2PKH.test.ts b/packages/cashscript/test/e2e/P2PKH.test.ts
@@ -19,7 +19,7 @@ import {
   createOpReturnOutput, randomUtxo,
 } from '../../src/utils.js';
 import artifact from '../fixture/p2pkh.artifact.js';
-import { describe, expect, it, beforeAll } from 'vitest';
+
 
 describe('P2PKH-no-tokens', () => {
   const provider = process.env.TESTS_USE_CHIPNET
diff --git a/packages/cashscript/test/e2e/TokenCategoryCheck.test.ts b/packages/cashscript/test/e2e/TokenCategoryCheck.test.ts
@@ -5,7 +5,7 @@ import {
 } from '../../src/index.js';
 import { Network } from '../../src/interfaces.js';
 import artifact from '../fixture/token_category_comparison.artifact.js';
-import { describe, expect, it, beforeAll } from 'vitest';
+
 
 describe('TokenCategoryCheck', () => {
   const provider = process.env.TESTS_USE_CHIPNET
diff --git a/packages/cashscript/test/e2e/TransferWithTimeout.test.ts b/packages/cashscript/test/e2e/TransferWithTimeout.test.ts
@@ -13,7 +13,7 @@ import {
 import { gatherUtxos, getTxOutputs } from '../test-util.js';
 import twtArtifact from '../fixture/transfer_with_timeout.artifact.js';
 import { randomUtxo } from '../../src/utils.js';
-import { describe, expect, it, beforeAll } from 'vitest';
+
 
 describe('TransferWithTimeout', () => {
   const provider = process.env.TESTS_USE_CHIPNET
diff --git a/packages/cashscript/test/e2e/misc/timelocks.test.ts b/packages/cashscript/test/e2e/misc/timelocks.test.ts
@@ -13,8 +13,6 @@ import p2pkhArtifact from '../../fixture/p2pkh.artifact.js';
 import twtArtifact from '../../fixture/transfer_with_timeout.artifact.js';
 import { TransactionBuilder } from '../../../src/TransactionBuilder.js';
 import { getTxOutputs } from '../../test-util.js';
-import { describe, expect, it, beforeAll } from 'vitest';
-
 
 describe('Timelocks', () => {
   const provider = process.env.TESTS_USE_CHIPNET
diff --git a/packages/cashscript/test/e2e/network/ElectrumNetworkProvider.test.ts b/packages/cashscript/test/e2e/network/ElectrumNetworkProvider.test.ts
@@ -1,6 +1,5 @@
 import { ElectrumNetworkProvider, Network } from '../../../src/index.js';
 import { ElectrumClient } from '@electrum-cash/network';
-import { describe, expect, it } from 'vitest';
 
 describe.runIf(Boolean(process.env.TESTS_USE_CHIPNET))('ElectrumNetworkProvider', () => {
   // TODO: Test more of the API
diff --git a/packages/cashscript/test/e2e/network/FullStackNetworkProvider.test.ts b/packages/cashscript/test/e2e/network/FullStackNetworkProvider.test.ts
@@ -9,7 +9,6 @@ import {
 import { gatherUtxos, getTxOutputs } from '../../test-util.js';
 import { FailedRequireError } from '../../../src/Errors.js';
 import artifact from '../../fixture/p2pkh.artifact.js';
-import { describe, expect, it } from 'vitest';
 
 describe.runIf(Boolean(process.env.TESTS_USE_CHIPNET))('FullStackNetworkProvider', () => {
   const provider = new FullStackNetworkProvider('mainnet', new BCHJS({ restURL: 'https://api.fullstack.cash/v5/' }));
diff --git a/packages/cashscript/test/e2e/network/MockNetworkProvider.test.ts b/packages/cashscript/test/e2e/network/MockNetworkProvider.test.ts
@@ -10,7 +10,6 @@ import {
   alicePub,
   bobAddress,
 } from '../../fixture/vars.js';
-import { describe, expect, it, beforeAll, beforeEach } from 'vitest';
 
 describe.runIf(!process.env.TESTS_USE_CHIPNET)('MockNetworkProvider', () => {
   describe('when updateUtxoSet is true', () => {
diff --git a/packages/cashscript/test/fixture/libauth-template/fixtures.ts b/packages/cashscript/test/fixture/libauth-template/fixtures.ts
@@ -5,7 +5,6 @@ import P2PKH from '../p2pkh.artifact.js';
 import HoldVault from '../hodl_vault.artifact.js';
 import { aliceAddress, alicePkh, alicePriv, alicePub, bobPkh, bobPriv, bobPub, oracle, oraclePub } from '../vars.js';
 import { WalletTemplate, hexToBin } from '@bitauth/libauth';
-import { expect } from 'vitest';
 
 const provider = new MockNetworkProvider();
 
diff --git a/packages/cashscript/test/fixture/libauth-template/multi-contract-fixtures.ts b/packages/cashscript/test/fixture/libauth-template/multi-contract-fixtures.ts
@@ -5,7 +5,6 @@ import twtArtifact from '../transfer_with_timeout.artifact.js';
 import hodlVaultArtifact from '../hodl_vault.artifact.js';
 import { aliceAddress, alicePkh, alicePriv, alicePub, aliceTokenAddress, bobPkh, bobPriv, bobPub, carolPriv, carolPub, oracle, oraclePub } from '../vars.js';
 import { WalletTemplate } from '@bitauth/libauth';
-import { expect } from 'vitest';
 
 const provider = new MockNetworkProvider();
 
diff --git a/packages/cashscript/test/fixture/libauth-template/old-fixtures.ts b/packages/cashscript/test/fixture/libauth-template/old-fixtures.ts
@@ -5,7 +5,6 @@ import P2PKH from '../p2pkh.artifact.js';
 import HoldVault from '../hodl_vault.artifact.js';
 import { aliceAddress, alicePkh, alicePriv, alicePub, bobPkh, bobPriv, bobPub, oracle, oraclePub } from '../vars.js';
 import { WalletTemplate, hexToBin } from '@bitauth/libauth';
-import { expect } from 'vitest';
 
 const provider = new MockNetworkProvider();
 
diff --git a/packages/cashscript/test/fixture/walletconnect/fixtures.ts b/packages/cashscript/test/fixture/walletconnect/fixtures.ts
@@ -1,4 +1,3 @@
-import { expect } from 'vitest';
 
 export const generateWcTransactionObjectFixture = {
   'broadcast': true,
diff --git a/packages/cashscript/test/libauth-template/LibauthTemplate.test.ts b/packages/cashscript/test/libauth-template/LibauthTemplate.test.ts
@@ -1,6 +1,5 @@
 import { fixtures } from '../fixture/libauth-template/fixtures.js';
 import { fixtures as oldFixtures } from '../fixture/libauth-template/old-fixtures.js';
-import { describe, expect, it } from 'vitest';
 
 describe('Libauth Template generation tests (single-contract)', () => {
   it.each(fixtures)('should generate a valid libauth template for $name', (fixture) => {
diff --git a/packages/cashscript/test/libauth-template/LibauthTemplateMultiContract.test.ts b/packages/cashscript/test/libauth-template/LibauthTemplateMultiContract.test.ts
@@ -1,5 +1,4 @@
 import { fixtures } from '../fixture/libauth-template/multi-contract-fixtures.js';
-import { describe, expect, it } from 'vitest';
 
 describe('Libauth Template generation tests (multi-contract)', () => {
   it.each(fixtures)('should generate a valid libauth template for $name', async (fixture) => {
diff --git a/packages/cashscript/test/multi-contract-debugging.test.ts b/packages/cashscript/test/multi-contract-debugging.test.ts
@@ -19,7 +19,6 @@ import bigintArtifact from './fixture/bigint.artifact.js';
 import { ARTIFACT_FUNCTION_NAME_COLLISION, ARTIFACT_NAME_COLLISION, ARTIFACT_CONTRACT_NAME_COLLISION, ARTIFACT_SAME_NAME_DIFFERENT_PATH } from './fixture/debugging/multi_contract_debugging_contracts.js';
 import { addressToLockScript } from '../src/utils.js';
 import SiblingIntrospectionArtifact from './fixture/SiblingIntrospection.artifact.js';
-import { describe, expect, it } from 'vitest';
 
 const bobSignatureTemplate = new SignatureTemplate(bobPriv);
 
diff --git a/packages/cashscript/test/util.test.ts b/packages/cashscript/test/util.test.ts
@@ -12,7 +12,6 @@ import {
 } from '../src/utils.js';
 import { Network } from '../src/interfaces.js';
 import { alicePkh, alicePub } from './fixture/vars.js';
-import { describe, expect, it } from 'vitest';
 
 describe('utils', () => {
   describe('getInputSize', () => {
diff --git a/packages/cashscript/tsconfig.build.json b/packages/cashscript/tsconfig.build.json
@@ -1,15 +1,12 @@
 {
   "extends": "../../tsconfig.build.json",
-
   "compilerOptions": {
     "outDir": "./dist",
+    "types": ["vitest/globals"]
   },
-
   "include": [
     "src/**/*",
+    "vitest.d.ts",
   ],
-
-  "exclude": [
-    "test/fixture"
-  ],
-}
+  "exclude": ["test/fixture"],
+}
diff --git a/packages/cashscript/tsconfig.test.json b/packages/cashscript/tsconfig.test.json
diff --git a/packages/cashscript/vitest.config.ts b/packages/cashscript/vitest.config.ts
@@ -1,13 +1,14 @@
 import { defineConfig } from 'vitest/config';
 
 export default defineConfig({
-  root: './dist-test',
+  root: './test',
   test: {
     environment: 'node',
     include: ['**/*.{test,spec}.?(c|m)[jt]s?(x)'],
     setupFiles: ['./vitest.setup.ts'],
     exclude: ['**/types/**'],
     testTimeout: 50000,
+    globals: true,
     reporters: ['verbose'],
     coverage: {
       provider: 'v8',

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`import { DebugResults } from '../debugging.js';`
`2`		`-import { vi, expect } from 'vitest';`
`3`	`2`
`4`	`3`	`interface Debuggable {`
`5`	`4`	`debug(): DebugResults \| Promise<DebugResults>;`