compile_flagz - GitLite

KO | EN

gitlite — search

#html #python #ai #mcp #shell #developer-tools #svg #css #machine-learning #nodejs

compile_flagz

(★ 15)

Zig library for generating compile_flags.txt for C/C++ IDE integration in Zig-built projects

File Explorer

ZIP Download

- FUNDING.yml
- - main.zig
  - root.zig
- build.zig
- build.zig.zon
- CompileFlags.zig
.gitignore
.rules
build.zig
build.zig.zon
CLAUDE.md
LICENSE
mise.toml
README.md

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

`zig`

View Details ▼

The Zig compiler and toolchain.

zig build

Compile the project in the current directory:

zig build run

Compile and run the project in the current directory:

zig init

Initialize a `zig build` project with library and executable:

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

A Zig library for generating `compile_flags.txt` files to improve C/C++ IDE integration in projects that use Zig as their build system.

## Overview

`compile_flagz` enables better C/C++ development experience in projects that use Zig's build system by automatically generating `compile_flags.txt` files. This allows C/C++ language servers (like clangd) to understand your project's include paths, providing better code completion, error detection, and navigation when working on C/C++ code within Zig-built projects.

## Use Cases

- **C/C++ projects using Zig build**: Building traditional C/C++ applications or libraries with `build.zig` instead of Make/CMake
- **Mixed C/C++/Zig codebases**: Projects where you're writing both C/C++ and Zig code
- **C/C++ libraries with Zig tooling**: Leveraging Zig's excellent cross-compilation and dependency management for C/C++ development

## Installation

Add `compile_flagz` to your project:

```bash
zig fetch --save git+https://github.com/deevus/compile_flagz
```

This will automatically add the dependency to your `build.zig.zon` file.

## Usage

In your `build.zig`:

```zig
const compile_flagz = @import("compile_flagz");

pub fn build(b: *std.Build) void {
    // Your existing build configuration...
    
    // Create compile flags generator
    var cflags = compile_flagz.addCompileFlags(b);
    
    // Add include paths
    cflags.addIncludePath(b.path("include"));
    cflags.addIncludePath(dependency.builder.path("include"));
    
    // Create the build step
    const cflags_step = b.step("compile-flags", "Generate compile_flags.txt for C/C++ IDE support");
    cflags_step.dependOn(&cflags.step);
}
```

Generate the file:

```bash
zig build compile-flags
```

This creates a `compile_flags.txt` file with your include paths formatted for C/C++ language servers.

## Example

See the `example/` directory for a complete working project that demonstrates usage with SDL dependency.

## Building

Build the library:

```bash
zig build
```

## Documentation

Generate API documentation:

```bash
zig build docs
```

The generated documentation will be available in `zig-out/docs/`.

## Requirements

- Zig 0.14.1 or later

## License

MIT License - see [LICENSE](LICENSE) file for details.