Add support for bazel #56
Conversation
Bazel support for the magic_enum repository would help others using bazel integrate this library into their projects. This PR adds a BUILD file which enables magic_enum to be imported seamlessly into other WORKSPACE files without having to write a custom BUILD file. It also adds bazel binaries & tests to enable running them via bazel locally: export CC=clang ; bazel build //... ; bazel test //... ; bazel run //:example Finally, bazel compilation artifacts are added to the gitignore file.
BUILD.bazel
Outdated
| cc_library( | ||
| name = "magic_enum", | ||
| hdrs = ["include/magic_enum.hpp"], | ||
| strip_include_prefix = "include", |
There was a problem hiding this comment.
Have you tested actually consuming this as an external dependency? I ask because IIRC strip_include_prefix doesn’t work in that case because there will be an extra external/ to contend with. I have not tested that your change doesn’t work, but the below modification definitely does.
| strip_include_prefix = "include", | |
| includes = ["include"], |
There was a problem hiding this comment.
Yes, that's much nicer. Thanks for the suggestion, done.
.gitignore
Outdated
| @@ -48,3 +48,6 @@ install_manifest.txt | |||
| compile_commands.json | |||
| CTestTestfile.cmake | |||
| _deps | |||
|
|
|||
| ### Bazel build artifacts ### | |||
| bazel-* | |||
There was a problem hiding this comment.
[Nit] This will ignore bazel-* in all directories, but you actually only care about the symlinks created at the root of the repo.
| bazel-* | |
| /bazel-* |
There was a problem hiding this comment.
Good point, thanks.
| @@ -0,0 +1,56 @@ | |||
| licenses(["notice"]) | |||
|
|
|||
| exports_files(["LICENSE"]) | |||
There was a problem hiding this comment.
AFAIK bazel only has plans to support license files as part of the build, but since the repo provides it I am following (what I believe to be) an accepted convention of exporting it.
GoogleTest does this, for instance.
README.md
Outdated
| @@ -219,6 +219,17 @@ CPMAddPackage( | |||
| ) | |||
| ``` | |||
|
|
|||
| Bazel is also supported, simply add to your WORKSPACE file: | |||
| ``` | |||
| git_repository( | |||
There was a problem hiding this comment.
http_archive is preferred so I would use that as the example.
There was a problem hiding this comment.
Thanks for the suggestion, done.
README.md
Outdated
| ) | ||
| ``` | ||
| To use bazel inside the repository it's possible to do: | ||
| `export CC=clang ; bazel build //... ; bazel test //... ; bazel run //:example` |
There was a problem hiding this comment.
Specifying clang is confusing, since right below it says that multiple compilers are supported.
There was a problem hiding this comment.
I updated the comment, please let me know what you think.
I initially ran into an issue because the system-default compiler is not supported, but you're right that any supported can be used.
|
@HackAttack thanks for the review, please take another look when you get a chance. |
|
@FelixDuvalletKodiak Thank for your pr. Let's wait for a review from @HackAttack , because I myself do not use bazel. |
|
@HackAttack friendly ping, are there further improvements we can make to this PR before merging it? |
|
@FelixDuvalletKodiak @HackAttack thanks! |
Bazel support for the magic_enum repository would help others using
bazel integrate this library into their projects.
This PR adds a BUILD file which enables magic_enum to be imported
seamlessly into other WORKSPACE files without having to write a custom
BUILD file.
It also adds bazel binaries & tests to enable running them via bazel
locally:
Finally, bazel compilation artifacts are added to the gitignore file.