Compare commits
9 Commits
v0.2.0
...
7680b34aca
| Author | SHA1 | Date | |
|---|---|---|---|
| 7680b34aca | |||
| 5364bfaa8a | |||
| 1d2d293b21 | |||
| aa955c3b4f | |||
| e65633a85a | |||
| d53ad8993c | |||
| 7b7fdc0113 | |||
| b010d63351 | |||
| c5447a68ae |
3
.gitignore
vendored
3
.gitignore
vendored
@@ -9,5 +9,4 @@ cfg/*.env
|
|||||||
cfg/*.toml
|
cfg/*.toml
|
||||||
|
|
||||||
build/
|
build/
|
||||||
buildTime.txt
|
build*.txt
|
||||||
buildVersion.txt
|
|
||||||
|
|||||||
28
Makefile
28
Makefile
@@ -24,6 +24,9 @@ endif
|
|||||||
# Variables
|
# Variables
|
||||||
#----------------------------------------------------------------
|
#----------------------------------------------------------------
|
||||||
progName = scaffold
|
progName = scaffold
|
||||||
|
arch = amd64
|
||||||
|
winbinName = $(progName).exe
|
||||||
|
releaseTag = $(shell git describe --abbrev=0)
|
||||||
|
|
||||||
#----------------------------------------------------------------
|
#----------------------------------------------------------------
|
||||||
# Helpers
|
# Helpers
|
||||||
@@ -51,17 +54,30 @@ clean:
|
|||||||
#----------------------------------------------------------------
|
#----------------------------------------------------------------
|
||||||
|
|
||||||
# build strips debugging info from binary
|
# build strips debugging info from binary
|
||||||
linkerflags = '-s'
|
linkerflags = '-s -w'
|
||||||
|
|
||||||
prep: clean
|
prep: clean
|
||||||
> date +"%F %a %T %Z" > buildTime.txt
|
> date +"%F %a %T %Z" > buildTime.txt
|
||||||
> git describe --always --tags --dirty --long > buildVersion.txt
|
> git describe --always --tags --dirty --long > buildVersion.txt
|
||||||
|
> @mkdir -p build
|
||||||
|
|
||||||
build: prep
|
build: prep linux windows
|
||||||
> @go build -o build/$(progName) . && echo "Build success" || echo "[FAILED] go build"
|
|
||||||
|
|
||||||
build-production: prep
|
linux:
|
||||||
> @go build -ldflags=${linkerflags} -o build/$(progName) . && echo "production build success" || echo "[FAILED] production build"
|
> @GOOS=$@ GOARCH=$(arch) go build -o build/$@/$(progName) . && echo $@ "Build success" || echo $@ "[FAILED] go build"
|
||||||
|
|
||||||
|
linux-release:
|
||||||
|
> @GOOS=linux GOARCH=$(arch) go build -ldflags=${linkerflags} -o build/linux/$(progName)-linux-$(arch)-$(releaseTag) . && echo $@ "Build success" || echo $@ "[FAILED] go build"
|
||||||
|
|
||||||
|
windows:
|
||||||
|
> @GOOS=$@ GOARCH=$(arch) go build -o build/$@/$(progName)-$@-$(arch)-$(releaseTag).exe . && echo $@ "Build success" || echo $@ "[FAILED] go build"
|
||||||
|
|
||||||
|
build-production: prep linx-production
|
||||||
|
|
||||||
|
linux-production:
|
||||||
|
> @GOOS=linux GOARCH=$(arch) go build -ldflags=${linkerflags} -o build/$@/$(progName) . && echo "production build success" || echo "[FAILED] production build"
|
||||||
|
|
||||||
|
release: prep linux-release windows
|
||||||
|
|
||||||
#-------------------------------------------------------------
|
#-------------------------------------------------------------
|
||||||
# Install - same as build, but places binary on system path
|
# Install - same as build, but places binary on system path
|
||||||
@@ -74,4 +90,4 @@ install-production: prep
|
|||||||
> @go install -ldflags=${linkerflags} . && echo "Production build and install success" || echo "[FAILED] Production install"
|
> @go install -ldflags=${linkerflags} . && echo "Production build and install success" || echo "[FAILED] Production install"
|
||||||
|
|
||||||
## Commands that don't relate to a specific file
|
## Commands that don't relate to a specific file
|
||||||
.PHONY: help confirm clean prep build build-production
|
.PHONY: help confirm clean prep build build-production linux windows amd64 release
|
||||||
57
README.md
57
README.md
@@ -2,18 +2,57 @@
|
|||||||
|
|
||||||
## Intro
|
## Intro
|
||||||
|
|
||||||
|
Use scaffold to setup a new project with a directory skeleton of your design, and if you'd like, it can also automatically initialize local, remote and gitea git repositories for the new project.
|
||||||
|
|
||||||
|
## What scaffold does
|
||||||
|
|
||||||
|
- A new project directory is created
|
||||||
|
- Your project skeleton/template is copied from your config/projectType/sample directory
|
||||||
|
- your setup/initialization commmands are run
|
||||||
|
- And if you enable them
|
||||||
|
- a git repository is initialized in the project directory
|
||||||
|
- a remote repository is created and setup
|
||||||
|
- a gitea repository is created and setup
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
1. Grab a version for your system from the releases page.
|
||||||
|
2. Put it in a directory that is on your path.
|
||||||
|
3. Now configure your preferred setups/layouts/skeletons/templates for your projects.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
On linux, the configuration directory will be at /home/user/.config/devel/scaffold
|
||||||
|
|
||||||
|
For the windows versions, you might want to look at your User_Configuration_Directories location, and change it according to your needs. On windows it's value is the %APPDATA% environment variable.
|
||||||
|
|
||||||
|
In a PowerShell, use `Get Child-Item Env:` to display all the environment variables.
|
||||||
|
Then `[Environment]::SetEnvironmentVariable("APPDATA","C:\Users\You\Wherever-you-like\","User")` to set the new value.
|
||||||
|
|
||||||
|
It's a little simpler at a command prompt -- type the command `set` and hit `Enter`. See what `APPDATA` is currently set to. Change it with `setx APPDATA "C:\Users\You\SomeWhere"`.
|
||||||
|
|
||||||
|
The examples directory contains an example-scaffold-projectType.toml configuration file. Place a copy in each projectType directory, adjusted to your preferences per the given project type.
|
||||||
|
|
||||||
|
## The `scaffold` command
|
||||||
|
|
||||||
|
| Command | Description |
|
||||||
|
| ------- | ----------- |
|
||||||
|
| scaffold | The program name |
|
||||||
|
| flags:
|
||||||
|
-i or -Info | Display the available project types and the build and version information about the program. |
|
||||||
|
| **Examples:** | |
|
||||||
|
| scaffold *ProjectType* *NewProjectName* | Stuff |
|
||||||
|
|
||||||
|
## Configuration of samples
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
The image should explain alot quickly. The go, go-cli, go-web, hs, js, py and svelte directories define the project types available to scaffold. Arrange the contents of the sample directory, within each project type directory, to your preferred layout for each language/use-case.
|
||||||
|
|
||||||
## Git
|
## Git
|
||||||
|
|
||||||
Git is available to be used as the version control system for new projects. Select/Deselect within the `scaffold-<PROJECTTYPE>.toml` file.
|
Git is available to be used as the version control system for new projects. Select/Deselect within the `scaffold-<PROJECTTYPE>.toml` file.
|
||||||
|
|
||||||
***Please Note** that if you also use it for your configuration files and sample directories, then a .gitignore file within your sample directory will interfere with git's ability to track your skeletons/templates properly. So, to allow for this, put what you normally would in a .gitignore file into a GITIGNORE file in your sample directory. And scaffold will convert it to a .gitignore file within your newProject directory.
|
*Please Note* that if you also use git to track your configuration files and sample directories, then a `.gitignore` file within your sample directory will interfere with git's ability to track your skeletons/templates properly. So, to allow for this, put what you normally would in a `.gitignore` file instead into a file named `GITIGNORE` in your sample directory. And scaffold will convert it to a `.gitignore` file within your newProject directory.
|
||||||
|
|
||||||
If you are NOT using git to track your project types and samples/skeletons/templates, then no problem, just place a .gitignore file within the sample directory as you would any other file.
|
If you are NOT using git to track your project types and samples/skeletons/templates, then no problem, just place a .gitignore file within the sample directory as you would any other file.
|
||||||
|
|
||||||
## The Process
|
|
||||||
|
|
||||||
- The new project directory is created
|
|
||||||
- Your project skeleton is copied from your sample directory
|
|
||||||
- your setup/initialization commmands are run
|
|
||||||
- a git repository is initialized in the project directory
|
|
||||||
- and if you enable it, a remote repository is created and setup
|
|
||||||
|
|||||||
BIN
assets/images/dirtree-pic.png
Normal file
BIN
assets/images/dirtree-pic.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 51 KiB |
@@ -11,85 +11,6 @@ scaffold go NewGoProject
|
|||||||
scaffold py aPythonProject
|
scaffold py aPythonProject
|
||||||
`
|
`
|
||||||
|
|
||||||
// var gi_template = `%s
|
|
||||||
// .env
|
|
||||||
// *.env
|
|
||||||
// .env.toml
|
|
||||||
|
|
||||||
// cfg/*.toml
|
|
||||||
// cfg/.env
|
|
||||||
// cfg/*.env
|
|
||||||
// cfg/.env*
|
|
||||||
// *.toml
|
|
||||||
|
|
||||||
// build/
|
|
||||||
// buildTime.txt
|
|
||||||
// buildVersion.txt
|
|
||||||
// `
|
|
||||||
|
|
||||||
// var gi_py_template = `%s
|
|
||||||
// .env
|
|
||||||
// *.env
|
|
||||||
// .env.toml
|
|
||||||
|
|
||||||
// cfg/*.toml
|
|
||||||
// cfg/.env
|
|
||||||
// cfg/*.env
|
|
||||||
// cfg/.env*
|
|
||||||
// *.toml
|
|
||||||
|
|
||||||
// bin/
|
|
||||||
// `
|
|
||||||
|
|
||||||
// var cfg_content = `# New Go Project configuration file
|
|
||||||
|
|
||||||
// # Format: TOML - see https://toml.io for details
|
|
||||||
|
|
||||||
// # Go specific
|
|
||||||
// # Go module path is of the form basePath/projectName
|
|
||||||
// # must be addressable if you are going to publish
|
|
||||||
// module_basepath = "officallygood.com"
|
|
||||||
|
|
||||||
// # where to put new project directories
|
|
||||||
// # within the user's home directory
|
|
||||||
// projects_basedir = "devel/GoMyApps"
|
|
||||||
// #def_project_name = "new-go-project"
|
|
||||||
|
|
||||||
// # Must be string, will be parsed to correct type
|
|
||||||
// # Remember perms are in octal
|
|
||||||
// project_dir_permissions = "0700"
|
|
||||||
// file_permissions = "0660"
|
|
||||||
|
|
||||||
// # Git
|
|
||||||
// setup_git = true
|
|
||||||
|
|
||||||
// # Do you have a remote location?
|
|
||||||
// # Do you have autologins setup correctly with ssh keys?
|
|
||||||
// # Using your .ssh/config file might be helpful
|
|
||||||
|
|
||||||
// # setup remote repo?
|
|
||||||
// create_remote_repo = false
|
|
||||||
|
|
||||||
// # remote repo user@location
|
|
||||||
// remote_user = "user@server"
|
|
||||||
|
|
||||||
// # remote repo base dir
|
|
||||||
// # relative to remote user home dir
|
|
||||||
// # eg unix/linux server
|
|
||||||
// # for user@server:/home/user/git -- absolute path
|
|
||||||
// user@server:git -- relative to home dir
|
|
||||||
// # eg windows server
|
|
||||||
// # ???
|
|
||||||
|
|
||||||
// ############################
|
|
||||||
// # remote location MUST already exist on remote server
|
|
||||||
// ############################
|
|
||||||
// remote_location = "git"
|
|
||||||
|
|
||||||
// # default remote short name
|
|
||||||
// remote_shortname = "origin"
|
|
||||||
//`
|
|
||||||
|
|
||||||
var cfg_content = `# Scaffold program configuration
|
var cfg_content = `# Scaffold program configuration
|
||||||
|
|
||||||
# Format: TOML - see https://toml.io for details
|
# Format: TOML - see https://toml.io for details
|
||||||
|
|||||||
23
main.go
23
main.go
@@ -10,6 +10,7 @@ import (
|
|||||||
"os/exec"
|
"os/exec"
|
||||||
"os/user"
|
"os/user"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"runtime"
|
||||||
"strconv"
|
"strconv"
|
||||||
|
|
||||||
"github.com/BurntSushi/toml"
|
"github.com/BurntSushi/toml"
|
||||||
@@ -47,7 +48,7 @@ var (
|
|||||||
infoFlag = flag.Bool("Info", false, "Displays the program build information and exits.")
|
infoFlag = flag.Bool("Info", false, "Displays the program build information and exits.")
|
||||||
infoFlag2 = flag.Bool("i", false, "Displays the program build information and exits.")
|
infoFlag2 = flag.Bool("i", false, "Displays the program build information and exits.")
|
||||||
sep = "/"
|
sep = "/"
|
||||||
cfg_dir = ".config/devel/scaffold"
|
cfg_dir = "devel/scaffold" // relative to <USER_CONFIG_DIR>, on linux /home/user/.config
|
||||||
cfg_filename = "scaffold-cfg.toml"
|
cfg_filename = "scaffold-cfg.toml"
|
||||||
setup ScaffoldSetup
|
setup ScaffoldSetup
|
||||||
npsetup Setup
|
npsetup Setup
|
||||||
@@ -57,9 +58,23 @@ func main() {
|
|||||||
|
|
||||||
flag.Parse()
|
flag.Parse()
|
||||||
|
|
||||||
|
user_cfg_dir, err := os.UserConfigDir()
|
||||||
|
ifFerr("Unable to determine user config directory", err)
|
||||||
|
|
||||||
if *infoFlag || *infoFlag2 {
|
if *infoFlag || *infoFlag2 {
|
||||||
fmt.Printf("Scaffold version: %s", buildVersion)
|
fmt.Printf("Scaffold version: %s", buildVersion)
|
||||||
fmt.Printf("Built: %s\n", buildTime)
|
fmt.Printf("Built: %s\n", buildTime)
|
||||||
|
|
||||||
|
if runtime.GOOS == "windows" {
|
||||||
|
fmt.Println("It's a windows system")
|
||||||
|
}
|
||||||
|
|
||||||
|
at, err := availableProjectTypes(user_cfg_dir + sep + cfg_dir)
|
||||||
|
ifFerr("Unable to get available project types", err)
|
||||||
|
fmt.Printf("Avaiable types: %v\n", at)
|
||||||
|
|
||||||
|
fmt.Println("System says -- user config directory: ", user_cfg_dir)
|
||||||
|
|
||||||
os.Exit(0)
|
os.Exit(0)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -67,7 +82,7 @@ func main() {
|
|||||||
u, err := user.Current()
|
u, err := user.Current()
|
||||||
ifFerr("Unable to get current user details", err)
|
ifFerr("Unable to get current user details", err)
|
||||||
homeDir := u.HomeDir
|
homeDir := u.HomeDir
|
||||||
scaffold_cfg_dir := homeDir + sep + cfg_dir
|
scaffold_cfg_dir := user_cfg_dir + sep + cfg_dir
|
||||||
cfg_file := scaffold_cfg_dir + sep + cfg_filename
|
cfg_file := scaffold_cfg_dir + sep + cfg_filename
|
||||||
|
|
||||||
if _, err := os.Stat(scaffold_cfg_dir); err != nil {
|
if _, err := os.Stat(scaffold_cfg_dir); err != nil {
|
||||||
@@ -84,6 +99,7 @@ func main() {
|
|||||||
_, err = cfgfd.WriteString(cfg_content)
|
_, err = cfgfd.WriteString(cfg_content)
|
||||||
ifFerr("Unable to write scaffold configuration file content", err)
|
ifFerr("Unable to write scaffold configuration file content", err)
|
||||||
fmt.Println("Wrote new scaffold configuration file")
|
fmt.Println("Wrote new scaffold configuration file")
|
||||||
|
|
||||||
_, err = toml.Decode(cfg_content, &setup)
|
_, err = toml.Decode(cfg_content, &setup)
|
||||||
ifFerr("[Failed] to parse config file", err)
|
ifFerr("[Failed] to parse config file", err)
|
||||||
} else {
|
} else {
|
||||||
@@ -292,6 +308,9 @@ func availableProjectTypes(adir string) ([]string, error) {
|
|||||||
|
|
||||||
for _, e := range entries {
|
for _, e := range entries {
|
||||||
if e.IsDir() {
|
if e.IsDir() {
|
||||||
|
if e.Name() == ".git" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
res = append(res, e.Name())
|
res = append(res, e.Name())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user