Improve prompts

Fixes #115

Author: tmattio

.github/workflows/release.yml

@@ -97,7 +97,7 @@ jobs:
           name: macos-latest
           path: _release/platform-darwin-x64
 
-      - name: Create archives for Github release
+      - name: Create archives for GitHub release
         run: |
           cd _release/platform-darwin-x64
           zip -r ../../spin-darwin-x64.zip .
@@ -107,7 +107,7 @@ jobs:
           zip -r ../../spin-linux-x64.zip .
           cd ../..
 
-      - name: Upload spin-darwin-x64.zip to Github release 
+      - name: Upload spin-darwin-x64.zip to GitHub release 
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -117,7 +117,7 @@ jobs:
           asset_name: spin-darwin-x64.zip
           asset_content_type: application/gzip
 
-      - name: Upload spin-linux-x64.zip to Github release 
+      - name: Upload spin-linux-x64.zip to GitHub release 
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -127,7 +127,7 @@ jobs:
           asset_name: spin-linux-x64.zip
           asset_content_type: application/gzip
 
-      - name: Upload spin-windows-x64.zip to Github release 
+      - name: Upload spin-windows-x64.zip to GitHub release 
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CHANGES.md

@@ -130,7 +130,7 @@ Since the beginning of the project, a lot of learnings have been made and this n
 
 ## Added
 
-- Support user configuration file that stores general configuration such as the user's name, Github author_name, etc.
+- Support user configuration file that stores general configuration such as the user's name, GitHub author_name, etc.
 - Provide a `config` subcommand that can be used to change the user configuration.
 - The generators can now print a message when the generation succeeds with the `message` stanza.
 

lib/spin/template.ml

@@ -278,7 +278,7 @@ let generate ~path:generation_root template =
       m
         "\n🏗️  Creating a new project from %a in %s"
         Pp.pp_blue
-        template.name
+        (String.trim template.name)
         generation_root);
   let normalized_raw_files =
     template.raw_files |> List.map File_generator.normalize_path

lib/spin/user_config.ml

@@ -64,7 +64,7 @@ let prompt ?default:d () =
   in
   let github_username =
     Inquire.input
-      "Your Github author_name"
+      "Your GitHub username"
       ?default:(Option.bind d (fun d -> d.github_username))
       ~validate:validate_strip
   in

template/bin/spin

@@ -2,10 +2,10 @@
 (description "Native project containing a binary")
 
 (config project_name
-  (input (prompt "Project name")))
+  (input (prompt "Project name:")))
 
 (config project_slug
-  (input (prompt "Project slug"))
+  (input (prompt "Project slug:"))
   (default (slugify :project_name))
   (rules
     ("The project slug must be lowercase and contain ASCII characters and '-' only."
@@ -18,14 +18,14 @@
   (default true))
 
 (config project_description
-  (input (prompt "Description"))
+  (input (prompt "Description:"))
   (default "A short, but powerful statement about your project")
   (rules
     ("The last character of the description cannot be a \".\" to comply with Opam"
       (neq . (last_char :project_description)))))
 
 (config author_name
-  (input (prompt "Name of the author")))
+  (input (prompt "Name of the author:")))
 
 (config test_framework
   (select
@@ -36,22 +36,22 @@
 (config ci_cd
   (select
     (prompt "Which CI/CD do you use?")
-    (values Github None))
-  (default Github))
+    (values GitHub None))
+  (default GitHub))
 
 (ignore 
   (files test/*)
   (enabled_if (eq :test_framework None)))
 
 (ignore
   (files github/*)
-  (enabled_if (neq :ci_cd Github)))
+  (enabled_if (neq :ci_cd GitHub)))
 
 ; We need to do this because Dune won't copy .github during build
 (post_gen
   (actions
     (run mv github .github))
-  (enabled_if (eq :ci_cd Github)))
+  (enabled_if (eq :ci_cd GitHub)))
 
 (post_gen
   (actions

template/bin/template/README.md

@@ -1,6 +1,6 @@
 # {{ project_name }}
 
-{%- if ci_cd == 'Github' and github_username %}
+{%- if ci_cd == 'GitHub' and github_username %}
 
 [![Actions Status](https://github.com/{{ github_username }}/{{ project_slug }}/workflows/CI/badge.svg)](https://github.com/{{ github_username }}/{{ project_slug }}/actions)
 {%- endif %}

template/c-bindings/template/README.md

@@ -1,6 +1,6 @@
 # {{ project_name }}
 
-{%- if ci_cd == 'Github' and github_username %}
+{%- if ci_cd == 'GitHub' and github_username %}
 
 [![Actions Status](https://github.com/{{ github_username }}/{{ project_slug }}/workflows/CI/badge.svg)](https://github.com/{{ github_username }}/{{ project_slug }}/actions)
 {%- endif %}

template/cli/template/CONTRIBUTING.md

@@ -56,10 +56,10 @@ The, you can run the script `script/release.sh`. The script will perform the fol
 
 - Create a tag with the version found in `{{ project_slug }}.opam`, and push it to your repository.
 - Create the distribution archive.
-- Publish the distribution archive to a Github Release.
+- Publish the distribution archive to a GitHub Release.
 - Submit a PR on Opam's repository.
 
-When the release is published on Github, the CI/CD will trigger the `Release` workflow which will compile binaries for all supported platforms and add them to the Github Release as assets.
+When the release is published on GitHub, the CI/CD will trigger the `Release` workflow which will compile binaries for all supported platforms and add them to the GitHub Release as assets.
 
 ### Repository Structure
 
@@ -68,7 +68,7 @@ The following snippet describes {{ project_name }}'s repository structure.
 ```text
 .
 ├── .github/
-|   Contains Github specific files such as actions definitions and issue templates.
+|   Contains GitHub specific files such as actions definitions and issue templates.
 │
 ├── bin/
 |   Source for {{ project_name }}'s binary. This links to the library defined in `lib/`.

template/cli/template/README.md

@@ -1,6 +1,6 @@
 # {{ project_name }}
 
-{%- if ci_cd == 'Github' and github_username %}
+{%- if ci_cd == 'GitHub' and github_username %}
 
 [![Actions Status](https://github.com/{{ github_username }}/{{ project_slug }}/workflows/CI/badge.svg)](https://github.com/{{ github_username }}/{{ project_slug }}/actions)
 {%- endif %}

template/js/template/README.md

@@ -1,6 +1,6 @@
 # {{ project_name }}
 
-{%- if ci_cd == 'Github' and github_username %}
+{%- if ci_cd == 'GitHub' and github_username %}
 
 [![Actions Status](https://github.com/{{ github_username }}/{{ project_slug }}/workflows/CI/badge.svg)](https://github.com/{{ github_username }}/{{ project_slug }}/actions)
 {%- endif %}

template/lib/template/README.md

@@ -1,6 +1,6 @@
 # {{ project_name }}
 
-{%- if ci_cd == 'Github' and github_username %}
+{%- if ci_cd == 'GitHub' and github_username %}
 
 [![Actions Status](https://github.com/{{ github_username }}/{{ project_slug }}/workflows/CI/badge.svg)](https://github.com/{{ github_username }}/{{ project_slug }}/actions)
 {%- endif %}

template/ppx/template/README.md

@@ -1,6 +1,6 @@
 # {{ project_name }}
 
-{%- if ci_cd == 'Github' and github_username %}
+{%- if ci_cd == 'GitHub' and github_username %}
 
 [![Actions Status](https://github.com/{{ github_username }}/{{ project_slug }}/workflows/CI/badge.svg)](https://github.com/{{ github_username }}/{{ project_slug }}/actions)
 {%- endif %}