Merge pull request from Radvendii/welcomeText

add descriptive output when creating templates
This commit is contained in:
Eelco Dolstra 2022-02-17 21:06:10 +01:00 committed by GitHub
commit a768e85e2f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 0 deletions

View file

@ -37,6 +37,10 @@ A flake can declare templates through its `templates` and
* `path`: The path of the directory to be copied.
* `welcomeText`: A block of markdown text to display when a user initializes a
new flake based on this template.
Here is an example:
```
@ -45,6 +49,16 @@ outputs = { self }: {
templates.rust = {
path = ./rust;
description = "A simple Rust/Cargo project";
welcomeText = ''
# Simple Rust/Cargo Template
## Intended usage
The intended usage of this flake is...
## More info
- [Rust language](https://www.rust-lang.org/)
- [Rust on the NixOS Wiki](https://nixos.wiki/wiki/Rust)
- ...
'';
};
templates.defaultTemplate = self.templates.rust;

View file

@ -13,6 +13,7 @@
#include "registry.hh"
#include "json.hh"
#include "eval-cache.hh"
#include "markdown.hh"
#include <nlohmann/json.hpp>
#include <queue>
@ -731,6 +732,7 @@ struct CmdFlakeInitCommon : virtual Args, EvalCommand
else
throw Error("file '%s' has unsupported type", from2);
files.push_back(to2);
notice("wrote: %s", to2);
}
};
@ -741,6 +743,11 @@ struct CmdFlakeInitCommon : virtual Args, EvalCommand
for (auto & s : files) args.push_back(s);
runProgram("git", true, args);
}
auto welcomeText = cursor->maybeGetAttr("welcomeText");
if (welcomeText) {
notice("\n");
notice(renderMarkdownToTerminal(welcomeText->getString()));
}
}
};