wpetit/scaffold
1
0
Fork 0
Code Issues Pull Requests Releases 4 Wiki Activity
Utilitaire de génération d’arborescence de fichiers à partir de projets “modèles” distants/locaux.
28 Commits 2 Branches 4 Tags 137 KiB
Go 67.6%
Shell 30.6%
Makefile 1.8%
680c16a8b8
Go to file
William Petit 680c16a8b8 Add auto install script and procedure
2021-07-09 13:41:23 +02:00
cmd/scaffold Add basic interactive overwrite strategy 2020-05-23 11:57:49 +02:00
doc Add 'Create template project' doc 2020-05-23 12:27:22 +02:00
internal Add basic interactive overwrite strategy 2020-05-23 11:57:49 +02:00
misc/script Add auto install script and procedure 2021-07-09 13:41:23 +02:00
.env.dist Add gitea-release task 2020-05-18 12:15:34 +02:00
.gitignore Add gitea-release task 2020-05-18 12:15:34 +02:00
go.mod Tidy deps 2020-05-23 12:27:55 +02:00
go.sum Add basic interactive overwrite strategy 2020-05-23 11:57:49 +02:00
LICENSE Add licence file 2020-04-07 08:59:50 +02:00
Makefile Add gitea-release task 2020-05-18 12:15:34 +02:00
modd.conf Initial commit 2020-02-20 08:31:22 +01:00
README.md Add auto install script and procedure 2021-07-09 13:41:23 +02:00

README.md

Scaffold

Description

scaffold est un outil permettant de générer une arborescence de fichiers à partir d'un modèle pré-existant.

Ce modèle peut être soit un répertoire local soit un dépôt Git distant.

De plus, scaffold intègre un mécanisme de templating permettant d'injecter des données dynamiques dans les fichiers à copier. Par défaut, tout fichier dont l'extension est .gotpl sera soumis à ce templating.

Un fichier "manifeste" (par défaut scaffold.yml) peut être créé afin de déclarer les variables à injecter. Ces variables seront demandées à l'utilisateur lors du lancement de la commande scaffold from.

Installation

À partir des sources

go install forge.cadoles.com/wpetit/scaffold/cmd/scaffold

Manuellement, à partir des binaires

  1. Télécharger la dernière version du binaire correspondant à votre plateforme (dernière version stable: 0.0.2)
  2. Extraire l'archive et place le binaire bin/scaffold dans votre $PATH (par exemple dans le répertoire /usr/local/bin)

Automatiquement, via le script d'installation

curl -s https://forge.cadoles.com/wpetit/scaffold/raw/branch/master/misc/script/install | bash

L'utilitaire jq doit être installé sur votre système.

Usage

NAME:
   scaffold - generate/update directory tree from template

USAGE:
   scaffold [global options] command [command options] [arguments...]

COMMANDS:
   from, n  generate a new project from a given template url
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h  show help (default: false)

Commandes

from

NAME:
   scaffold from - generate a new project from a given template url

USAGE:
   scaffold from [command options] <URL>

OPTIONS:
   --directory DIR, -d DIR   Set destination to DIR (default: "./")
   --manifest FILE, -m FILE  The scaffold manifest FILE (default: "scaffold.yml")
   --ignore value, -i value  Ignore files matching pattern (default: ".git", ".git/**", "./.git/**/*")
   --help, -h                show help (default: false)

Documentation

Licence

GPL-3.0