README.md (c610364) - testcode.git · David Blume's GitList

README.md

# testcode

This is just a test project. You can do anything here, test g++, make, cmake,
git, cscope, and IDE projects.

## Getting the project

You can get a copy of this project by clicking on the
[ZIP](https://git.dlma.com/testcode.git/zipball/main)
or [TAR](https://git.dlma.com/testcode.git/tarball/main) buttons
near the top right of the GitList web page.

You can clone from the origin with:

git clone ssh://USERNAME@dlma.com/~/git/testcode.git

## IDEs

### tmux vim entr

Create two panes in tmux, run vim in one, and run entr in the other. You probably
only need the `git ls-files` for `entr`, but I provide a bash command group with
`find` here so I can easily copy and change it as needed.

{ git ls-files && find . -type f -regex '.*\.$cfg\|local$'; } | \
    entr -c sh -c 'ctags -R *; make -j$(nproc) && \
    valgrind -q --leak-check=yes --show-leak-kinds=all product/testcode'

`find` could also have been `find . -type f $ -name \*.cfg -or -name \*.local $`.

To compile with debug info and run in gdb:

... | entr -c sh -c 'ctags -R *; make debug -j$(nproc) && gdb product/testcode'

Tip: In vim you can grep and use the QuickFix window with commands like...

:grep -rI --exclude=tags --exclude=cscope.* --exclude-dir=obj searchterm .
    :cw

See [this QuickFix tip for sorting results by filename](https://git.dlma.com/dotfiles.git/commit/0cb566c53caf931c8b3f423dcfded4660b220cbb).

#### entr One-Liner for When no Makefile

[This entr command is handy](https://twitter.com/dblume/status/1421011043489255424) when composing interview questions without a Makefile:

ls -1 *.h *.cpp | entr sh -c 'g++ -Wall -std=c++17 -pthread *.cpp && \
    valgrind -q --leak-check=yes --show-leak-kinds=all ./a.out'

### Visual Studio Code and WSL2

Once you've got the [Remote -WSL extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl)
for WSL, you can invoke Code from the WSL side.

code .

Or, if it's not in your path, something like...

/mnt/c/Users/$USER/AppData/Local/Programs/Microsoft\ VS\ Code/bin/code .

### Other IDEs

Look for the presence of their project files. They should work normally.

## Formatting

Use clang-format. Install the distro's version with:

sudo apt install clang-format

Or install a newer one with:

pipx install clang-format

And move $HOME/.local/bin ahead of /usr/bin in your $PATH.

Then, after making your edits, use the [vim integration](https://clang.llvm.org/docs/ClangFormat.html#vim-integration)
or manually format in one of a couple of ways:

### Option 1: Use git clang-format to format your staged changes

**NOTE** git-clang-format only formats your changes. Often it's better to
always format the whole document.

`git-clang-format` is installed with clang-format and will format staged files
into the unstaged area. Use it like this:

1. Stage the files you want to format.
2. Run `git clang-format`, and it'll leave unstaged formatting changes.
3. Review with `git difftool` and accept the desired changes or unstage.

### Option 2: Manually clang-format the staged files

The following formats the staged files, not only your staged changes:

git status --porcelain | \
    awk '/^[MTARC].+\.([hc](pp)?)"?$/ {$1=""; $0=$0; $1=$1; print}' | \
    xargs clang-format -i

Or a similar approach but it'll also overwrite your unstaged changes too:

git ls-files -m | \
    grep -E ".[ch](pp)?$" | tr "\n" "\0" | \
    xargs -0 clang-format -i

## Current Features

* Multiple directories for testing build systems and IDEs
* "make" essentially works.

## Is it any good?

[Yes](https://news.ycombinator.com/item?id=3067434).

## To Do

* Compare make vs. cmake vs. autotools
* Experiment with ctags generation

testcode.git

Distinguish "git clang-format" from "clang-format"