cmake-style
Skill1 starsChanged 3 days agoMITView on GitHub
Write or edit CMakeLists.txt in Tsukini's style (from libutils, context-forge, c2dmp-hsm) - fixed section order with '# =====' banners, TARGET variable, clang++ C++20, ccache, warnings, explicit SRC list with group comments, Debug/Asan/Optimized modes, release targets, exception header generation, GTest tests/, install + find_package config, CPack RPM/DEB with stable/pre channels, Makefile wrapper. Use whenever creating, editing or reviewing a CMakeLists.txt, a tests/CMakeLists.txt, a *Config.cmake.in or the CMake packaging of one of the user's projects.
- Pipes a download into a shell
In this repository70 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- ask-at-endSkill
- clarifySkill
- continue-workSkill
- exportSkill
- full-permissionSkill
- ideationSkill
- interactive-questionsSkill
- onboardSkill
- pauseSkill
- presentationSkill
- rtkSkill
- setup-contextSkill
- write-like-meSkill
- audit-bugsSkill
- audit-depsSkill
- audit-qualitySkill
- audit-securitySkill
- benchmarkSkill
- cpp-classSkill
- cpp-commentsSkill
- cpp-projectSkill
- cpp-styleSkill
- better-explain-docSkill
- better-html-docSkill
- better-html-styleSkill
- better-protocol-docSkill
- docs-updateSkill
- explain-docSkill
- html-docSkill
- html-styleSkill
- protocol-docSkill
- readme-styleSkill
- reportSkill
- wiki-styleSkill
- ci-cdSkill
- git-commitSkill
- git-conventionsSkill
- pre-commitSkill
- legal-checkSkill
- legal-setupSkill
- licenseSkill
- libutils-exceptionSkill
- libutils-installSkill
- libutils-setupSkill
- libutilsSkill
- python-classSkill
- python-commentsSkill
- python-projectSkill
- python-styleSkill
- auditSkill
- cppSkill
- devSkill
- docSkill
- gitSkill
- legalSkill
- pythonSkill
- setup-projectSkill
- styleSkill
- setup-studioSkill
- The first 60 shown.
The file
We split this skill into the rules it gives an agent
1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 121
When xstyle is installed (command -v xstyle), check what was written or reviewed with it instead of re-reading the rules by hand: xstyle …
≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Tsukini CMake style
<name> (a skill) = the folder of that skill: ~/.claude/skills/<name> (setup.sh) or ${CLAUDE_SKILL_DIR}/../../*/<name> (plugin of the marketplace).
A new project: the CMakeLists.txt of cpp_project_template (made by cpp-project) is the reference and is kept
as generated - one file for every kind (<NAME>_KIND binary / library / header-only, <NAME>_PACKAGE_BIN / _LIB /
_DEV, <NAME>_SHARED_LIB), SRC / SRC_SHARED, the release / install_release / package_release targets, CPack
with the -op / -db / -as variants and the mingw64- packages, the MinGW toolchain cmake/toolchain/mingw-w64.cmake.
The templates below are for an existing project or a CMake written by hand, in the same style.
Templates (copy, then replace <name> = target/package name, <NAME> = upper-case option prefix,
<x.y.z> = version, <summary> = package description, <utils-version> = minimal libutils version):
| Project kind | Files |
| executable (context-forge) | templates/app/CMakeLists.txt |
| installable library (libutils) | templates/lib/CMakeLists.txt + templates/lib/NAMEConfig.cmake.in -> cmake/package/<name>Config.cmake.in |
| header-only library (c2dmp-hsm) | templates/lib/CMakeLists.txt with the src/nothing.cpp trick (see below) |
| unit tests (GTest) | templates/tests/CMakeLists.txt -> tests/CMakeLists.txt |
| helpers | templates/Makefile (root), templates/check_files.sh -> cmake/scripts/ |
Full real examples: ~/personal_delivery/cpp/libutils/CMakeLists.txt (library + multi-component packages),
~/personal_delivery/cpp/context-forge/CMakeLists.txt (executable + plugins .so).
File layout (always this order, omit the sections that don't apply)
cmake_minimum_required(VERSION 3.20)
set(TARGET <name>)
set(CMAKE_CXX_COMPILER clang++)
project(${TARGET} VERSION <x.y.z> LANGUAGES CXX)
# =========================
# Options
# =========================set(CMAKE_CXX_COMPILER clang++) goes before project(): the compiler is detected by project(), set after
it is ignored (or re-runs the configuration). Sections, each introduced by the 3-line banner (# + 25 =), one empty line before the next banner:
Options-option(<NAME>_STABLE_RELEASE "Channel as stable release" OFF),option(BUILD_TESTS "Build unit tests" OFF), project specific<NAME>_*.Compilateur & Standard(exact title) - C++20 required, no extensions, PIC, output dir for executables, global definitions.Requirement-find_package(...)with a trailing comment saying why,pkg_check_modules(... IMPORTED_TARGET ...), then the ccache block.Warnings-add_compile_options(-W -Wall -Wextra -Wpedantic -Wunused-parameter -Wshadow -Wuninitialized)one flag per line.Sources- explicitset(SRC ...)thenadd_executable/add_libraryright after the list.- Extra targets when needed (
Plugins,Compilation parametersforset_target_properties). Special Targets-testssubdirectory, generated exception header, aggregate custom targets.Release (build ...)-release,install_release,package_releasecustom targets that re-configure and build every mode.Dependencies- include dirs,target_link_libraries,add_dependencies(aforeach(target ${PLUGINS})for the extra targets).Includes/Headers configuration(libraries) -BUILD_INTERFACE/INSTALL_INTERFACE,configure_fileofversion.hpp.in.Modes- per configuration compile/link options (and theOUTPUT_NAMEsuffix of a library).Installation-include(GNUInstallDirs),install(...)withCOMPONENT, export + package config for a library.Utils-get_unregistered_filestarget.Package Building- CPack RPM & DEB with the stable/pre channels,include(CPack)last line.
Formatting
- Commands in lower case, 4 spaces,
if(...)/else()/endif()/foreach(...)/endforeach()without space and with empty()on the closers (the ccacheif (CCACHE_PROGRAM)is the only legacy exception). - One argument per line when a call has several arguments, closing
)alone at column 0 (or at the indentation of the call):add_compile_options(,set(SRC,add_custom_command(,install(. Short calls stay on one line:target_link_libraries(${TARGET} PRIVATE utils::utils). - Keywords grouped as in the examples:
OUTPUT,COMMAND,WORKING_DIRECTORY,DEPENDS,COMMENT,VERBATIM;set_target_properties(then targets,PROPERTIESand the indented key/values. - Variables
UPPER_SNAKE(SRC,SRC_<GROUP>,PLUGINS,CHANNEL,MIRROR_CHANNEL), options prefixed by the project in upper case (UTILS_,CONTEXT_FORGE_). Always${TARGET}, never the raw name, for the main target. - Paths from
${CMAKE_SOURCE_DIR}; sources relative to the root (src/<project>/X.cpp). - Comments:
# Commenttrailing or above, short English (typos aside), commented alternatives kept (#add_library(${TARGET} SHARED ${SRC})),# =========================banners only for sections. - One empty line between blocks inside a section, none after the opening banner.
Rules
- Sources are listed explicitly in
set(SRC ...), grouped by comments:# Groupor## Group,SRC= the executable only (itsmain.cpp) andSRC_SHARED= what the executable and the library share (the library target<name>_libis built from it, the executable links it) when a project has both (the template);## Group (sub-part: x)for a sub-folder, one empty line between groups. Neverfile(GLOB ...)for the sources (only for configs, withCONFIGURE_DEPENDS); theget_unregistered_filestarget lists the.cppmissing fromSRC/SRC_SHARED. To add a file:python3 <cpp-class>/scripts/cmake_add.py CMakeLists.txt src/<path>/X.cpp. - Build types:
Debug(-g -ggdb3),Asan(-fsanitize=address -fno-omit-frame-pointer -g -ggdb3+ link option),Optimized(-O3 -ffast-math -funroll-loops -pipe -DNDEBUG,-march=nativeonly for a binary not distributed,-fno-pltfor a library), all through generator expressions$<$<CONFIG:Debug>:...>. NoReleasetype: thereleasecustom target builds the modes. - Library output names per mode:
OUTPUT_NAME "<name>$<$<CONFIG:Debug>:_debug>$<$<CONFIG:Asan>:_asan>". - Executables are written at the root:
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}) # TARGET destination. - Exception codes: JSON files in
cmake/config/exceptions/, generated header withadd_custom_command+add_custom_target(generated_<internal|external>_exception_header)+add_dependencies(${TARGET} ...)(internal = libutils itself, external = a project using libutils). - libutils dependency:
find_package(utils <min version> CONFIG REQUIRED) # Check utils dependencies existanceutils::utils;<min version>is4.0.0at least for a new project (libutils v4: no v3 compatibility names,SameMajorVersion: a v3 requirement refuses an installed v4).
- Windows (libutils v4.1.0: packages
mingw64-libutils*in the MinGW sysroot;set(LIBUTILS_VERSION 4.1.0)then for a project built for Windows): the same CMake builds for Windows x86_64 with a MinGW toolchain (the template'scmake/toolchain/mingw-w64.cmakecopied into a project without one,mingw64-cmakeon Fedora, else-DCMAKE_TOOLCHAIN_FILE=; a source build oflibutils-install windowsinto a prefix:+ -DCMAKE_FIND_ROOT_PATH=<prefix>): its compiler wins over theclang++set beforeproject(), the executable is<name>.exe(.gitignore:/<name>.exe,/build-windows); no Asan with MinGW (built like Debug); the.exelinked-static-libgcc -static-libstdc++ -static(no MinGW runtime dll),if(WIN32)/if(NOT WIN32)for what differs, CPack with the MinGW sysroot prefix (cmake/package/CPackProjectConfig.cmakeof the template). - Tests:
if(BUILD_TESTS)->enable_testing()+add_subdirectory(tests);tests/CMakeLists.txtbuildsunit_tests(GTest,gtest_discover_tests), links the library target when it exists, else reuses the parentSRC_SHARED(orSRCwithoutmain.cpp); cross compiling: GTest byFetchContentwhen the sysroot has none,gtest_discover_tests(... DISCOVERY_MODE PRE_TEST)(run under the emulator,wine). - Header-only library: an
INTERFACElibrary target (the template:add_library(${TARGET_LIB} INTERFACE), only the headers and the CMake config packaged); in an older CMake:src/nothing.cppinSRCto keep a target, amessage(WARNING ...)explaining that only--target installis meaningful, andtarget_include_directories(${TARGET} PUBLIC include). - Library install:
install(TARGETS ... EXPORT ${TARGET}Targets ...), headersinstall(DIRECTORY include/ ... PATTERN "*.in" EXCLUDE),install(EXPORT ... NAMESPACE ${TARGET}:: ...),configure_package_config_file+write_basic_package_version_file(SameMajorVersion) so thatfind_package(<name> <version> CONFIG REQUIRED)works. - Packages:
CPACK_GENERATOR "RPM;DEB", vendor/maintainerTsukiNi22, contactxartania.contact@gmail.com, MIT, channel-preunless<NAME>_STABLE_RELEASE, the stable package obsoletes/replaces the-preone and both conflict, release number1for stable /${PACKAGE_RELEASE}(CI run number) /0. - New target / output written in the sources (executable at the root, plugin dir, generated file): update the
.gitignorewithpython3 <cpp-project>/scripts/update_gitignore.py <root>. - Root
Makefilewrapper (all,clean,fclean,re) calling CMake withBUILD_DIR := build.
Checking (xstyle)
When xstyle is installed (command -v xstyle), check what was written or reviewed with it instead of re-reading the
rules by hand: xstyle --rtk <files|dirs> [-r] (always --rtk: compact output made for the assistant),
xstyle --rtk --fix [CODES] <paths> for the fixable ones (-n to preview), -c CMAKE,G for the rules of this
skill, xstyle -x CODE to explain one. Not installed: apply the rules by hand and say once that
curl -fsSL https://tsukini22.github.io/my-universe/install.sh | bash -s then sudo dnf|apt|pacman install xstyle (packages of my-universe, sources: TsukiNi22/xstyle; no curl: wget -qO- instead of curl -fsSL) would check them. Its findings are heuristic: the local style of a file wins.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

