From 97fbfffd7e25dc750c6a4602f776cf039cc755e1 Mon Sep 17 00:00:00 2001 From: Shu Kutsuzawa Date: Thu, 18 Feb 2021 02:58:21 +0900 Subject: [PATCH] feat(golang): Configure when the module is shown (#2325) This makes it possible to configure when the golang module is shown based on the contents of a directory. This should make it possible to be a lot more granular when configuring the module. --- docs/config/README.md | 17 ++++++++++------- src/configs/go.rs | 13 +++++++++++++ src/modules/golang.rs | 27 +++++---------------------- 3 files changed, 28 insertions(+), 29 deletions(-) diff --git a/docs/config/README.md b/docs/config/README.md index 73d3b4cd..1249fa03 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -1233,7 +1233,7 @@ behind = "⇣${count}" ## Golang The `golang` module shows the currently installed version of Golang. -The module will be shown if any of the following conditions are met: +By default the module will be shown if any of the following conditions are met: - The current directory contains a `go.mod` file - The current directory contains a `go.sum` file @@ -1246,12 +1246,15 @@ The module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| ---------- | ---------------------------------- | ---------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | -| `style` | `"bold cyan"` | The style for the module. | -| `disabled` | `false` | Disables the `golang` module. | +| Option | Default | Description | +| -------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | +| `detect_extensions` | `["go"]` | Which extensions should trigger this moudle. | +| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. | +| `style` | `"bold cyan"` | The style for the module. | +| `disabled` | `false` | Disables the `golang` module. | ### Variables diff --git a/src/configs/go.rs b/src/configs/go.rs index 7bc77e7e..b3a1c2a3 100644 --- a/src/configs/go.rs +++ b/src/configs/go.rs @@ -8,6 +8,9 @@ pub struct GoConfig<'a> { pub symbol: &'a str, pub style: &'a str, pub disabled: bool, + pub detect_extensions: Vec<&'a str>, + pub detect_files: Vec<&'a str>, + pub detect_folders: Vec<&'a str>, } impl<'a> RootModuleConfig<'a> for GoConfig<'a> { @@ -17,6 +20,16 @@ impl<'a> RootModuleConfig<'a> for GoConfig<'a> { symbol: "🐹 ", style: "bold cyan", disabled: false, + detect_extensions: vec!["go"], + detect_files: vec![ + "go.mod", + "go.sum", + "glide.yaml", + "Gopkg.yml", + "Gopkg.lock", + ".go-version", + ], + detect_folders: vec!["Godeps"], } } } diff --git a/src/modules/golang.rs b/src/modules/golang.rs index 77aa062f..662462de 100644 --- a/src/modules/golang.rs +++ b/src/modules/golang.rs @@ -4,37 +4,20 @@ use crate::configs::go::GoConfig; use crate::formatter::StringFormatter; /// Creates a module with the current Go version -/// -/// Will display the Go version if any of the following criteria are met: -/// - Current directory contains a `go.mod` file -/// - Current directory contains a `go.sum` file -/// - Current directory contains a `glide.yaml` file -/// - Current directory contains a `Gopkg.yml` file -/// - Current directory contains a `Gopkg.lock` file -/// - Current directory contains a `.go-version` file -/// - Current directory contains a `Godeps` directory -/// - Current directory contains a file with the `.go` extension pub fn module<'a>(context: &'a Context) -> Option> { + let mut module = context.new_module("golang"); + let config = GoConfig::try_load(module.config); let is_go_project = context .try_begin_scan()? - .set_files(&[ - "go.mod", - "go.sum", - "glide.yaml", - "Gopkg.yml", - "Gopkg.lock", - ".go-version", - ]) - .set_extensions(&["go"]) - .set_folders(&["Godeps"]) + .set_files(&config.detect_files) + .set_extensions(&config.detect_extensions) + .set_folders(&config.detect_folders) .is_match(); if !is_go_project { return None; } - let mut module = context.new_module("golang"); - let config = GoConfig::try_load(module.config); let parsed = StringFormatter::new(config.format).and_then(|formatter| { formatter .map_meta(|var, _| match var {