sublime_pkg_tools 0.0.27

Package and version management toolkit for Node.js projects with changeset support
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
//! Package-level changes data structures and operations.
//!
//! **What**: Provides types for representing changes affecting a single package, including
//! file changes, commit information, version information, and statistics.
//!
//! **How**: Aggregates file changes and commits for a specific package, tracks current and
//! next versions, and provides helper methods for filtering and analyzing package-level changes.
//!
//! **Why**: To provide a comprehensive view of all changes affecting a package, supporting
//! version bumping decisions, changelog generation, and release planning.
//!
//! # Examples
//!
//! ## Creating package changes
//!
//! ```rust,ignore
//! use sublime_pkg_tools::changes::{PackageChanges, FileChange, FileChangeType, PackageChangeStats};
//! use sublime_pkg_tools::types::Version;
//! use sublime_standard_tools::monorepo::WorkspacePackage;
//! use std::path::PathBuf;
//!
//! let workspace_pkg = WorkspacePackage::new(
//!     "@myorg/core".to_string(),
//!     "1.0.0".to_string(),
//!     PathBuf::from("packages/core"),
//!     PathBuf::from("/workspace/packages/core"),
//! );
//!
//! let mut changes = PackageChanges::new(workspace_pkg);
//! changes.current_version = Some(Version::parse("1.0.0").unwrap());
//!
//! // Add file changes
//! changes.add_file(FileChange::new(
//!     PathBuf::from("packages/core/src/index.ts"),
//!     PathBuf::from("src/index.ts"),
//!     FileChangeType::Modified,
//! ));
//!
//! assert!(changes.has_changes);
//! assert_eq!(changes.files.len(), 1);
//! ```

use crate::changes::{CommitInfo, FileChange, FileChangeType, PackageChangeStats};
use crate::types::{Version, VersionBump};
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::path::{Path, PathBuf};
use sublime_standard_tools::monorepo::WorkspacePackage;

/// Changes for a single package.
///
/// Contains comprehensive information about all changes affecting a package,
/// including file changes, commits, version information, and statistics.
///
/// # Examples
///
/// ```rust,ignore
/// use sublime_pkg_tools::changes::{PackageChanges, FileChange, FileChangeType};
/// use sublime_standard_tools::monorepo::WorkspacePackage;
/// use std::path::PathBuf;
///
/// let workspace_pkg = WorkspacePackage::new(
///     "@myorg/core".to_string(),
///     "1.0.0".to_string(),
///     PathBuf::from("packages/core"),
///     PathBuf::from("/workspace/packages/core"),
/// );
///
/// let changes = PackageChanges::new(workspace_pkg);
/// assert_eq!(changes.package_name(), "@myorg/core");
/// assert!(!changes.has_changes);
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct PackageChanges {
    /// Package information from the workspace.
    ///
    /// Contains name, version, location, and dependencies.
    #[serde(skip, default = "default_workspace_package")]
    pub package_info: WorkspacePackage,

    /// Package name (for serialization since WorkspacePackage doesn't serialize).
    pub package_name: String,

    /// Package version (for serialization).
    pub package_version: String,

    /// Package location relative to workspace root (for serialization).
    pub package_location: PathBuf,

    /// Current version from package.json.
    ///
    /// This is the version before any changes are applied.
    pub current_version: Option<Version>,

    /// Next version calculated from changeset bump.
    ///
    /// This will be `None` for working directory analysis without a changeset.
    /// It will be populated when analyzing with version preview.
    pub next_version: Option<Version>,

    /// Bump type applied to calculate next version.
    ///
    /// This indicates whether this package should receive a major, minor,
    /// or patch version bump based on the changeset.
    pub bump_type: Option<VersionBump>,

    /// All files changed in this package.
    pub files: Vec<FileChange>,

    /// All commits affecting this package.
    ///
    /// For working directory analysis, this will be empty.
    /// For commit range analysis, this contains all commits in the range
    /// that modified files in this package.
    pub commits: Vec<CommitInfo>,

    /// Whether this package has any changes.
    pub has_changes: bool,

    /// Change statistics for this package.
    pub stats: PackageChangeStats,
}

impl PackageChanges {
    /// Creates a new `PackageChanges` for a package.
    ///
    /// # Arguments
    ///
    /// * `package_info` - Workspace package information
    ///
    /// # Examples
    ///
    /// ```rust,ignore
    /// use sublime_pkg_tools::changes::PackageChanges;
    /// use sublime_standard_tools::monorepo::WorkspacePackage;
    /// use std::path::PathBuf;
    ///
    /// let workspace_pkg = WorkspacePackage::new(
    ///     "@myorg/core".to_string(),
    ///     "1.0.0".to_string(),
    ///     PathBuf::from("packages/core"),
    ///     PathBuf::from("/workspace/packages/core"),
    /// );
    ///
    /// let changes = PackageChanges::new(workspace_pkg);
    /// assert!(!changes.has_changes);
    /// ```
    #[must_use]
    pub fn new(package_info: WorkspacePackage) -> Self {
        let package_name = package_info.name.clone();
        let package_version = package_info.version.clone();
        let package_location = package_info.location.clone();

        Self {
            package_info,
            package_name,
            package_version,
            package_location,
            current_version: None,
            next_version: None,
            bump_type: None,
            files: Vec::new(),
            commits: Vec::new(),
            has_changes: false,
            stats: PackageChangeStats::new(),
        }
    }

    /// Returns the package name.
    ///
    /// # Examples
    ///
    /// ```rust,ignore
    /// # use sublime_pkg_tools::changes::PackageChanges;
    /// # use sublime_standard_tools::monorepo::WorkspacePackage;
    /// # use std::path::PathBuf;
    /// let workspace_pkg = WorkspacePackage::new(
    ///     "@myorg/core".to_string(),
    ///     "1.0.0".to_string(),
    ///     PathBuf::from("packages/core"),
    ///     PathBuf::from("/workspace/packages/core"),
    /// );
    /// let changes = PackageChanges::new(workspace_pkg);
    /// assert_eq!(changes.package_name(), "@myorg/core");
    /// ```
    #[must_use]
    pub fn package_name(&self) -> &str {
        &self.package_info.name
    }

    /// Returns the package location relative to workspace root.
    ///
    /// # Examples
    ///
    /// ```rust,ignore
    /// # use sublime_pkg_tools::changes::PackageChanges;
    /// # use sublime_standard_tools::monorepo::WorkspacePackage;
    /// # use std::path::{Path, PathBuf};
    /// let workspace_pkg = WorkspacePackage::new(
    ///     "@myorg/core".to_string(),
    ///     "1.0.0".to_string(),
    ///     PathBuf::from("packages/core"),
    ///     PathBuf::from("/workspace/packages/core"),
    /// );
    /// let changes = PackageChanges::new(workspace_pkg);
    /// assert_eq!(changes.package_location(), Path::new("packages/core"));
    /// ```
    #[must_use]
    pub fn package_location(&self) -> &Path {
        &self.package_info.location
    }

    /// Adds a file change to this package.
    ///
    /// Automatically updates statistics and the `has_changes` flag.
    ///
    /// # Arguments
    ///
    /// * `file_change` - The file change to add
    ///
    /// # Examples
    ///
    /// ```rust,ignore
    /// # use sublime_pkg_tools::changes::{PackageChanges, FileChange, FileChangeType};
    /// # use sublime_standard_tools::monorepo::WorkspacePackage;
    /// # use std::path::PathBuf;
    /// let workspace_pkg = WorkspacePackage::new(
    ///     "@myorg/core".to_string(),
    ///     "1.0.0".to_string(),
    ///     PathBuf::from("packages/core"),
    ///     PathBuf::from("/workspace/packages/core"),
    /// );
    /// let mut changes = PackageChanges::new(workspace_pkg);
    ///
    /// changes.add_file(FileChange::new(
    ///     PathBuf::from("packages/core/src/index.ts"),
    ///     PathBuf::from("src/index.ts"),
    ///     FileChangeType::Modified,
    /// ));
    ///
    /// assert!(changes.has_changes);
    /// assert_eq!(changes.files.len(), 1);
    /// ```
    pub fn add_file(&mut self, file_change: FileChange) {
        // Update statistics
        self.stats.files_changed += 1;
        match file_change.change_type {
            FileChangeType::Added | FileChangeType::Untracked | FileChangeType::Copied => {
                self.stats.files_added += 1;
            }
            FileChangeType::Modified | FileChangeType::Renamed => {
                self.stats.files_modified += 1;
            }
            FileChangeType::Deleted => {
                self.stats.files_deleted += 1;
            }
        }

        if let Some(added) = file_change.lines_added {
            self.stats.lines_added += added;
        }
        if let Some(deleted) = file_change.lines_deleted {
            self.stats.lines_deleted += deleted;
        }

        self.files.push(file_change);
        self.has_changes = true;
    }

    /// Adds a commit to this package.
    ///
    /// Updates the commit count in statistics.
    ///
    /// # Arguments
    ///
    /// * `commit` - The commit to add
    pub fn add_commit(&mut self, commit: CommitInfo) {
        self.commits.push(commit);
        self.stats.commits = self.commits.len();
    }

    /// Gets files by change type.
    ///
    /// # Arguments
    ///
    /// * `change_type` - The type of change to filter by
    ///
    /// # Examples
    ///
    /// ```rust,ignore
    /// # use sublime_pkg_tools::changes::{PackageChanges, FileChange, FileChangeType};
    /// # use sublime_standard_tools::monorepo::WorkspacePackage;
    /// # use std::path::PathBuf;
    /// let workspace_pkg = WorkspacePackage::new(
    ///     "@myorg/core".to_string(),
    ///     "1.0.0".to_string(),
    ///     PathBuf::from("packages/core"),
    ///     PathBuf::from("/workspace/packages/core"),
    /// );
    /// let mut changes = PackageChanges::new(workspace_pkg);
    ///
    /// changes.add_file(FileChange::new(
    ///     PathBuf::from("file1.ts"),
    ///     PathBuf::from("file1.ts"),
    ///     FileChangeType::Added,
    /// ));
    /// changes.add_file(FileChange::new(
    ///     PathBuf::from("file2.ts"),
    ///     PathBuf::from("file2.ts"),
    ///     FileChangeType::Modified,
    /// ));
    ///
    /// let added = changes.files_by_type(FileChangeType::Added);
    /// assert_eq!(added.len(), 1);
    /// ```
    #[must_use]
    pub fn files_by_type(&self, change_type: FileChangeType) -> Vec<&FileChange> {
        self.files.iter().filter(|f| f.change_type == change_type).collect()
    }

    /// Checks if package.json was modified.
    ///
    /// # Examples
    ///
    /// ```rust,ignore
    /// # use sublime_pkg_tools::changes::{PackageChanges, FileChange, FileChangeType};
    /// # use sublime_standard_tools::monorepo::WorkspacePackage;
    /// # use std::path::PathBuf;
    /// let workspace_pkg = WorkspacePackage::new(
    ///     "@myorg/core".to_string(),
    ///     "1.0.0".to_string(),
    ///     PathBuf::from("packages/core"),
    ///     PathBuf::from("/workspace/packages/core"),
    /// );
    /// let mut changes = PackageChanges::new(workspace_pkg);
    ///
    /// changes.add_file(FileChange::new(
    ///     PathBuf::from("packages/core/package.json"),
    ///     PathBuf::from("package.json"),
    ///     FileChangeType::Modified,
    /// ));
    ///
    /// assert!(changes.package_json_modified());
    /// ```
    #[must_use]
    pub fn package_json_modified(&self) -> bool {
        self.files.iter().any(|f| f.is_package_json())
    }

    /// Groups files by directory (relative to package root).
    ///
    /// # Examples
    ///
    /// ```rust,ignore
    /// # use sublime_pkg_tools::changes::{PackageChanges, FileChange, FileChangeType};
    /// # use sublime_standard_tools::monorepo::WorkspacePackage;
    /// # use std::path::PathBuf;
    /// let workspace_pkg = WorkspacePackage::new(
    ///     "@myorg/core".to_string(),
    ///     "1.0.0".to_string(),
    ///     PathBuf::from("packages/core"),
    ///     PathBuf::from("/workspace/packages/core"),
    /// );
    /// let mut changes = PackageChanges::new(workspace_pkg);
    ///
    /// changes.add_file(FileChange::new(
    ///     PathBuf::from("packages/core/src/index.ts"),
    ///     PathBuf::from("src/index.ts"),
    ///     FileChangeType::Modified,
    /// ));
    /// changes.add_file(FileChange::new(
    ///     PathBuf::from("packages/core/src/utils.ts"),
    ///     PathBuf::from("src/utils.ts"),
    ///     FileChangeType::Added,
    /// ));
    ///
    /// let by_dir = changes.files_by_directory();
    /// assert!(by_dir.contains_key(std::path::Path::new("src")));
    /// ```
    #[must_use]
    pub fn files_by_directory(&self) -> HashMap<PathBuf, Vec<&FileChange>> {
        let mut result: HashMap<PathBuf, Vec<&FileChange>> = HashMap::new();

        for file in &self.files {
            let dir = file.package_relative_dir().unwrap_or_else(|| Path::new("")).to_path_buf();
            result.entry(dir).or_default().push(file);
        }

        result
    }

    /// Returns files grouped by extension.
    ///
    /// # Examples
    ///
    /// ```rust,ignore
    /// # use sublime_pkg_tools::changes::{PackageChanges, FileChange, FileChangeType};
    /// # use sublime_standard_tools::monorepo::WorkspacePackage;
    /// # use std::path::PathBuf;
    /// let workspace_pkg = WorkspacePackage::new(
    ///     "@myorg/core".to_string(),
    ///     "1.0.0".to_string(),
    ///     PathBuf::from("packages/core"),
    ///     PathBuf::from("/workspace/packages/core"),
    /// );
    /// let mut changes = PackageChanges::new(workspace_pkg);
    ///
    /// changes.add_file(FileChange::new(
    ///     PathBuf::from("file1.ts"),
    ///     PathBuf::from("file1.ts"),
    ///     FileChangeType::Modified,
    /// ));
    /// changes.add_file(FileChange::new(
    ///     PathBuf::from("file2.json"),
    ///     PathBuf::from("file2.json"),
    ///     FileChangeType::Modified,
    /// ));
    ///
    /// let by_ext = changes.files_by_extension();
    /// assert_eq!(by_ext.get("ts").map(|v| v.len()), Some(1));
    /// ```
    #[must_use]
    pub fn files_by_extension(&self) -> HashMap<String, Vec<&FileChange>> {
        let mut result: HashMap<String, Vec<&FileChange>> = HashMap::new();

        for file in &self.files {
            if let Some(ext) = file.extension() {
                result.entry(ext.to_string()).or_default().push(file);
            } else {
                result.entry("(no extension)".to_string()).or_default().push(file);
            }
        }

        result
    }

    /// Returns all added files.
    #[must_use]
    pub fn added_files(&self) -> Vec<&FileChange> {
        self.files.iter().filter(|f| f.is_addition()).collect()
    }

    /// Returns all modified files.
    #[must_use]
    pub fn modified_files(&self) -> Vec<&FileChange> {
        self.files.iter().filter(|f| f.is_modification()).collect()
    }

    /// Returns all deleted files.
    #[must_use]
    pub fn deleted_files(&self) -> Vec<&FileChange> {
        self.files.iter().filter(|f| f.is_deletion()).collect()
    }
}

/// Default WorkspacePackage for deserialization.
fn default_workspace_package() -> WorkspacePackage {
    WorkspacePackage {
        name: String::new(),
        version: String::new(),
        location: PathBuf::new(),
        absolute_path: PathBuf::new(),
        workspace_dependencies: Vec::new(),
        workspace_dev_dependencies: Vec::new(),
    }
}