storm-workspace 0.19.167

A crate containing various utilities and tools used by Storm Software to manage monorepos.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

use std::env;
use std::fs::read_dir;
use std::path::PathBuf;

use crate::errors::StormWorkspaceError;

const WORKSPACE_ROOT_FILES: [&str; 35] = [
  "storm-workspace.json",
  "storm-workspace.toml",
  "storm-workspace.yaml",
  "storm-workspace.yml",
  "storm-workspace.xml",
  "storm-workspace.config.js",
  "storm-workspace.config.ts",
  ".storm-workspace.json",
  ".storm-workspace.yaml",
  ".storm-workspace.yml",
  ".storm-workspace.js",
  ".storm-workspace.ts",
  "lerna.json",
  "nx.json",
  "turbo.json",
  "Cargo.lock",
  "npm-workspace.json",
  "yarn-workspace.json",
  "pnpm-workspace.json",
  "npm-workspace.yaml",
  "yarn-workspace.yaml",
  "pnpm-workspace.yaml",
  "npm-workspace.yml",
  "yarn-workspace.yml",
  "pnpm-workspace.yml",
  "npm-lock.json",
  "yarn-lock.json",
  "pnpm-lock.json",
  "npm-lock.yaml",
  "yarn-lock.yaml",
  "pnpm-lock.yaml",
  "npm-lock.yml",
  "yarn-lock.yml",
  "pnpm-lock.yml",
  "bun.lockb",
];

/// Get the workspace root
///
/// This function will return the workspace root directory by checking the current directory and its ancestors for the presence of a workspace root file.
///
/// The file list checked to determine the workspace root directory include:
/// - storm-workspace.json
/// - storm-workspace.toml
/// - storm-workspace.yaml
/// - storm-workspace.yml
/// - storm-workspace.xml
/// - storm-workspace.config.js
/// - storm-workspace.config.ts
/// - .storm-workspace.json
/// - .storm-workspace.yaml
/// - .storm-workspace.yml
/// - .storm-workspace.js
/// - .storm-workspace.ts
/// - lerna.json
/// - nx.json
/// - turbo.json
/// - Cargo.lock
/// - npm-workspace.json
/// - yarn-workspace.json
/// - pnpm-workspace.json
/// - npm-workspace.yaml
/// - yarn-workspace.yaml
/// - pnpm-workspace.yaml
/// - npm-workspace.yml
/// - yarn-workspace.yml
/// - pnpm-workspace.yml
/// - npm-lock.json
/// - yarn-lock.json
/// - pnpm-lock.json
/// - npm-lock.yaml
/// - yarn-lock.yaml
/// - pnpm-lock.yaml
/// - npm-lock.yml
/// - yarn-lock.yml
/// - pnpm-lock.yml
/// - bun.lockb
///
/// ```rust,no_run
/// use storm_workspace::utils::get_workspace_root;
///
/// match get_workspace_root() {
///     Ok(p) => println!("Current project root is {:?}", p),
///     Err(e) => println!("Error obtaining project root {:?}", e)
/// };
/// ```
pub fn get_workspace_root() -> Result<PathBuf, StormWorkspaceError> {
  if let Ok(workspace_root) = env::var("STORM_WORKSPACE_ROOT") {
    return Ok(PathBuf::from(workspace_root));
  }
  if let Ok(workspace_root) = env::var("NX_WORKSPACE_ROOT") {
    return Ok(PathBuf::from(workspace_root));
  }
  if let Ok(workspace_root) = env::var("WORKSPACE_DIR") {
    return Ok(PathBuf::from(workspace_root));
  }
  if let Ok(workspace_root) = env::var("CARGO_WORKSPACE_DIR") {
    return Ok(PathBuf::from(workspace_root));
  }

  match env::current_dir() {
    Ok(path) => {
      let mut path_ancestors = path.as_path().ancestors();

      while let Some(p) = path_ancestors.next() {
        match read_dir(p) {
          Ok(dir) => {
            if dir
              .into_iter()
              .any(|p| WORKSPACE_ROOT_FILES.contains(&p.unwrap().file_name().to_str().unwrap()))
            {
              return Ok(PathBuf::from(p));
            }
          }

          Err(_) => {
            return Err(StormWorkspaceError::ReadDirectoryFailure(p.to_str().unwrap().to_string()));
          }
        }
      }
      Err(StormWorkspaceError::WorkspaceRootNotFound(
        WORKSPACE_ROOT_FILES.iter().map(|f| f.to_string()).collect::<Vec<String>>().join(", \r\n"),
      ))
    }
    Err(_) => Err(StormWorkspaceError::NoCurrentDirectory),
  }
}