Spark: A TOML based project initializer.

Spark is a TOML-based project initializer that helps you quickly set up project directories and files according to predefined templates. It's designed for developers who want to streamline their workflow by automating the creation of consistent project structures.

Template-based, with easy TOML support!

Warning

This repo was named "idkmng" before, some issues will contain the previous name.

Idea 🧠:

Creating a project often involves setting up specific files with unique formats. For instance, a browser extension requires files like:

manifest.json
Content.js
etc..

Each file has its own structure and syntax. With spark, you can effortlessly initialize projects with the required files and configurations using a simple command, regardless of the specific format needed.

For example, to set up a browser extension project, you can run:

$ spark browser_extension

and 💥 your project files will be ready for your initial commit. Isn’t that amazing?

spark is template-based, allowing you to define multiple templates for the same type of project. This means you can customize the initialization process to suit different requirements, such as variations in manifest.json or other project-specific files.

Installation

If you have Rust 🦀 🚀 installed on your machine run the following command:

$ cargo install --git https://www.github.com/pwnxpl0it/spark

Alternatively you can go to Releases and download the binary

$ sudo tar -xzf spark-<RELEASE>.tar.gz -C /usr/local/bin

Replace with the version number or tag of the release you want to install.

now you should be able to run spark in your terminal!

Creating a template 📜

There is a template for creating a template! just run the following command!

$ spark new

enter template name and you should have one, it will go inside ~/.config/spark/templates/TEMPLATENAME.toml also you can edit that Template too to create you own template that creates a template 🎉,

Default templates path is ~/.config/spark/templates

The template structure is like the following:

[info]
name = ""
description = ""
author = ""

[[files]] # file1 
path="/path/to/file1"
content="""

Content of file 1

"""

[[files]] # file2
path="/path/to/file2"
content="""

Content of file 2

"""

#etc...

Tip

Info section is not required and can be removed

placeholders have a generic format of {{$keyword}}

Here is a table of default placeholders and their values:

Keyword/placeholder	Value	Example
PROJECTNAME	Asks for project name
CURRENTDIR	Current directory	pwd=/foo/bar => `bar`
HOME	Home directory	`/home/user/`
YYYY	Current Year in YYYY format	2024
YY	Current Year in YY format	24
MM	Current Month	2
DD	Current Day	24
NOW	Current date and time	`2024-02-23 22:22:38.151417626 +00:00`
NOW_UTC	Current date and time in UTC	`2024-02-23 22:21:17.897444668 UTC`

Functions

you can enhance the functionality of your templates by calling function that can perform actions on the placeholder name/value, like prompting for user input or retrieving values from environment variables, etc.., These placeholders follow the format {{$keyword:function}}

Example:

# --snip
content="""
{{$TEST:read}}
"""

Functions supported by spark:

Function	Description	Example
read	Asks for user input to replace placeholder with	`{{$TEST:read}}`
env	Replace with value from environment variables	`{{$PATH:env}}`

also keep in mind that once a function gets called on a keyword you can use {{$TEST:read}} or {{$TEST}} both are going to be replaced with the value that the function returned.

Template Options

Template options in spark provide a way to customize the project setup by allowing predefined variables or settings within the template. These options are defined in the TOML configuration file of the template and can control various aspects of the template generation process.

Right now it's only for git support, but more options will be added later.

Git Support 🐙

Initialize Git during project creation by using:

$ spark /path/to/template --git

Or include Git option in the template itself:

[options]
git=true
project_root="{{$PROJECTNAME}}" # will prompt for the project name but you can set this to constant value

Example Templates

Here are a few examples:

Neovim Plugin [Click to expand]

[info]
name = "Neovim Plugin"
description = "A template for nvim plugin"
author = "Mohamed Tarek @pwnxpl0it"

[[files]]
path="{{$PROJECTNAME}}/lua/{{$PROJECTNAME}}/init.lua"
content="""
local M = {}

M.config = {}

M.setup = function ()
   if config ~= nil then
        M.config = config
    end

end

return M
"""

[[files]]
path="{{$PROJECTNAME}}/plugin/init.lua"
content="""
require("{{$PROJECTNAME}}")
"""

Jekyll new blogpost [Click to expand]

I use this template to create a new post in my blog directly from CLI,This one here uses more keywords and includes a private BLOGPATH placeholder that it's value is loaded from config file.

[info]
name = "new_post"
description = "New jekyll post"
author = "Mohamed Tarek @pwnxpl0it"

[[files]]
path="{{$BLOGPATH}}/_posts/{{$YYYY}}-{{$MM}}-{{$DD}}-{{$blogtitle:read}}.markdown"
content="""
---
layout: post
title: "{{$blogtitle}}"
date: {{$NOW_UTC}}
tags: {{$Tags:read}}
---

"""

Browser (Chrome) Extension [Click to expand]

This one is just for creating a really BASIC chrome extension.

[info] # Generated using `spark new` btw
name = "browser_extension"
description = "A Template for creating a browser extension"
author = "Mohamed Tarek @pwnxpl0it"
refrence= "https://developer.chrome.com/docs/extensions/mv3/manifest/"

[[files]]
path="{{$PROJECTNAME}}/manifest.json"
content="""
{
  "manifest_version": 3,
  "name":"{{$PROJECTNAME}}",
  "version": "1.0.1",
  "content_scripts":[
    {
     "matches":["<all_urls>"],
     "js":["content.js"]
    }
  ]
}
"""

[[files]]
path="{{$PROJECTNAME}}/content.js"
content="""
console.log("Hello world!")
"""

Info section can have any additional values, it won't get printed but maybe usefull when sharing the template or just as a reference for docs like I did here

Loading values from json

You can use json to replace placeholders in your template, spark will automatically load values from a json file and replace them automatically

spark uses JSON Query language to load values from json nodes.

This is made possible using Rust's jq-rs crate 🦀 which has bindings to libjq.

Here is an example:

{
	"user": {
		"id": "12345",
		"name": "John Doe",
		"email": "john.doe@example.com"
	},
	"status": ["200 OK"]
}

example template:

[[files]]
path="test"
content="""
User ID: {{$.user.id}}
User Name: {{$.user.name}}
User Email: {{$.user.email}}
Response Status: {{$.status[0]}}
"""

$ spark template --json test.json

Output:

$ cat test

User ID: 12345
User Name: John Doe
User Email: john.doe@example.com
Response Status: 200 OK

Note

Although this is a cool feature to automate user inputs, It comes with performance costs Why?

Liquid Templating Support 🧪

spark now supports Liquid templating alongside its own custom syntax. This allows you to benefit from Liquid's logic (loops, conditionals) while continuing to use spark's powerful keyword replacement.

Example:

[[files]]
path = "output.txt"
content = """
{% for i in (1..5) %}
Example! {{ i }} {{ "{{$file:read}}" | append: ".html" }}
{% endfor %}
"""

spark replaces {{$file:read}} with user input.
Liquid handles loops and string manipulation.

Result:

Example! 1 ff.html
Example! 2 ff.html
Example! 3 ff.html
Example! 4 ff.html
Example! 5 ff.html

With this integration, you can create dynamic and flexible templates that combine the strengths of both spark and Liquid.

Automated Template generation 🚀

Also there is one more time saving way! if you have some files in /foo/bar/ you can just run spark init and it will create a template for you with directory name bar.toml and it will have all your files in it! 🌸

$ tree
.
├── lua
│   └── test123
│       └── init.lua
└── plugin
    └── init.lua

4 directories, 2 files

$ spark init
Creating Template: test123.toml

$ cat test123.toml

[[files]]
path = 'plugin/init.lua'
content = '''
require("test123")
'''

[[files]]
path = 'lua/test123/init.lua'
content = '''
local M = {}

M.config = {}

M.setup = function ()
   if config ~= nil then
        M.config = config
    end

end

return M
'''

Config Keywords ⚙️

You can have your own Keywords for spark to replace with desired values! Spark finds them stored in $HOME/.config/spark/config.toml Or the config path you specified using -c/--config option 🦀

[Keywords]
AUTHOR = "Mohamed Tarek"
USERNAME = "@pwnxpl0it"
GITHUB = "https://github.com/pwnxpl0it"
#etc .....

👾 Neovim plugin (spark.nvim)

I wrote a neovim plugin that makes it a way easier, Check it out spark.nvim.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Spark: A TOML based project initializer.

Table of Contents

Idea 🧠:

Installation

Creating a template 📜

Functions

Template Options

Git Support 🐙

Example Templates

Loading values from json

Liquid Templating Support 🧪

Example:

Result:

Automated Template generation 🚀

Config Keywords ⚙️

👾 Neovim plugin (spark.nvim)

Files

README.md

Latest commit

History

README.md

File metadata and controls

Spark: A TOML based project initializer.

Table of Contents

Idea 🧠:

Installation

Creating a template 📜

Functions

Template Options

Git Support 🐙

Example Templates

Loading values from json

Liquid Templating Support 🧪

Example:

Result:

Automated Template generation 🚀

Config Keywords ⚙️

👾 Neovim plugin (spark.nvim)