stamp.scroll

authors Breck Yunits
 https://twitter.com/breckyunits Breck Yunits
date 6/23/2024
tags All
title Stamp: a microlang for project templates

header.scroll
keyboardNav
printTitle
printAuthors

mediumColumns 1

Regardless if you specialize in React, Rails, Django, Next, Java, C#, or ObjectiveC, you probably use _templates_ to start new projects.
 dateline

Templates generate a handful of files like `readme.md`, `.gitignore`, and `main`.

They also initialize a handful of directories like `src/` and `tests/`.

What if it was even easier to make, edit and use these templates?

***

Introducing Stamp, a microlang (only 60 lines of code, including comments) that makes it as concise as possible to write, edit, share and expand project templates.
 https://github.com/breck7/scroll/blob/main/parsers/stamp.parsers 60 lines of code

***

# How to use

1. Install Scroll
code
 npm install -g scroll-cli

2. Create `myFirstStamp.scroll`
code
 stamp
  .gitignore
   *.html
  readme.scroll
   # My First Stamp
   <script src="scripts/hello.js"></script>
  scripts/
   hello.js
    console.log("Hello world")

3. Run `scroll build`

Done!

***

Stamp was jointly created by me and Guillaume Papin. Other tools (listed below) do similar things, but with some slight differences.
 https://github.com/Sarcasm Guillaume Papin
 https://github.com/breck7/scrollsdk/issues/120 jointly created

****

endColumns

thinColumns 1
stamp.jpeg
 // ChatGPT: XKCD style comic. Single pane. A stamp that is generating files and folders

# Prior Art
- cookiecutter
 https://github.com/cookiecutter/cookiecutter
- Dired
 https://www.gnu.org/software/emacs/manual/html_node/emacs/Dired.html
- vimv
 https://github.com/thameera/vimv
- ptar
 https://github.com/jtvaughan/ptar ptar
- shar
 https://en.wikipedia.org/wiki/Shar shar
- dar
 http://dar.linux.free.fr/
- metatar
 https://github.com/xyproto/metatar
- txtar
 https://pkg.go.dev/golang.org/x/tools@v0.1.0/txtar
- Archiving files in plain text
 https://blog.oquijano.net/id/9?lang=en
- Wikipedia list of archive formats
 https://en.wikipedia.org/wiki/List_of_archive_formats

footer.scroll