🎨 Code format and linting config update (#408)

Author: burgholzer

.clang-tidy

@@ -1,14 +1,13 @@
 FormatStyle: file
 
 Checks: |
-  clang-diagnostic-*,
-  clang-analyzer-*,
-  -clang-analyzer-core.NullDereference,
   boost-*,
   bugprone-*,
   -bugprone-easily-swappable-parameters,
   -bugprone-unchecked-optional-access,
   clang-analyzer-*,
+  -clang-analyzer-core.NullDereference,
+  clang-diagnostic-*,
   cppcoreguidelines-*,
   -cppcoreguidelines-non-private-member-variables-in-classes,
   -cppcoreguidelines-special-member-functions,

.cmake-format.yaml

@@ -1,3 +1,4 @@
 format:
+  line_width: 100
   keyword_case: "upper"
   autosort: true

.editorconfig

@@ -0,0 +1,18 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{py,pyi}]
+indent_size = 4
+
+[*.md]
+trim_trailing_whitespace = false
+
+[{*.{cmake,cmake.in},CMakeLists.txt}]
+max_line_length = 100

.git_archival.txt

@@ -1,4 +1,3 @@
 node: $Format:%H$
 node-date: $Format:%cI$
 describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$
-ref-names: $Format:%D$

.gitignore

@@ -53,6 +53,7 @@ coverage.xml
 .hypothesis/
 .pytest_cache/
 cover/
+*.profraw
 
 # Translations
 *.mo
@@ -73,6 +74,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/api/
 
 # PyBuilder
 .pybuilder/
@@ -136,7 +138,7 @@ _skbuild/
 
 # Any build dirs in the tests
 test/**/build/
-/src/mqt/qcec/_version.py
+/src/mqt/**/_version.py
 
 # Common editor files
 *~
@@ -169,3 +171,6 @@ Thumbs.db
 /docs/**/build
 .vs
 out/build
+
+node_modules/
+wheelhouse/

CMakeLists.txt

@@ -23,9 +23,7 @@ if(BUILD_MQT_QCEC_BINDINGS)
       CACHE STRING "Prefer Brew/Conda to Apple framework Python")
   set(Python_ARTIFACTS_INTERACTIVE
       ON
-      CACHE
-        BOOL
-        "Prevent multiple searches for Python and instead cache the results.")
+      CACHE BOOL "Prevent multiple searches for Python and instead cache the results.")
 
   # top-level call to find Python
   find_package(
@@ -46,9 +44,7 @@ if(BUILD_MQT_QCEC_TESTS)
   add_subdirectory(test)
 endif()
 
-configure_file(
-  ${CMAKE_CURRENT_SOURCE_DIR}/cmake/cmake_uninstall.cmake.in
-  ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake IMMEDIATE @ONLY)
-add_custom_target(
-  uninstall COMMAND ${CMAKE_COMMAND} -P
-                    ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/cmake/cmake_uninstall.cmake.in
+               ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake IMMEDIATE @ONLY)
+add_custom_target(uninstall COMMAND ${CMAKE_COMMAND} -P
+                                    ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake)

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Chair for Design Automation, Technical University of Munich
+Copyright (c) 2024 Chair for Design Automation, Technical University of Munich
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

cmake/ExternalDependencies.cmake

@@ -53,12 +53,9 @@ if(BUILD_MQT_QCEC_TESTS)
   set(GTEST_VERSION
       1.14.0
       CACHE STRING "Google Test version")
-  set(GTEST_URL
-      https://github.com/google/googletest/archive/refs/tags/v${GTEST_VERSION}.tar.gz
-  )
+  set(GTEST_URL https://github.com/google/googletest/archive/refs/tags/v${GTEST_VERSION}.tar.gz)
   if(CMAKE_VERSION VERSION_GREATER_EQUAL 3.24)
-    FetchContent_Declare(googletest URL ${GTEST_URL} FIND_PACKAGE_ARGS
-                                        ${GTEST_VERSION} NAMES GTest)
+    FetchContent_Declare(googletest URL ${GTEST_URL} FIND_PACKAGE_ARGS ${GTEST_VERSION} NAMES GTest)
     list(APPEND FETCH_PACKAGES googletest)
   else()
     find_package(googletest ${GTEST_VERSION} QUIET NAMES GTest)
@@ -80,8 +77,7 @@ if(BUILD_MQT_QCEC_BINDINGS)
   else()
     find_package(pybind11_json QUIET)
     if(NOT pybind11_json_FOUND)
-      FetchContent_Declare(
-        pybind11_json GIT_REPOSITORY https://github.com/pybind/pybind11_json)
+      FetchContent_Declare(pybind11_json GIT_REPOSITORY https://github.com/pybind/pybind11_json)
       list(APPEND FETCH_PACKAGES pybind11_json)
     endif()
   endif()

cmake/cmake_uninstall.cmake.in

@@ -1,10 +1,7 @@
-# Source:
-# https://gitlab.kitware.com/cmake/community/-/wikis/FAQ#can-i-do-make-uninstall-with-cmake
+# Source: https://gitlab.kitware.com/cmake/community/-/wikis/FAQ#can-i-do-make-uninstall-with-cmake
 
 if(NOT EXISTS "@CMAKE_BINARY_DIR@/install_manifest.txt")
-  message(
-    FATAL_ERROR
-      "Cannot find install manifest: @CMAKE_BINARY_DIR@/install_manifest.txt")
+  message(FATAL_ERROR "Cannot find install manifest: @CMAKE_BINARY_DIR@/install_manifest.txt")
 endif()
 
 file(READ "@CMAKE_BINARY_DIR@/install_manifest.txt" files)

src/CMakeLists.txt

@@ -22,8 +22,7 @@ target_include_directories(${PROJECT_NAME} PUBLIC ${PROJECT_SOURCE_DIR}/include
 
 # link to the MQT::Core libraries
 target_link_libraries(${PROJECT_NAME} PUBLIC MQT::CoreDD MQT::CoreZX)
-target_link_libraries(${PROJECT_NAME} PRIVATE MQT::ProjectWarnings
-                                              MQT::ProjectOptions)
+target_link_libraries(${PROJECT_NAME} PRIVATE MQT::ProjectWarnings MQT::ProjectOptions)
 
 # add MQT alias
 add_library(MQT::QCEC ALIAS ${PROJECT_NAME})

src/python/CMakeLists.txt

@@ -6,8 +6,8 @@ pybind11_add_module(
   OPT_SIZE
   # Source code goes here
   bindings.cpp)
-target_link_libraries(pyqcec PRIVATE MQT::QCEC MQT::CorePython pybind11_json
-                                     MQT::ProjectOptions MQT::ProjectWarnings)
+target_link_libraries(pyqcec PRIVATE MQT::QCEC MQT::CorePython pybind11_json MQT::ProjectOptions
+                                     MQT::ProjectWarnings)
 
 # Install directive for scikit-build-core
 install(