CFiggers / juno

A simple CLI utility for creating new project scaffolds for Janet. Written in Janet. Inspired by neil.

juno

A simple CLI utility for creating new project scaffolds for Janet. Written in Janet. Inspired by neil.

Getting Started

Required: Janet.

1. Clone this repo.

   For e.g., using the GitHub CLI: $ gh repo clone CFiggers/juno

2. cd into the directory: $ cd juno

3. Run $ juno new hello-world

4. See a new directory folder created with the arg you passed to the new subcommand:

$ ls
... hello-world ...

Installing Script

1. Symlink the juno script in the project root onto your $PATH.

   For e.g., using ln: $ sudo ln -s /usr/bin/juno [path to juno project root]/juno

2. Use juno anywhere you want!

Compiling a Binary and Installing

Required: jpm.

1. In the juno repo, run jpm deps -l && jpm build -l.

2. See a new build directory folder:

$ ls
... build ...

3. Put or symlink the juno binary in build onto your $PATH. A common way to accomplish this is to put a new item in your ~/bin folder, which is probably already on your $PATH.

   For e.g., using ln to create a symlink: $ sudo ln -s /usr/bin/juno [path to juno project root]/build/juno

   Or using mv to actually relocate the binary: $ mv [path to juno project root]/build/juno /usr/bin/juno

4. Use juno anywhere you want!

Roadmap

TODO

• Improved license subcommand for adding/updating licenses based on Github's API
• User-defined templates and automated template adoption from existing directories
• Interactive collection of parameters if needed but not provided by option flags

DONE

• MVP (Creating projects with new, add a license with license, tell a joke with joke)
• Dynamic tweaks to templates based on flags (like --executable/-e to automatically include a (declare-executable) in project.janet but leave the rest of the template the same)
• Persistent user configuration of template defaults using juno config and related subcommands

Contributing

Issues, forks, and pull requests are welcome!

Prior Art

juno is by no means an original concept. Innumerable project scaffolding and management tools exist, written in a plethora of languages, for a plethora of target languages and frameworks.

Here are a few that already exist in Janet (alphabetical order):

• jeep
• newt
• michael
• jpm

Compared with these, the biggest difference with juno is the data-oriented approach to project templating. Also, the (planned) adopt command is distinct (to my knowledge, even among project scaffolding frameworks more broadly).

Copyright (c) 2023 Caleb Figgers