poac-dev / poac Goto Github PK

Poac (pronounced as /pəʊək/) is a package manager and build system for C++ users, inspired by Cargo for Rust. Poac is designed as a structure-oriented build system, which means that as long as you follow Poac's designated project structure, you almost do not need configurations, much less a language to build, unlike CMake. If you do not like writing a bunch of configurations to build your project, Poac might be best suited. Currently, the supported project structure can be known by looking at this repository since Poac can build itself.

Please visit poac.dev and Poac Docs for more details.

By using Poac, you can create a C++ project, build sources, and execute an application:

You can get started with just a few commands as the demo shows. Let's create a new Poac project:

you:~$ poac new hello_world
     Created binary (application) `hello_world` package

Now, you can use the poac run command to run your application:

you:~$ cd hello_world
you:~/hello_world$ poac run
 Compiling src/main.cc
   Linking hello_world
  Finished debug target(s) in 0.45386s
   Running poac-out/debug/hello_world
Hello, world!

Linux	macOS

Since packages through these providers may not be maintained by Poac owners, install them at your own risk.

It is important to verify the package name and copy it accurately to prevent typosquatting attacks. You can check the correct name by following the link in Packaging status (Repology).

brew install poac

Poac is available in the AUR thanks to the poac package.

It can be installed with the AUR helper of your choice.

paru -S poac

If your environment is not included in the released packages, you have to build Poac from the source. You will require the following compilers, commands, and libraries:

• GCC: 12 or later
• Clang: 15 or later
• Apple Clang: provided by macOS Monterey (12) or later

• GNU Make
• Git
• pkg-config
• find
• grep
• mkdir
• rm

• fmt: >=8.1.1 && <11
  • libfmt-dev on APT
  • fmt on Homebrew
• libgit2: >=1.1.0 && <2
  • libgit2-dev on APT
  • libgit2 on Homebrew
• libcurl: >=7.79.1 && <9
  • libcurl4-openssl-dev on APT
  • curl on Homebrew
• nlohmann_json: >=3.10.5 && <4
  • nlohmann-json3-dev on APT
  • nlohmann-json on Homebrew
• oneTBB: >=2021.5.0 && <2022
  • libtbb-dev on APT
  • tbb on Homebrew

When running Make, the following libraries will be installed automatically.

• toml11: v3.8.0

Once you have all the necessary requirements in place, you can build Poac by the following commands:

git clone https://github.com/poac-dev/poac.git
cd poac
make RELEASE=1 install

• C++ compiler
• GNU Make
• pkg-config
• mkdir
• printf
• cpplint (for poac lint)
• clang-format (for poac fmt)
• clang-tidy (for poac tidy)

The poac new command lets you start a new Poac project:

you:~$ poac new hello_world
     Created binary (application) `hello_world` package

you:~/your-pj$ poac init
     Created binary (application) `your-pj` package

In most cases, you want to execute the generated binary as well as build the project.

you:~/hello_world$ poac run
 Compiling src/main.cc
   Linking hello_world
  Finished debug target(s) in 0.45386s
   Running poac-out/debug/hello_world
Hello, world!

If you just want to build it, run the build command:

you:~/hello_world$ poac build
  Finished debug target(s) in 0.00866317s

Poac uses a cache since we executed the command with no changes.

export CXX=g++-13

Like Cargo does, Poac installs dependencies at build time. Poac currently supports Git and system dependencies. You can use the poac add command to add dependencies to your project.

The poac add command accepts the following arguments:

poac add <package names ....> --<options>

Options:

• --sys: Marks the packages as system dependency (requires the --version argument)
• --version: Specify dependency version. Only used with system dependencies
• --rev: Specify revision for git dependencies
• --tag: Specify tag for git dependencies
• --branch: Specify branch for git dependencies

Example

poac add libgit2 --sys --version "1.1.0"
poac add "ToruNiina/toml11" --rev "846abd9a49082fe51440aa07005c360f13a67bbf"

If tag, branch, or rev is unspecified for git dependencies, Poac will use the latest revision of the default branch. System dependency names must be acceptable by pkg-config. The version requirement syntax is specified in src/VersionReq.hpp.

After adding dependencies, executing the build command will install the package and its dependencies.

you:~/hello_world$ poac build
Downloaded ToruNiina/toml11 846abd9a49082fe51440aa07005c360f13a67bbf
 Compiling src/main.cc
   Linking hello_world
  Finished debug target(s) in 0.70s

You can write unit tests in any source files within the src directory. Create a new file like:

src/Lib.cc

int add(int a, int b) {
  return a + b;
}

#ifdef POAC_TEST

#  include <cassert>

int main() {
  assert(add(1, 2) == 3);  // ok
  assert(add(1, 2) == 4);  // fail
}

#endif

Now, with the test command, you can run tests defined within POAC_TEST:

you:~/hello_world$ poac test
 Compiling src/Lib.cc
   Linking tests/test_Lib
   Testing Lib
Assertion failed: (add(1, 2) == 4), function main, file Lib.cc, line 13.
make: *** [test] Abort trap: 6

Unit tests with the POAC_TEST macro are useful when testing private functions. Integration testing with the tests directory has not yet been implemented.

Linting source code is essential to protect its quality. Poac supports linting your project by the lint command:

you:~/hello_world$ poac lint
   Linting hello_world
src/main.cc:0:  No copyright message found.  You should have a line: "Copyright [year] <Copyright Owner>"  [legal/copyright] [5]
Done processing src/main.cc
Total errors found: 1
Error: `cpplint` exited with status 1

pip install cpplint

The lint command works without configurations, and Poac would automatically opt out of unwanted lints by adjusting to each project. To customize the lint settings, try adding the [lint.cpplint] key in your poac.toml like this or creating a CPPLINT.cfg file in the repository root.

Poac also supports formatting your source code with clang-format. Ensure having installed clang-format before running this command.

you:~/hello_world$ poac fmt
  Formatting hello_world

$ # We need to avoid the `build` dir and such dirs ...
$ clang-format ./src/*.cpp -i
$ clang-format ./include/**/*.hpp -i
$ clang-format ./tests/**/*.cpp -i
$ ...

To customize the format settings, try creating a .clang-format file to the repository root.

Poac also supports running clang-tidy on your source code. Ensure having installed clang-tidy before running this command.

you:~/hello_world$ poac tidy
  Running clang-tidy

You can customize the tidy settings by creating a .clang-tidy file to the repository root.

C++ is often considered a complex language and unconsciously avoided by many. The absence of a definitive package manager and the unfamiliar syntax of build systems like CMake make it seem difficult to set up a C++ environment, leaving people hesitant.

To simplify the process and allow users to develop applications and libraries without worrying about CMake, I created a package manager and build system with an intuitive interface, similar to Cargo. This allows developers to focus on learning C++ without any hindrances. Additionally, I aim to integrate with other build systems and package managers, providing a seamless transition between development environments.

Poac is originated from cpp but designed to prioritize ease of typing and reduce strain on one hand as it will be frequently used as a command. Its name is ergonomically optimized to prevent the development of tenosynovitis.

Despite C++ often being overlooked for product development, I believe that Poac can help to promote it as a fun language. Amemiya and Mizutani argue that the sound of /p/ is associated with a bright and soft impression among Japanese consonants (157)¹. In the same way, I believe that Poac's name can convey a similarly positive impression.

Please make sure to follow these steps:

poac lint --exclude srcOld --exclude testsOld

poac fmt

poac test  # or make test

poac tidy  # or make tidy

This project exists thanks to all the people who contribute.

Poac is licensed under the terms of the Apache License version 2.0.

Please see LICENSE for details.

• toml11 - https://github.com/ToruNiina/toml11/blob/master/LICENSE