feat(config): restricted scopes (#49)

* feat(config): ability to predefine scopes

* docs(CHANGELOG): update changelog

* fix(scopes): allow selecting no scope

* docs(README): update readme with scopes info

* refactor(scopes): change the label for no scopes

* chore(README): move warning to before block

Author: stefanlogue

CHANGELOG.md

@@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
+### Added
+- ability to define restricted scopes (#48)
 
 ## [v0.24.4](https://github.com/stefanlogue/meteor/releases/tag/v0.24.4) - 2024-12-12
 

README.md

@@ -4,18 +4,22 @@
   <h5>Meteor is a simple, highly customisable CLI tool that helps you to write <a href="https://www.conventionalcommits.org/">conventional commits</a> with git.</h5>
 </div>
 
-
-You can call `meteor` where you'd normally type `git commit`. All flags supported in `git commit` will still work.
+You can call `meteor` where you'd normally type `git commit`. All flags
+supported in `git commit` will still work.
 
 ![Demo](demos/demo-without-boards.gif)
 
 ## Installation
+
 ### Homebrew
+
 ```console
 brew tap stefanlogue/tools
 brew install meteor
 ```
+
 ### Go
+
 Install with Go (1.21+):
 
 ```console
@@ -26,8 +30,13 @@ Or grab a binary from [the latest release](https://github.com/stefanlogue/meteor
 
 ## Customisation
 
-You can customise the options available by creating a `.meteor.json` file anywhere in the directory tree (at or above the current working directory). The config file closest to the current working directory will be preferred. This enables you to have different configs for different parent directories, such as one for your personal work, one for your actual work, one for open source work etc.
-For global configurations you can create a `config.json` file in the `~/.config/meteor/` directory.
+You can customise the options available by creating a `.meteor.json` file
+anywhere in the directory tree (at or above the current working directory). The
+config file closest to the current working directory will be preferred. This
+enables you to have different configs for different parent directories, such as
+one for your personal work, one for your actual work, one for open source work
+etc. For global configurations you can create a `config.json` file in the
+`~/.config/meteor/` directory.
 
 ### Boards
 
@@ -53,7 +62,9 @@ The content should be in the following format:
 }
 ```
 
-If you use boards (Jira etc) but need a way to have commits without one, add the following to the `boards` array:
+If you use boards (Jira etc) but need a way to have commits without one, add the
+following to the `boards` array:
+
 ```json
 {
   "boards": [
@@ -63,8 +74,25 @@ If you use boards (Jira etc) but need a way to have commits without one, add the
 }
 ```
 
+If you want to define a set of predefined scopes to select from rather than
+typing the scope, a `scopes` array can be added to your config:
+
+> [!WARNING]
+> Setting predefined scopes removes the ability to type the scope
+
+```json
+{
+  "scopes": [
+    { "name": "scope1" },
+    { "name": "scope2"}
+  ]
+}
+```
+
 ### Message Templates
-If the default commit message templates aren't exactly what you're looking for, you can provide your own! The syntax can be seen in the defaults below:
+
+If the default commit message templates aren't exactly what you're looking for,
+you can provide your own! The syntax can be seen in the defaults below:
 
 ```json
 {
@@ -74,14 +102,19 @@ If the default commit message templates aren't exactly what you're looking for,
 ```
 
 `messageTemplate` needs to have:
-  - `@type`: the conventional commit type i.e. `feat`, `chore` etc.
-  - `@message`: the commit message
-  - `(@scope)`: (optional but recommended) the scope of the commit, must be within parentheses
+
+- `@type`: the conventional commit type i.e. `feat`, `chore` etc.
+- `@message`: the commit message
+- `(@scope)`: (optional but recommended) the scope of the commit, must be within
+parentheses
 
 `messageWithTicketTemplate` also additionally takes `@ticket`
 
 ### Intro
-If you want to skip the intro screen to save a keypress, add the following to your config:
+
+If you want to skip the intro screen to save a keypress, add the following to
+your config:
+
 ```json
 {
   "showIntro": false

config.go

@@ -21,6 +21,7 @@ type LoadConfigReturn struct {
 	Prefixes                  []huh.Option[string]
 	Coauthors                 []huh.Option[string]
 	Boards                    []huh.Option[string]
+	Scopes                    []huh.Option[string]
 	CommitTitleCharLimit      int
 	ShowIntro                 bool
 }
@@ -89,6 +90,7 @@ func loadConfig(fs afero.Fs) (LoadConfigReturn, error) {
 		Prefixes:                  c.Prefixes.Options(),
 		Coauthors:                 c.Coauthors.Options(),
 		Boards:                    c.Boards.Options(),
+		Scopes:                    c.Scopes.Options(),
 		CommitTitleCharLimit:      *c.CommitTitleCharLimit,
 		ShowIntro:                 *c.ShowIntro,
 	}, nil

main.go

@@ -155,6 +155,22 @@ func main() {
 		}
 	}
 
+	// if the user has specified scopes in their config, use a select input, otherwise use a text input
+	var scopeInput huh.Field
+	if len(config.Scopes) > 0 {
+		scopeInput = huh.NewSelect[string]().
+			Title("Scope").
+			Description("Choose a scope for the changes").
+			Options(config.Scopes...).
+			Value(&newCommit.Scope)
+	} else {
+		scopeInput = huh.NewInput().
+			Title("Scope").
+			Description("Specify a scope of the changes").
+			CharLimit(16).
+			Value(&newCommit.Scope)
+	}
+
 	mainForm := huh.NewForm(
 		huh.NewGroup(
 			huh.NewSelect[string]().
@@ -168,11 +184,7 @@ func main() {
 				Affirmative("Yes!").
 				Negative("Nope.").
 				Value(&newCommit.IsBreakingChange),
-			huh.NewInput().
-				Title("Scope").
-				Description("Specify a scope of the change").
-				CharLimit(16).
-				Value(&newCommit.Scope),
+			scopeInput,
 		),
 		huh.NewGroup(
 			huh.NewMultiSelect[string]().

pkg/config/co_author.go

@@ -27,6 +27,6 @@ func (p *CoAuthors) Options() []huh.Option[string] {
 	}
 	items = append(items, huh.Option[string]{})
 	copy(items[1:], items)
-	items[0] = huh.NewOption[string]("no coauthors", "none")
+	items[0] = huh.NewOption("no coauthors", "none")
 	return items
 }

pkg/config/config.go

@@ -17,6 +17,7 @@ type Config struct {
 	Prefixes                  Prefixes  `json:"prefixes"`
 	Coauthors                 CoAuthors `json:"coauthors"`
 	Boards                    Boards    `json:"boards"`
+	Scopes                    Scopes    `json:"scopes"`
 }
 
 // New returns a new Config

pkg/config/scope.go

@@ -0,0 +1,24 @@
+package config
+
+import "github.com/charmbracelet/huh"
+
+type Scope struct {
+	Name string `json:"name"`
+}
+
+type Scopes []Scope
+
+func (s *Scopes) Options() []huh.Option[string] {
+	scopes := []Scope(*s)
+	if len(scopes) == 0 {
+		return nil
+	}
+	items := []huh.Option[string]{}
+	for _, scope := range scopes {
+		items = append(items, huh.NewOption(scope.Name, scope.Name))
+	}
+	items = append(items, huh.Option[string]{})
+	copy(items[1:], items)
+	items[0] = huh.NewOption("none", "")
+	return items
+}