CRISPR
π§¬
crispr is a CLI tool allowing to scaffold a project from a template with a .crispr.{toml,json} configuration file.
The template uses tokens that need to be replaced per scaffolded project (e.g. {{REPO_NAME}}), which are set in the configuration file as either user replaceable or with predetermined values.
crispr reads the configuration, asks the user for any needed values and makes the replacements as needed, showing a diff in the process.
crispr respects .gitignore files and only changes files that should be committed.
The .crispr.{toml,json} configuration file itself is automatically ignored when replacing tokens.
Name
Named after the CRISPR-cas9 genetic engineering technique used for targeted gene editing
Supported Platforms
crispr is currently built for and tested on the following platforms:
x86_64-apple-darwin(Intel macOS)
Install
Homebrew
brew install yoav-lavi/tap/crispr
Binary
Binaries can be downloaded from the releases page
Usage
crispr [FLAGS] [PATH]
Arguments
<PATH>The path to runcrispr('.'by default)
Flags
-
-c, --configThe path to an alternative configuration file ('.crispr.{toml,json}'by default) -
-d, --dryDry run - prints output without making changes -
-h, --helpPrints help information -
-V, --versionPrints version information
Configuration File
crispr uses a TOML or JSON configuration file detailing the tokens to be replaced.
In case both file types are found, the priority is as follows:
.crispr.toml.crispr.json
Fields
replacements- a map (Option<HashMap<String, String>>) of replacement tokens to valuesuser_replacements- an array (Option<Vec<String>>) of replacements for which the user will be asked to supply a value
Example
.crispr.toml
user_replacements = [
"{{REPO_NAME}}"
]
[replacements]
"{{YEAR}}" = "2021"
.crispr.json
{
"replacements": {
"{{YEAR}}": "2021"
},
"userReplacements": ["{{REPO_NAME}}"]
}
Limitations
crisprreads files line-by-line, so a token broken into multiple lines (e.g. by formatting) will not be replaced
Prior Art
crisprtakes some inspiration and ideas from Ruplacer but does not intend to replace (pun may be intended) Ruplacer as the use case and goal are different.
Acknowledgements
crispr uses the following dependencies:
clap(Apache 2.0)difference(MIT)colored(MPL)ignore(MIT)serde(Apache 2.0)serde_json(Apache 2.0)toml(MIT)
538 Dec 5, 2022
223 Dec 30, 2022
23 Jan 5, 2023
12 Jun 22, 2022
77 Dec 13, 2022
33 Sep 25, 2022
16 Feb 13, 2022
27 Sep 26, 2022
34 Nov 13, 2022
255 Dec 20, 2022
657 Dec 30, 2022
11 Jan 12, 2022
18 May 22, 2022
32 Dec 6, 2022
15 Dec 4, 2022
34 Dec 27, 2022
26 Nov 22, 2022
39 May 8, 2021
87 Oct 9, 2022
23 Apr 21, 2022
4 Aug 4, 2022
566 Apr 16, 2023
198 Dec 30, 2022
87 Oct 9, 2022
25 Jul 24, 2022
406 Dec 22, 2022
47 Dec 15, 2022
33 Aug 20, 2022
756 Dec 30, 2022