feat: add format check to CI workflow, update .gitignore and .prettierignore, and improve code formatting across multiple files

JakubAndrysek · JakubAndrysek · commit 74d3aa2c7b2a · 2025-11-19T12:27:55.000+01:00
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -24,6 +24,8 @@ jobs:
         run: pnpm run build
       - name: Install Playwright browsers
         run: pnpm exec playwright install --with-deps
+      - name: Format check
+        run: pnpm run format:check
       - name: Run vitest tests
         run: pnpm run test:vitest
       - name: Run Playwright embed tests
diff --git a/.gitignore b/.gitignore
@@ -7,3 +7,4 @@ screenshot.png
 playwright-report/
 test-results/
 test-project/
+wokwi-part-tests/
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,27 @@
+# Ignore node_modules
+node_modules/
+
+# Ignore build outputs
+dist/
+build/
+
+# Ignore logs
+*.log
+
+# Ignore package-lock.json if present
+package-lock.json
+
+# Ignore Arduino-specific files
+*.hex
+*.elf
+*.bin
+
+# Ignore OS-specific files
+.DS_Store
+Thumbs.db
+
+# repo specific ignores
+playwright-report/
+test-results/
+test-project/
+wokwi-part-tests/
diff --git a/packages/wokwi-cli/src/constants.ts b/packages/wokwi-cli/src/constants.ts
@@ -1,2 +1 @@
 export const DEFAULT_SERVER = process.env.WOKWI_CLI_SERVER ?? 'wss://wokwi.com/api/ws/beta';
-
diff --git a/packages/wokwi-cli/src/main.ts b/packages/wokwi-cli/src/main.ts
@@ -3,7 +3,12 @@ import chalkTemplate from 'chalk-template';
 import { createWriteStream, existsSync, readFileSync, writeFileSync } from 'fs';
 import path, { join } from 'path';
 import YAML from 'yaml';
-import { APIClient, type APIEvent, type ChipsLogPayload, type SerialMonitorDataPayload } from 'wokwi-client-js';
+import {
+  APIClient,
+  type APIEvent,
+  type ChipsLogPayload,
+  type SerialMonitorDataPayload,
+} from 'wokwi-client-js';
 import { WebSocketTransport } from './transport/WebSocketTransport.js';
 import { DEFAULT_SERVER } from './constants.js';
 import { createSerialMonitorWritable } from './utils/serialMonitorWritable.js';
@@ -297,7 +302,10 @@ async function main() {
 
     for (const chip of chips) {
       await client.fileUpload(`${chip.name}.chip.json`, readFileSync(chip.jsonPath, 'utf-8'));
-      await client.fileUpload(`${chip.name}.chip.wasm`, new Uint8Array(readFileSync(chip.wasmPath)));
+      await client.fileUpload(
+        `${chip.name}.chip.wasm`,
+        new Uint8Array(readFileSync(chip.wasmPath)),
+      );
     }
 
     const promises = [];
@@ -374,7 +382,7 @@ async function main() {
 
     if (promises.length === 0) {
       // wait forever
-      await new Promise(() => { });
+      await new Promise(() => {});
     }
 
     // wait until the scenario finishes or a timeout occurs
diff --git a/packages/wokwi-cli/src/mcp/MCPServer.ts b/packages/wokwi-cli/src/mcp/MCPServer.ts
@@ -1,10 +1,10 @@
 import { Server as McpServer } from '@modelcontextprotocol/sdk/server/index.js';
 import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
-import { 
-  CallToolRequestSchema, 
+import {
+  CallToolRequestSchema,
   ListToolsRequestSchema,
   ListResourcesRequestSchema,
-  ReadResourceRequestSchema
+  ReadResourceRequestSchema,
 } from '@modelcontextprotocol/sdk/types.js';
 import { readVersion } from '../readVersion.js';
 import { SimulationManager } from './SimulationManager.js';
@@ -25,16 +25,19 @@ export class WokwiMCPServer {
 
   constructor(private readonly options: MCPServerOptions) {
     const { version } = readVersion();
-    
-    this.server = new McpServer({
-      name: 'wokwi-cli',
-      version,
-    }, {
-      capabilities: {
-        tools: {},
-        resources: {},
+
+    this.server = new McpServer(
+      {
+        name: 'wokwi-cli',
+        version,
       },
-    });
+      {
+        capabilities: {
+          tools: {},
+          resources: {},
+        },
+      },
+    );
 
     this.simulationManager = new SimulationManager(options.rootDir, options.token, options.quiet);
     this.tools = new WokwiMCPTools(this.simulationManager);
@@ -64,7 +67,7 @@ export class WokwiMCPServer {
   async start() {
     const transport = new StdioServerTransport();
     await this.server.connect(transport);
-    
+
     if (!this.options.quiet) {
       console.error('Wokwi MCP Server started');
     }
@@ -74,4 +77,4 @@ export class WokwiMCPServer {
     await this.simulationManager.cleanup();
     await this.server.close();
   }
-}
+}
diff --git a/packages/wokwi-cli/src/mcp/SimulationManager.ts b/packages/wokwi-cli/src/mcp/SimulationManager.ts
@@ -110,7 +110,10 @@ export class SimulationManager {
 
     for (const chip of chips) {
       await this.client.fileUpload(`${chip.name}.chip.json`, readFileSync(chip.jsonPath, 'utf-8'));
-      await this.client.fileUpload(`${chip.name}.chip.wasm`, new Uint8Array(readFileSync(chip.wasmPath)));
+      await this.client.fileUpload(
+        `${chip.name}.chip.wasm`,
+        new Uint8Array(readFileSync(chip.wasmPath)),
+      );
     }
 
     // Start simulation
diff --git a/packages/wokwi-cli/src/mcp/WokwiMCPTools.ts b/packages/wokwi-cli/src/mcp/WokwiMCPTools.ts
@@ -14,7 +14,8 @@ export class WokwiMCPTools {
           properties: {
             projectPath: {
               type: 'string',
-              description: 'Path to the project directory (optional, defaults to current directory)',
+              description:
+                'Path to the project directory (optional, defaults to current directory)',
             },
           },
         },
@@ -135,7 +136,10 @@ export class WokwiMCPTools {
     ];
   }
 
-  async callTool(name: string, args: any): Promise<{ content: Array<{ type: 'text'; text: string }> }> {
+  async callTool(
+    name: string,
+    args: any,
+  ): Promise<{ content: Array<{ type: 'text'; text: string }> }> {
     try {
       switch (name) {
         case 'wokwi_start_simulation':
@@ -239,4 +243,4 @@ export class WokwiMCPTools {
       };
     }
   }
-}
+}
diff --git a/packages/wokwi-cli/src/mcp/index.ts b/packages/wokwi-cli/src/mcp/index.ts
@@ -3,4 +3,4 @@ export { SimulationManager } from './SimulationManager.js';
 export { WokwiMCPTools } from './WokwiMCPTools.js';
 export { WokwiMCPResources } from './WokwiMCPResources.js';
 export type { MCPServerOptions } from './MCPServer.js';
-export type { SimulationStatus } from './SimulationManager.js';
+export type { SimulationStatus } from './SimulationManager.js';
diff --git a/packages/wokwi-cli/src/transport/WebSocketTransport.ts b/packages/wokwi-cli/src/transport/WebSocketTransport.ts
@@ -20,12 +20,12 @@ export class WebSocketTransport implements ITransport {
 
   private socket: WebSocket;
   private connectionAttempts = 0;
-  
+
   // to suppress close events when intentionally closing
-  private ignoreClose = false;  
-  
+  private ignoreClose = false;
+
   // retryable error statuses
-  private readonly errorStates = [ 
+  private readonly errorStates = [
     ErrorStatus.RequestTimeout,
     ErrorStatus.ServiceUnavailable,
     ErrorStatus.CfRequestTimeout,
@@ -35,7 +35,7 @@ export class WebSocketTransport implements ITransport {
     private readonly token: string,
     private readonly server: string,
     private readonly version: string,
-    private readonly sha: string
+    private readonly sha: string,
   ) {
     this.socket = this.createSocket();
   }
diff --git a/packages/wokwi-cli/tools/bundle.js b/packages/wokwi-cli/tools/bundle.js
@@ -45,4 +45,3 @@ const options = {
 };
 
 build(options).catch(() => process.exit(1));
-
diff --git a/packages/wokwi-cli/tsconfig.json b/packages/wokwi-cli/tsconfig.json
@@ -1,9 +1,9 @@
 {
-    "extends": "../../tsconfig.base.json",
-    "compilerOptions": {
-        "outDir": "dist",
-        "rootDir": "src"
-    },
-    "include": ["src/**/*.ts"],
-    "exclude": ["src/**/*.spec.ts", "node_modules", "dist"]
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["src/**/*.spec.ts", "node_modules", "dist"]
 }
diff --git a/packages/wokwi-client-js/src/APIClient.ts b/packages/wokwi-client-js/src/APIClient.ts
@@ -30,12 +30,16 @@ export class APIClient {
   onConnected?: (helloMessage: APIHello) => void;
   onError?: (error: APIError) => void;
 
-  constructor(
-    private readonly transport: ITransport,
-  ) {
-    this.transport.onMessage = (message) => { this.processMessage(message); };
-    this.transport.onClose = (code, reason) => { this.handleTransportClose(code, reason); };
-    this.transport.onError = (error) => { this.handleTransportError(error); };
+  constructor(private readonly transport: ITransport) {
+    this.transport.onMessage = (message) => {
+      this.processMessage(message);
+    };
+    this.transport.onClose = (code, reason) => {
+      this.handleTransportClose(code, reason);
+    };
+    this.transport.onError = (error) => {
+      this.handleTransportError(error);
+    };
 
     // Initiate connection
     this.connected = this.transport.connect();
@@ -53,7 +57,9 @@ export class APIClient {
   }
 
   async fileDownload(name: string): Promise<string | Uint8Array> {
-    const result = await this.sendCommand<{ text?: string; binary?: string }>('file:download', { name });
+    const result = await this.sendCommand<{ text?: string; binary?: string }>('file:download', {
+      name,
+    });
     if (typeof result.text === 'string') {
       return result.text;
     } else if (typeof result.binary === 'string') {
diff --git a/packages/wokwi-client-js/src/PausePoint.ts b/packages/wokwi-client-js/src/PausePoint.ts
@@ -29,4 +29,3 @@ export class PausePoint<T = any> {
     this._resolve(info);
   }
 }
-
diff --git a/packages/wokwi-client-js/src/base64.ts b/packages/wokwi-client-js/src/base64.ts
@@ -11,8 +11,7 @@ export function base64ToByteArray(base64str: string): Uint8Array {
   }
 }
 
-
-export function byteArrayToBase64(bytes: Uint8Array): string {  
+export function byteArrayToBase64(bytes: Uint8Array): string {
   if (typeof Buffer !== 'undefined') {
     // Node.js
     return Buffer.from(bytes.buffer, bytes.byteOffset, bytes.byteLength).toString('base64');
diff --git a/packages/wokwi-client-js/src/transport/MessagePortTransport.ts b/packages/wokwi-client-js/src/transport/MessagePortTransport.ts
@@ -1,4 +1,4 @@
-import { ITransport } from "./ITransport.js";
+import { ITransport } from './ITransport.js';
 
 /**
  * Transport for communicating with a Wokwi Simulator over a MessagePort.
diff --git a/packages/wokwi-client-js/tsconfig.json b/packages/wokwi-client-js/tsconfig.json
@@ -7,4 +7,3 @@
   "include": ["src/**/*.ts"],
   "exclude": ["src/**/*.spec.ts", "node_modules"]
 }
-
diff --git a/scripts/test-cli-integration.ts b/scripts/test-cli-integration.ts
@@ -7,56 +7,60 @@ const TEST_PROJECT_DIR = 'test-project';
 const TEST_REPO = 'https://github.com/wokwi/esp-idf-hello-world.git';
 
 function cloneWithGit(dir: string) {
-	console.log('Cloning test project with git...');
-	execSync(`git clone ${TEST_REPO} ${dir}`, { stdio: 'inherit' });
+  console.log('Cloning test project with git...');
+  execSync(`git clone ${TEST_REPO} ${dir}`, { stdio: 'inherit' });
 }
 
 async function ensureTestProject() {
-	if (fsSync.existsSync(TEST_PROJECT_DIR)) {
-		console.log('Test project already exists, skipping clone/download...');
-		return;
-	}
-
-	try {
-		cloneWithGit(TEST_PROJECT_DIR);
-		return;
-	} catch (err) {
-		console.log('git clone failed:', (err as Error).message);
-		throw new Error('git clone failed; git is required to run integration tests');
-	}
+  if (fsSync.existsSync(TEST_PROJECT_DIR)) {
+    console.log('Test project already exists, skipping clone/download...');
+    return;
+  }
+
+  try {
+    cloneWithGit(TEST_PROJECT_DIR);
+    return;
+  } catch (err) {
+    console.log('git clone failed:', (err as Error).message);
+    throw new Error('git clone failed; git is required to run integration tests');
+  }
 }
 
 async function createScenarioFile() {
-	const content = `name: "Basic Hello World Test"\nversion: 1\ndescription: "Test that the ESP32 hello world program outputs expected text"\n\nsteps:\n  - name: "Wait for boot and hello message"\n    wait-serial: "Hello world!"\n\n  - name: "Wait for chip information"\n    wait-serial: "This is esp32 chip"\n\n  - name: "Wait for restart message"\n    wait-serial: "Restarting in 10 seconds"\n`;
-	await fs.writeFile(path.join(TEST_PROJECT_DIR, 'test-scenario.yaml'), content, 'utf8');
-	console.log('Test scenario file created.');
+  const content = `name: "Basic Hello World Test"\nversion: 1\ndescription: "Test that the ESP32 hello world program outputs expected text"\n\nsteps:\n  - name: "Wait for boot and hello message"\n    wait-serial: "Hello world!"\n\n  - name: "Wait for chip information"\n    wait-serial: "This is esp32 chip"\n\n  - name: "Wait for restart message"\n    wait-serial: "Restarting in 10 seconds"\n`;
+  await fs.writeFile(path.join(TEST_PROJECT_DIR, 'test-scenario.yaml'), content, 'utf8');
+  console.log('Test scenario file created.');
 }
 
 async function main() {
-	try {
-		await ensureTestProject();
-		await createScenarioFile();
-
-		if (!process.env.WOKWI_CLI_TOKEN) {
-			console.error('Warning: WOKWI_CLI_TOKEN environment variable is not set.');
-			console.error('Integration tests require a Wokwi API token to run.');
-			console.error('Set WOKWI_CLI_TOKEN environment variable to run these tests.');
-			process.exit(1);
-		}
-
-		console.log('Running CLI integration tests...');
-
-		console.log('Test 1: Basic expect-text test');
-		execSync(`pnpm cli ${TEST_PROJECT_DIR} --timeout 5000 --expect-text Hello`, { stdio: 'inherit' });
-
-		console.log('Test 2: Scenario file test');
-		execSync(`pnpm cli ${TEST_PROJECT_DIR} --scenario test-scenario.yaml --timeout 15000`, { stdio: 'inherit' });
-
-		console.log('All CLI integration tests passed!');
-	} catch (err) {
-		console.error('Integration tests failed:', (err as Error).message);
-		process.exit(1);
-	}
+  try {
+    await ensureTestProject();
+    await createScenarioFile();
+
+    if (!process.env.WOKWI_CLI_TOKEN) {
+      console.error('Warning: WOKWI_CLI_TOKEN environment variable is not set.');
+      console.error('Integration tests require a Wokwi API token to run.');
+      console.error('Set WOKWI_CLI_TOKEN environment variable to run these tests.');
+      process.exit(1);
+    }
+
+    console.log('Running CLI integration tests...');
+
+    console.log('Test 1: Basic expect-text test');
+    execSync(`pnpm cli ${TEST_PROJECT_DIR} --timeout 5000 --expect-text Hello`, {
+      stdio: 'inherit',
+    });
+
+    console.log('Test 2: Scenario file test');
+    execSync(`pnpm cli ${TEST_PROJECT_DIR} --scenario test-scenario.yaml --timeout 15000`, {
+      stdio: 'inherit',
+    });
+
+    console.log('All CLI integration tests passed!');
+  } catch (err) {
+    console.error('Integration tests failed:', (err as Error).message);
+    process.exit(1);
+  }
 }
 
-await main()
+await main();
diff --git a/test/wokwi-embed/index.html b/test/wokwi-embed/index.html
diff --git a/test/wokwi-embed/script.js b/test/wokwi-embed/script.js
diff --git a/test/wokwi-embed/wokwi-embed.spec.ts b/test/wokwi-embed/wokwi-embed.spec.ts

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1 @@`
`1`	`1`	`export const DEFAULT_SERVER = process.env.WOKWI_CLI_SERVER ?? 'wss://wokwi.com/api/ws/beta';`
`2`		`-`