Add support for CMake-presets. #1656

jehelset · 2021-03-07T13:56:29Z

Support configuring, building and testing CMake projects using cmake-presets.

Introduces projectile--cmake-command for CMake projects which computes a command based on the command-type. If CMake preset support is enabled through the projectile-enable-cmake-presets custom, and if presets are supported for the command-type by CMake, CMake preset-files are parsed and a completing-read is done on the names of the command presets along with an option for manual configuration. If not supported, or there are no presets specified for the given command-type, it reverts to manual configuration as before. Configure, build and test commands for CMake projects are all implemented in terms of this command.

To support presets the compilation-dir for CMake-projects was removed, and the manual commands were adjusted to support being run from the project-root.

Needs json-parse-buffer to be available, else falls back to manual configuration.

Tested manually with CMake 3.19 (presets supported), and 3.18 (not supported) only, and emacs 27.1 (json-parse-buffer available) and emacs 26.3 (json-parse-buffer unavailable). Not sure how to to project-type specific testing. Initially implemented at jehelset/projectile-cmake.

Before submitting a PR make sure the following things have been done (and denote this
by checking the relevant checkboxes):

The commits are consistent with our contribution guidelines
You've added tests (if possible) to cover your change(s)
All tests are passing (eldev test)
The new code is not generating bytecode or M-x checkdoc warnings
You've updated the changelog (if adding/changing user-visible functionality)
You've updated the readme (if adding/changing user-visible functionality)

Thanks!

jehelset · 2021-03-07T13:59:47Z

Not sure if this too much CMake for projectile. I guess this needs to check if json is available in a better way. Not quite sure what is the best method to do it.

jehelset · 2021-03-13T12:52:29Z

Ended up just relying on json-parse-buffer being available rather than trying to support older versions of emacs.

bbatsov · 2021-03-15T10:40:43Z

I'm okay with the proposed addition, but this has to be documented well if we expect people to make good use of it. I'm also wondering if there might be a case when someone would prefer the old behaviour (e.g. should we have a defcustom for it).

projectile.el

jehelset · 2021-03-15T16:12:59Z

I'm okay with the proposed addition, but this has to be documented well if we expect people to make good use of it. I'm also wondering if there might be a case when someone would prefer the old behaviour (e.g. should we have a defcustom for it).

Yes. Where do you want me to add the documentation? Somewhere under projects.adoc? Do you mean a defcustom for specifying the configuration-cmd (ie a projectile-cmake-project-configure-function), or one to toggle preset integration on and off?

jehelset · 2021-03-19T13:12:47Z

I tried adding a defcustom to opt-in to preset-configuration, as well as improving the docstrings and naming. It seems that the snapshot CI is failing due to some other long docstring.

jehelset · 2021-03-29T05:28:26Z

CMake just got support for build and test presets in 3.20 (https://cmake.org/cmake/help/latest/release/3.20.html#presets), do you mind if I add that also here?

bbatsov · 2021-03-29T06:04:17Z

Not at all.

On Mon, 29 Mar 2021 at 8:28, jehelset ***@***.***> wrote: CMake just got support for build and test presets in 3.20 ( https://cmake.org/cmake/help/latest/release/3.20.html#presets), do you mind if I add that also here? — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#1656 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAZLSRCS4KNCUJJ3DE37FTTGAMZTANCNFSM4YX4JR3Q> .

-- Best Regards, Bozhidar Batsov

jehelset · 2021-03-29T10:06:58Z

I will squash / tidy the commits afterwards. It seemed to mess with the change-requests. I tried adding preset-support for compile and test commands.

bbatsov · 2021-05-24T06:04:58Z

projectile.el

+;;;; Constant signifying opting out of CMake preset commands.
+(defconst projectile--cmake-no-preset "*no preset*")
+
+(defun projectile--cmake-version()


It's idiomatic to have a space between the function name and its param list.

bbatsov · 2021-05-24T06:05:29Z

projectile.el

+    '((:configure-command . (3 19))
+      (:compile-command . (3 20))
+      (:test-command . (3 20))))
+(defun projectile--cmake-command-presets-supported(command-type)


I normally add blank lines around function defs.

Btw, isn't it easier to just set 3.20 as the minimum version for everything instead of having it so granular?

Fixed the blank lines.

I think the combination of how nice presets are, and CMake often being installed via the system package manager on non-rolling distros justifies the level of granularity. The configuration-preset is by far the most valuable. See f.ex: https://packages.debian.org/sid/cmake (unstable is still on 3.18).

I can remove it if it's too much, but I would be hard pressed to make a choice between setting minimum version to 3.19 and dropping support for compile and test-commands or setting the minimum version to 3.20!

bbatsov · 2021-05-24T06:09:36Z

Where do you want me to add the documentation? Somewhere under projects.adoc?

Either there or under "Configuration".

Do you mean a defcustom for specifying the configuration-cmd (ie a projectile-cmake-project-configure-function), or one to toggle preset integration on and off?

I was thinking of something that toggles the new functionality globally. (mostly so people can easily opt out of it, if they run into any issues)

jehelset · 2021-05-24T08:50:16Z

Where do you want me to add the documentation? Somewhere under projects.adoc?

Either there or under "Configuration".

Do you mean a defcustom for specifying the configuration-cmd (ie a projectile-cmake-project-configure-function), or one to toggle preset integration on and off?

I was thinking of something that toggles the new functionality globally. (mostly so people can easily opt out of it, if they run into any issues)

I previously added the projectile-enable-cmake-presets defcustom, and set it to nil by default, so that users can opt-in instead for now.

bbatsov · 2021-05-24T09:49:47Z

CHANGELOG.md

 * Add `projectile-update-project-type-function` for updating the properties of existing project types
+* [#1656](https://github.com/bbatsov/projectile/pull/1656) Add support for CMake configure, build and test presets. Enabled by setting `projectile-cmake-presets` to non-nil, disabled by default.


You forgot : here.

bbatsov · 2021-05-24T09:49:57Z

CHANGELOG.md


 ### Changes

 * Add `project` param to `projectile-generate-process-name`.
 * [#1608](https://github.com/bbatsov/projectile/pull/1608): Use rebar3 build system by default for Erlang projects.
 * Rename `projectile-project-root-files-functions` to `projectile-project-root-functions`.
 * [#1647](https://github.com/bbatsov/projectile/issues/1647): Use "-B" in the mvn commands to avoid ANSI coloring clutter in the compile buffer
+* [#1656](https://github.com/bbatsov/projectile/pull/1656) CMake compilation-dir removed to accomodate preset support, commands adjusted to run from project-root, with "build" still being the default build-directory. The non-preset test-command now uses "cmake" with "--target test" instead of "ctest".


bbatsov · 2021-05-24T12:42:41Z

It seems you'll also have to rebase on top of master.

jehelset · 2021-05-24T13:28:25Z

Squashed and rebased.

bbatsov · 2021-05-24T13:30:05Z

Are you sure you rebased?

jehelset · 2021-05-24T13:31:49Z

Hm, I thought so.

jehelset · 2021-05-24T13:34:12Z

I fetched from wrong remote... Sorry, sec.

jehelset · 2021-05-24T13:38:27Z

There we go. :P

Introduce a `projectile--cmake-command`, for CMake projects parametrized on command-type, and route configure, build and test commands for cmake projects through this. This command ensures that presets for the given command-type is supported by the installed version of CMake, that `json-parse-buffer` is available, that the user has opted in to preset support through the `projectile-enable-cmake-presets` custom, and that there is at least one preset available for the given command type. If all these conditions hold it parses the preset files and prompts the user to select a preset, or to opt-out of preset configuration, and creates a manual or preset command based on the users selection. Else it will revert to manual configuration.

bbatsov · 2021-05-25T06:15:53Z

Thanks!

jehelset force-pushed the cmake-configure-presets branch 2 times, most recently from 277e1b7 to e5b77df Compare March 13, 2021 12:47

jehelset marked this pull request as ready for review March 13, 2021 12:49

bbatsov reviewed Mar 15, 2021

View reviewed changes

projectile.el Outdated Show resolved Hide resolved

bbatsov reviewed Mar 15, 2021

View reviewed changes

projectile.el Outdated Show resolved Hide resolved

jehelset force-pushed the cmake-configure-presets branch from e5b77df to 0e84a16 Compare March 15, 2021 15:46

jehelset requested a review from bbatsov March 21, 2021 09:19

jehelset force-pushed the cmake-configure-presets branch from 54f4de5 to 30a4a25 Compare March 30, 2021 23:59

jehelset force-pushed the cmake-configure-presets branch from 30a4a25 to b984a41 Compare April 11, 2021 12:23

jehelset force-pushed the cmake-configure-presets branch from b984a41 to a10be26 Compare May 4, 2021 15:28

bbatsov reviewed May 24, 2021

View reviewed changes

jehelset force-pushed the cmake-configure-presets branch from ec258d4 to 12cbaec Compare May 24, 2021 13:28

jehelset force-pushed the cmake-configure-presets branch from 12cbaec to 53a7100 Compare May 24, 2021 13:34

jehelset force-pushed the cmake-configure-presets branch from 53a7100 to dc09e10 Compare May 25, 2021 04:21

bbatsov merged commit e627bd7 into bbatsov:master May 25, 2021

jehelset deleted the cmake-configure-presets branch May 25, 2021 06:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for CMake-presets. #1656

Add support for CMake-presets. #1656

jehelset commented Mar 7, 2021 •

edited

Loading

jehelset commented Mar 7, 2021 •

edited

Loading

jehelset commented Mar 13, 2021

bbatsov commented Mar 15, 2021

jehelset commented Mar 15, 2021

jehelset commented Mar 19, 2021

jehelset commented Mar 29, 2021

bbatsov commented Mar 29, 2021 via email

jehelset commented Mar 29, 2021

bbatsov May 24, 2021

jehelset May 24, 2021

bbatsov May 24, 2021

bbatsov May 24, 2021

jehelset May 24, 2021 •

edited

Loading

bbatsov commented May 24, 2021

jehelset commented May 24, 2021

bbatsov May 24, 2021

jehelset May 24, 2021

bbatsov May 24, 2021

jehelset May 24, 2021

bbatsov commented May 24, 2021

jehelset commented May 24, 2021

bbatsov commented May 24, 2021

jehelset commented May 24, 2021

jehelset commented May 24, 2021

jehelset commented May 24, 2021

bbatsov commented May 25, 2021

		* Add `projectile-update-project-type-function` for updating the properties of existing project types
		* [#1656](https://github.com/bbatsov/projectile/pull/1656) Add support for CMake configure, build and test presets. Enabled by setting `projectile-cmake-presets` to non-nil, disabled by default.

Add support for CMake-presets. #1656

Add support for CMake-presets. #1656

Conversation

jehelset commented Mar 7, 2021 • edited Loading

jehelset commented Mar 7, 2021 • edited Loading

jehelset commented Mar 13, 2021

bbatsov commented Mar 15, 2021

jehelset commented Mar 15, 2021

jehelset commented Mar 19, 2021

jehelset commented Mar 29, 2021

bbatsov commented Mar 29, 2021 via email

jehelset commented Mar 29, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jehelset May 24, 2021 • edited Loading

Choose a reason for hiding this comment

bbatsov commented May 24, 2021

jehelset commented May 24, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bbatsov commented May 24, 2021

jehelset commented May 24, 2021

bbatsov commented May 24, 2021

jehelset commented May 24, 2021

jehelset commented May 24, 2021

jehelset commented May 24, 2021

bbatsov commented May 25, 2021

jehelset commented Mar 7, 2021 •

edited

Loading

jehelset commented Mar 7, 2021 •

edited

Loading

jehelset May 24, 2021 •

edited

Loading