feat: add support for VALE_STYLES_PATH

cmd/vale/command.go

@@ -31,6 +31,7 @@ var commandInfo = map[string]string{
  "ls-config": "Print the current configuration to stdout.",
  "ls-metrics": "Print the given file's internal metrics to stdout.",
  "ls-dirs": "Print the default configuration directories to stdout.",
+ "ls-vars": "Print the supported enviroment variables to stdout.",
  "sync": "Download and install external configuration sources.",
  "fix": "Attempt to automatically fix the given alert.",
 }
@@ -40,6 +41,7 @@ var Actions = map[string]func(args []string, flags *core.CLIFlags) error{
  "ls-config": printConfig,
  "ls-metrics": printMetrics,
  "ls-dirs": printDirs,
+ "ls-vars": printVars,
  "sync": sync,
 
  // private
@@ -237,6 +239,18 @@ func runRule(args []string, _ *core.CLIFlags) error {
  return nil
 }
 
+func printVars(_ []string, _ *core.CLIFlags) error {
+ tableData := pterm.TableData{
+ {"Variable", "Description"},
+ }
+
+ for v, info := range core.ConfigVars {
+ tableData = append(tableData, []string{pterm.Gray(v), info})
+ }
+
+ return pterm.DefaultTable.WithHasHeader().WithData(tableData).Render()
+}
+
 func printDirs(_ []string, _ *core.CLIFlags) error {
  styles, _ := core.DefaultStylesPath()
 
@@ -263,9 +277,9 @@ func printDirs(_ []string, _ *core.CLIFlags) error {
 
  tableData := pterm.TableData{
  {"Asset", "Default Location", "Found"},
- {"StylesPath", styles, stylesFound},
- {".vale.ini", cfg, configFound},
- {"vale-native", nativeExe, nativeFound},
+ {pterm.Gray("StylesPath"), styles, stylesFound},
+ {pterm.Gray(".vale.ini"), cfg, configFound},
+ {pterm.Gray("vale-native"), nativeExe, nativeFound},
  }
 
  return pterm.DefaultTable.WithHasHeader().WithData(tableData).Render()

internal/core/config.go

@@ -12,6 +12,7 @@ import (
  "github.com/adrg/xdg"
  "github.com/bmatcuk/doublestar/v4"
  "github.com/errata-ai/ini"
+ "github.com/pterm/pterm"
 
  "github.com/errata-ai/vale/v3/internal/glob"
 )
@@ -43,6 +44,12 @@ var (
 // configuration files.
 var ConfigDirs = []string{VocabDir, DictDir, TmplDir, IgnoreDir}
 
+// ConfigVars is a list of all supported environment variables.
+var ConfigVars = map[string]string{
+ "VALE_CONFIG_PATH": fmt.Sprintf("Override the default search process by specifying a %s file.", pterm.Gray(".vale.ini")),
+ "VALE_STYLES_PATH": fmt.Sprintf("Specify the location of the default %s.", pterm.Gray("StylesPath")),
+}
+
 // ConfigNames is a list of all possible configuration file names.
 //
 // NOTE: This is leftover from the early days of Vale; we have now standardized
@@ -81,10 +88,15 @@ func DefaultConfig() (string, error) {
 // NOTE: the default styles directory is only used if neither the
 // project-specific nor the global configuration file specify a `StylesPath`.
 func DefaultStylesPath() (string, error) {
+ if fromEnv, hasEnv := os.LookupEnv("VALE_STYLES_PATH"); hasEnv {
+ return fromEnv, nil
+ }
+
  styles, err := xdg.DataFile("vale/styles/config.yml")
  if err != nil {
  return "", fmt.Errorf("failed to find default styles: %w", err)
  }
+
  return filepath.Dir(styles), nil
 }