kevin/scaffold
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 4 Wiki Activity

+gitea bare repo cloning

Browse Source
This commit is contained in:
Kevin Offet
2023-04-17 05:19:25 -04:00
parent 7680b34aca
commit ec313ab3c3
5 changed files with 274 additions and 141 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -16,7 +16,7 @@ Use scaffold to setup a new project with a directory skeleton of your design, an
## Installation
1. Grab a version for your system from the releases page.
1. Grab a binary 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.
@@ -33,6 +33,20 @@ It's a little simpler at a command prompt -- type the command `set` and hit `Ent
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.
## Naming convention warning
Creating repositories on gitea via a ssh push has a side effect -- the project name is forced to lowercase. There are no configuration options to change this. Please see gitea and it's documentation for full explanations.
Here are a couple of thoughts:
1. Adapt and only create projects use lowercase (myspecialproject) or lowersnakecase (my_special_project) or use hyphens between words (my-special-project)
- all lowercase is universally accepted but hard to read for multi-word project names
- lowersnakecase is not universally accepted
- hyphens might not be what you are used to, or prefer, but it seems to be universally accepted and reasonably readable.
2. A work around would be to manually create a reposity with the CamelCase name you want via gitea's web UI. And use scaffold with the -g flag
eg. `scaffold -g MySpecialProject go MySpecialProject` to have scaffold clone it, build it out according to your skeleton/templates, and then push the changes.
## The `scaffold` command
| Command | Description |
@@ -40,6 +54,7 @@ The examples directory contains an example-scaffold-projectType.toml configurati
| scaffold | The program name |
| flags:
-i or -Info | Display the available project types and the build and version information about the program. |
| -g GiteaProjectName | Clone a gitea repository, not create one. Then push the new structure to it. |
| **Examples:** | |
| scaffold *ProjectType* *NewProjectName* | Stuff |