Add initial project structure with CMake configuration, Clang format … by Katze719 · Pull Request #2 · Serial-IO/cpp-bindings-windows

Katze719 · 2025-12-20T22:18:32Z

…and tidy settings, GitHub workflows, and integration tests for Windows serial communication bindings

Copilot

Pull request overview

This PR establishes the foundational structure for a Windows serial communication library with CMake build system, comprehensive tooling configuration, and CI/CD pipelines. It implements Windows-specific serial port operations (open, close, read, write) using Win32 APIs with overlapped I/O for asynchronous operations.

Complete Windows serial communication implementation using Win32 overlapped I/O
CMake-based build system with GoogleTest integration and git-based versioning
Comprehensive development tooling (clang-format, clang-tidy) and GitHub Actions CI/CD workflows
JSR package distribution setup with base64-encoded binary payloads for Deno FFI consumption

Reviewed changes

Copilot reviewed 25 out of 28 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
`src/serial_open.cpp`	Implements serial port opening with DCB configuration and overlapped I/O setup
`src/serial_close.cpp`	Handles serial port closing with proper handle validation
`src/serial_read.cpp`	Implements overlapped read operations with timeout and queuing support
`src/serial_write.cpp`	Implements overlapped write operations with FlushFileBuffers for reliability
`src/detail/win32_helpers.hpp`	Provides RAII handle wrapper and Win32 error handling utilities
`tests/test_serial_arduino.cpp`	GoogleTest-based integration tests for Arduino serial communication
`integration_tests/integration_test.ts`	Deno integration tests for FFI library loading
`integration_tests/ffi_bindings.ts`	Deno FFI symbol definitions for serial operations
`CMakeLists.txt`	CMake configuration with CPM package management and GoogleTest setup
`.clang-format`	Microsoft-style code formatting configuration
`.clang-tidy`	Comprehensive static analysis rules configuration
`.github/workflows/cpp-tests.yml`	CI workflow for C++ unit and integration tests
`.github/workflows/deno-tests.yml`	CI workflow for Deno FFI integration tests across versions
`.github/workflows/build-deno-dll.yml`	CI workflow for building and uploading DLL artifacts
`.github/workflows/publish-jsr.yml`	CD workflow for publishing to JSR with base64-encoded binaries
`jsr/scripts/embed_binary.ps1`	PowerShell script to embed DLL as base64 JSON for JSR
`jsr/scripts/embed_binary.sh`	Shell script for embedding binaries (Linux/Unix, potentially unused)
`jsr/package/jsr.json.in`	JSR package metadata template with version placeholder
`jsr/package/README.md`	Documentation for consuming the JSR package in Deno

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

… to return structured error messages in serial_open.cpp and serial_read.cpp.

…ectations in SerialArduinoTest

…noTest to use COM5. This includes installing the com0com driver, creating a virtual COM pair, and starting an echo loop for testing. Adjusted the default serial port in tests to COM5 and improved error handling for port opening.

…handling and improve script execution. Updated paths for locating setupc.exe and com0com.inf, and added a sleep delay after starting the echo loop for stability.

…mprove path handling and error reporting. Updated script to search for setupc.exe and com0com.inf exclusively within the Chocolatey package directory, enhancing efficiency and reliability.

…more efficient and deterministic search for setupc.exe and com0com.inf. Updated error handling to check multiple candidate paths and limit search depth, improving reliability in locating necessary files.

…ake presets for Windows builds, and enhance test source organization. Introduce new tests for serial operations and error handling, including serial_close, serial_open, serial_read, and serial_write. Add error capture utility for improved error reporting in tests.

…or Windows, replacing the previous Deno DLL build and C++ test workflows. Add CMake presets for Visual Studio 2022 and update the JSR package structure to include a new binary export format. Refactor the JSR metadata to improve organization and include additional source files. Remove outdated workflows to streamline the CI process.

…d introducing a new versioning script. Update GitHub workflows to prepare files for JSR publishing, including changes to directory structure and file paths. Add necessary files such as LICENSE, README.md, and jsr.json for improved package organization and usability.

…he target specification for C++ test binaries, simplifying the build command.

…the structure of the package metadata.

…related includes from test files, streamlining the testing setup.

…st std::numeric_limits<int> for improved error handling and robustness.

…eamlining the file for better clarity and focus on essential information.

…mpliance with licensing requirements.

Mqxx

Will check if the windows side works.

…Wide conversion function. Update tests to reflect changes in port type from wchar_t to char, ensuring compatibility with new implementation.

Co-authored-by: Katze719 <38188106+Katze719@users.noreply.github.com>

- Updated artifact names from 'libcpp_bindings_windows' to 'cpp_bindings_windows' for consistency across workflows. - Adjusted file paths in build and publish scripts to reflect the new artifact naming convention.

Katze719 · 2026-02-24T20:49:43Z

waiting for cpp-core v1.1.0 release

Mqxx · 2026-02-26T06:15:28Z

waiting for cpp-core v1.1.0 release

Version 1.1.0 was merged 👍

- Changed cpp_core package version from 'main' to 'v1.1.0' in CMakeLists.txt. - Refactored serial_close, serial_open, serial_read, and serial_write implementations to use new validation and error handling mechanisms. - Removed deprecated status code checks and replaced them with cpp_core's validation functions for better error management. - Improved readability and maintainability of the serial communication functions by utilizing modern C++ practices.

- Introduced a raw_handle variable to capture the result of CreateFileW. - Updated UniqueHandle initialization to handle INVALID_HANDLE_VALUE by normalizing it to nullptr, enhancing error management in serial communication.

Add initial project structure with CMake configuration, Clang format …
20fe746
…and tidy settings, GitHub workflows, and integration tests for Windows serial communication bindings

Katze719 self-assigned this Dec 20, 2025

Katze719 added 2 commits December 21, 2025 09:37

Add compile definitions for Windows bindings in CMake configuration
3273a45

Disable Google Mock in CMake configuration for Windows bindings
a21dc78

Katze719 requested a review from Copilot December 21, 2025 08:48

Copilotstarted reviewing on behalf of Katze719 December 21, 2025 08:48 View session

CopilotAI reviewed Dec 21, 2025
View reviewed changes

Katze719 added 15 commits December 21, 2025 10:09

Remove embed_binary.sh script and refactor applyLineSettings function…
271e185
… to return structured error messages in serial_open.cpp and serial_read.cpp.

Add readExact function to improve serial reading in tests; update exp…
e1fb4c7
…ectations in SerialArduinoTest

Refactor virtual COM port setup in GitHub workflows to enhance error …
cb72296
…handling and improve script execution. Updated paths for locating setupc.exe and com0com.inf, and added a sleep delay after starting the echo loop for stability.

Refactor virtual COM port setup in Deno and C++ GitHub workflows to i…
7194e8a
…mprove path handling and error reporting. Updated script to search for setupc.exe and com0com.inf exclusively within the Chocolatey package directory, enhancing efficiency and reliability.

Enhance virtual COM port setup in GitHub workflows by implementing a …
2a128d2
…more efficient and deterministic search for setupc.exe and com0com.inf. Updated error handling to check multiple candidate paths and limit search depth, improving reliability in locating necessary files.

Update GitHub workflow to streamline test build process by removing t…
b861302
…he target specification for C++ test binaries, simplifying the build command.

Format jsr.json for improved readability and organization, enhancing …
85915da
…the structure of the package metadata.

Update CMake configuration to disable Google Mock support and remove …
85bd371
…related includes from test files, streamlining the testing setup.

Update handle validation in serial operations to include checks again…
9ea88ec
…st std::numeric_limits<int> for improved error handling and robustness.

Remove the GNU General Public License text from the LICENSE file, str…
7fe10ef
…eamlining the file for better clarity and focus on essential information.

Update license field in jsr.json to specify GPL-3.0-only, ensuring co…
e643ccb
…mpliance with licensing requirements.

Katze719 requested a review from Mqxx February 21, 2026 16:11

Katze719 marked this pull request as ready for review February 21, 2026 16:11

Mqxx added 3 commits February 22, 2026 15:44

Update README.md
40258a4

Update jsr.json
9b8fb41

Update LICENSE
68c8e46

Mqxx reviewed Feb 22, 2026
View reviewed changes

Refactor serial port handling to support UTF-8 input by adding utf8To…
1d026fe
…Wide conversion function. Update tests to reflect changes in port type from wchar_t to char, ensuring compatibility with new implementation.

Katze719 requested a review from Mqxx February 22, 2026 17:29

Mqxx requested changes Feb 23, 2026
View reviewed changes

Comment thread.github/workflows/build_binary.yml Outdated
Comment thread.github/workflows/publish_jsr.yml Outdated
Comment threadjsr/scripts/embed_binary.ps1 Outdated

Mqxx added 7 commits February 23, 2026 11:02

fix: refactor
ed8b46c

Update publish_jsr.yml
a921633

Update publish_jsr.yml
5352c7a

Update publish_jsr.yml
b77856b

Update build_binary.yml
041ad8c

Update build_binary.yml
b13aa2f

Update build_binary.yml
28a4ce7

Katze719 commented Feb 23, 2026
View reviewed changes

Comment thread.github/workflows/build_binary.yml Outdated

Mqxxand others added 2 commits February 23, 2026 12:09

Update .github/workflows/build_binary.yml
4e5040d
Co-authored-by: Katze719 <38188106+Katze719@users.noreply.github.com>

Refactor artifact naming and paths in CI workflows
21309a1
- Updated artifact names from 'libcpp_bindings_windows' to 'cpp_bindings_windows' for consistency across workflows. - Adjusted file paths in build and publish scripts to reflect the new artifact naming convention.

Katze719 force-pushed the revamp-project branch from 49c053d to 21309a1Compare February 24, 2026 18:26

Mqxx requested changes Feb 24, 2026
View reviewed changes

Comment threadsrc/detail/win32_helpers.hpp
Comment threadsrc/serial_open.cpp
Comment threadsrc/serial_read.cpp

Katze719 added the blocked Progress is blocked by another issue or dependency label Feb 24, 2026

Mqxx added 2 commits February 25, 2026 09:10

Create block_pr_check_labels.yml
6a1cc1b

Update block_pr_check_labels.yml
119f95c

Katze719 removed the blocked Progress is blocked by another issue or dependency label Feb 26, 2026

Mqxx requested changes Mar 9, 2026
View reviewed changes

Comment threadsrc/serial_open.cpp
Comment threadsrc/serial_open.cpp

Mqxx reviewed Mar 9, 2026
View reviewed changes

Comment threadsrc/serial_read.cpp

Mqxx reviewed Mar 9, 2026
View reviewed changes

Comment threadsrc/serial_write.cpp

Mqxx self-requested a review March 9, 2026 08:59

Mqxx approved these changes Mar 9, 2026
View reviewed changes

Katze719 merged commit 1bf5ce8 into mainMar 9, 2026
7 checks passed

Katze719 deleted the revamp-project branch March 9, 2026 09:03

Uh oh!

Conversation

Katze719 commented Dec 20, 2025

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Mqxx left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Katze719 commented Feb 24, 2026

Uh oh!

Mqxx commented Feb 26, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants