vmchale / project-init Goto Github PK

Project templates in rust

License: BSD 3-Clause "New" or "Revised" License

Rust 82.01% Nix 0.85% Python 0.72% Haskell 6.80% Idris 1.24% Julia 0.21% PowerShell 0.88% Shell 4.44% HTML 0.41% PureScript 1.62% ATS 0.08% Dhall 0.75%

rust cookiecutter mustache template-project haskell idris elm elm-lang miso command-line-tool

project-init's Introduction

project init (pi)

pi is a command-line utility to initialize projects. It is written in rust.

It is intended to provide something like cookiecutter, but faster.

Reasons to use pi:

You want to automate the process of starting a new project, for all your projects.
You want project initialization that's quick

Reasons to use pi over cookiecutter:

Templates are smaller. Define files you need in a .toml.
Fast. pi is 30x faster than cookiecutter when rendering the sample vim plugin template.
pi uses mustache, a logic-less language, for templates.
pi can initialize a darcs, pijul, mercurial, or git repository inside your projects
pi provides opinionated templates for many languages
pi is extensible in Rust

Reasons to not use pi over cookiecutter:

cookiecutter uses jinja templates, which are far more sophisticated.
pi is newer and presumably more buggy
cookiecutter is extensible in Python

Benchmarks (with Haskell's bench):

Tool	Language	Time (vim example plugin)	Time (rust library)
pi init	rust	10.10 ms	8.809 ms
pi new	rust	6.672 ms	8.653 ms
cookiecutter	python	317.1 ms	316.9 ms

Installation

Script

Enter the following in a command prompt:

curl -LSfs https://japaric.github.io/trust/install.sh | sh -s -- --git vmchale/project-init

Binary releases

The easiest way for most users is simply to download the prebuilt binaries. You can find binaries for various platforms on the release page.

Cargo

First, install cargo. Then:

 $ cargo install project_init

You will need to use the nightly release for this to work; if in doubt run

rustup run nightly cargo install project_init

Use

pi reads from $HOME/.pi_templates/ and your current directory. So, if you place a template in the $HOME/.pi_templates/idris/, you can initialize a project anywhere with

 $ pi init idris treesod

There is a repo containing pi templates here.

You can also use pi with built-in templates, viz.

 $ pi new haskell really-good-project
Finished initializing project in really-good-project/

Or to fetch a template from github:

 $ pi git vmchale/haskell-ats ambitious-insane-project

Examples

haskell-ats - a template for Haskell/ATS polyglot projects.
madlang-miso - a template for frontend using Miso and Madlang.
ats-makefile - a template for ATS projects that uses a plain Makefile.

Configuration

Global configuration is via the $HOME/.pi.toml file. The following is an example:

license = "BSD3"         # set default license to BSD3 
version_control = "git"  # initialize new repositories with git
version = "0.1.0"        # start new projects at version 0.1.0

[author]
name = "Vanessa McHale"
email = "[email protected]"
github_username = "vmchale"

# put any custom keys you want under a [[user]] table
[[user]]
website = "https://vmchale.com"

Project-specific config lives in $PROJECT_NAME/template.toml. The following is an example for a vim plugin:

license = "BSD3"        # overrides global value if set
with_readme = true      # add README.md

[files]
files = ["syntax/{{ project }}.vim","plugin/{{ project }}.vim","doc/{{ project }}.txt"] # blank files
directories = ["doc","syntax","plugin"]
templates = ["vimball.txt"] # files to be processed

[config]
version = "0.1.0"
version_control = "darcs"

# put any custom keys you want below [[user]]
[[user]]
vim_org_username = "vmchale"

This will generate the following directory structure:

vim-plugin
├── LICENSE
├── README.md
├── doc
│  └── vim-plugin.txt
├── plugin
│  └── vim-plugin.vim
├── syntax
│  └── vim-plugin.vim
└── vimball.txt

For a more in-depth example, see here. This is a template based off the recursion schemes generator.

Templates

pi uses mustache for templating, via the rustache crate.

You can find examples and help on the mustache page, or you can my look at the example repo.

project-init's People

Contributors

Stargazers

Watchers

Forkers

musoke vertexcite rusterize sanga dendisuhubdy leonistor 5l1v3r1 harrisin2037 legion-labs doytsujin jattenberg iq-scm de-vri-es

project-init's Issues

Failed to install from cargo, "cannot find macro 'eprintln!'"

Just tried to install project-init from cargo using cargo install project_init. That gave me the following error once it wen't to compile project_init v2.0.6

error: cannot find macro `eprintln!` in this scope
  --> .cargo/registry/src/github.com-1ecc6299db9ec823/project_init-2.0.6/src/repo.rs:17:9
   |
17 |         eprintln!("{}, git failed to initialize. Is git on your path?","Error".red());
   |         ^^^^^^^^
   |
   = help: did you mean `println!`?

error: cannot find macro `eprintln!` in this scope
  --> .cargo/registry/src/github.com-1ecc6299db9ec823/project_init-2.0.6/src/repo.rs:34:9
   |
34 |         eprintln!("{}, Mercurial failed to initialize. Is hg on your path?","Error".red());
   |         ^^^^^^^^
   |
   = help: did you mean `println!`?

error: cannot find macro `eprintln!` in this scope
   --> .cargo/registry/src/github.com-1ecc6299db9ec823/project_init-2.0.6/src/render.rs:161:25
    |
161 |                         eprintln!("Failed to open file: {:?}", p);
    |                         ^^^^^^^^
    |
    = help: did you mean `println!`?

error: cannot find macro `eprintln!` in this scope
   --> .cargo/registry/src/github.com-1ecc6299db9ec823/project_init-2.0.6/src/render.rs:199:21
    |
199 |                     eprintln!("Failed to create file: {:?}. Check that the directory is included in your template.toml", path);
    |                     ^^^^^^^^
    |
    = help: did you mean `println!`?

error: cannot find macro `eprintln!` in this scope
   --> .cargo/registry/src/github.com-1ecc6299db9ec823/project_init-2.0.6/src/render.rs:257:9
    |
257 |         eprintln!("Failed to create file: {:?}. Check that the directory is included in your template.toml", p);
    |         ^^^^^^^^
    |
    = help: did you mean `println!`?

error: cannot find macro `eprintln!` in this scope
  --> .cargo/registry/src/github.com-1ecc6299db9ec823/project_init-2.0.6/src/lib.rs:81:9
   |
81 |         eprintln!("{}: No ~/.pi.toml found. Using defaults.", "Warning".yellow());
   |         ^^^^^^^^
   |
   = help: did you mean `println!`?

error: aborting due to 6 previous errors

error: failed to compile `project_init v2.0.6`, intermediate artifacts can be found at `/tmp/cargo-install.5YdRpzeR0TA5`

Caused by:
  Could not compile `project_init`.

To learn more, run the command again with --verbose.

Preserve file permissions

Again, not sure if this is a bug or feature request.

I have a template that contains a shell script with execute permission, which doesn't seem to be preserved when I run pi init. Is this intended?

How may I copy a file with its contents without processing the contents using Mustache?

I have a LaTeX file, {{ project }}.md/scriv-pmarkdown.latex.

It contains content with {{ and }} as part of the normal LaTeX.
If I add the file to the templates block in template.toml then the LaTeX is altered and broken on init of a new project from the template.

If I add the file to the files block then the file is added empty on init of a new project from the template.

If I alter the delimiters used by Mustache (see Set Delimiter) in the scriv-pmarkdown.latex file as follows and then put the file in the templates block:

Add to the top of the file.

%{{=<% %>=}}

Add to the bottom of the file.

%<%={{ }}=%>

The change in delimiters is ignored and so the file is broken.

Is there are way to copy the contents of the file without parsing with Mustache?

panic on empty .pi.toml

At least I'm guessing this is related to the fact that my .pi.toml is empty.

Against v 2.9.7

RUST_BACKTRACE=1 pi l                                                                                                        

thread 'main' panicked at 'assertion failed: `(left == right)`
  left: `Some(69)`,
 right: `Some(10)`', /home/tsampson/.cargo/registry/src/github.com-1ecc6299db9ec823/project_init-2.9.7/src/main.rs:70:26
stack backtrace:
   0: std::sys::imp::backtrace::tracing::imp::unwind_backtrace
             at /checkout/src/libstd/sys/unix/backtrace/tracing/gcc_s.rs:49
   1: std::panicking::default_hook::{{closure}}
             at /checkout/src/libstd/sys_common/backtrace.rs:71
             at /checkout/src/libstd/sys_common/backtrace.rs:60
             at /checkout/src/libstd/panicking.rs:381
   2: std::panicking::rust_panic_with_hook
             at /checkout/src/libstd/panicking.rs:397
             at /checkout/src/libstd/panicking.rs:577
   3: std::panicking::begin_panic
             at /checkout/src/libstd/panicking.rs:538
   4: std::panicking::begin_panic_fmt
             at /checkout/src/libstd/panicking.rs:522
   5: pi::main
   6: main
   7: __libc_start_main
   8: _start

First run experience might be improved

e.g.

pi l                                                                                                                            
File "/home/tsampson/.pi.toml" could not be opened. Check that it exists.

I'm not sure what might be better here. Create one on first run? Through a wizard (if you want to go that far). Some of the values can probably be inferred from other places (.gitconfig if it exists for example, possible env vars). But maybe there's a simple way to improve this a bit too.

Feature Request: Specifying custom keys on command line

Hi,

thanks for this project!

Would it be possible to specify custom keys as additional arguments to the init subcommand?

For example:

pi init my_library_template awesome_library  group=com.example.libs

This would overwrite the custom key in the template.toml:

[[user]]
group="com.another"

Fix name

This is a small bug, and maybe you'll just want to close it, but the name is all wrong. It's clear to me this project should have been named "Magnum P.I."

Then again, maybe I can think of some project that would use that name... >.>

"list" subcommand to list availables templates?

Seems to me like such a feature would be useful.

Benchmark unit

Hi,
I think you meant µs and not ms in the table of the readme file :)

Include dotfiles in initial commit

I'm not sure if this is a feature request or a bug report.

I have a custom template that is a git repository containing a .gitignore. When I run pi init template directory, all the files other than .gitignore are staged. It would be nice if it was included.

The template is here in case this is an error on my part: https://github.com/musoke/tex-template/tree/1dc2c994b69d43517136f277b9be7f6b38f0c864

make it a library?

I want to use it from another crate I am working on (which will setup a project and offer some project specific command line utilities). Currently I have dependency on python just for cookie-cutter support, would be good to use this as a library.