standard-version 0.11.10

Semantic and calendar version bump calculation
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
//! JSON version file engines for `package.json` and `deno.json`/`deno.jsonc`.
//!
//! Provides [`JsonVersionFile`] for npm/Node `package.json` files (parsed via
//! `serde_json`) and [`DenoVersionFile`] for Deno manifests (handled with
//! line-level regex to support JSONC comments).

use std::sync::LazyLock;

use crate::version_file::{VersionFile, VersionFileError};

/// Regex pattern matching a JSON `"version"` field value.
///
/// Captures the version string in group 1.
const VERSION_PATTERN: &str = r#""version"\s*:\s*"([^"]+)""#;

/// Lazily compiled regex for `"version": "..."` fields in JSON files.
static VERSION_RE: LazyLock<regex::Regex> =
    LazyLock::new(|| regex::Regex::new(VERSION_PATTERN).expect("valid regex"));

// ---------------------------------------------------------------------------
// JsonVersionFile (package.json)
// ---------------------------------------------------------------------------

/// Version file engine for `package.json`.
///
/// Uses `serde_json` for detection and reading, and a line-level regex for
/// writing to preserve key order and formatting.
#[derive(Debug, Clone, Copy)]
pub struct JsonVersionFile;

impl VersionFile for JsonVersionFile {
    fn name(&self) -> &str {
        "package.json"
    }

    fn filenames(&self) -> &[&str] {
        &["package.json"]
    }

    fn detect(&self, content: &str) -> bool {
        let Ok(value) = serde_json::from_str::<serde_json::Value>(content) else {
            return false;
        };
        value.get("version").and_then(|v| v.as_str()).is_some()
    }

    fn read_version(&self, content: &str) -> Option<String> {
        let value: serde_json::Value = serde_json::from_str(content).ok()?;
        value
            .get("version")
            .and_then(|v| v.as_str())
            .map(|s| s.to_string())
    }

    fn write_version(&self, content: &str, new_version: &str) -> Result<String, VersionFileError> {
        let re = &*VERSION_RE;
        if !re.is_match(content) {
            return Err(VersionFileError::NoVersionField);
        }

        // Replace only the first occurrence, preserving surrounding text.
        let mut replaced = false;
        let result = re.replace(content, |caps: &regex::Captures<'_>| {
            if replaced {
                return caps[0].to_string();
            }
            replaced = true;
            let full = &caps[0];
            let version_start = caps.get(1).unwrap().start() - caps.get(0).unwrap().start();
            let version_end = caps.get(1).unwrap().end() - caps.get(0).unwrap().start();
            format!(
                "{}{}{}",
                &full[..version_start],
                new_version,
                &full[version_end..],
            )
        });

        Ok(result.into_owned())
    }
}

// ---------------------------------------------------------------------------
// DenoVersionFile (deno.json / deno.jsonc)
// ---------------------------------------------------------------------------

/// Version file engine for `deno.json` and `deno.jsonc`.
///
/// Uses line-level matching to find and replace the `"version"` field so that
/// JSONC comments are preserved. The regex matches the first occurrence of
/// `"version": "..."` in the file content.
#[derive(Debug, Clone, Copy)]
pub struct DenoVersionFile;

impl VersionFile for DenoVersionFile {
    fn name(&self) -> &str {
        "deno.json"
    }

    fn filenames(&self) -> &[&str] {
        &["deno.json", "deno.jsonc"]
    }

    fn detect(&self, content: &str) -> bool {
        VERSION_RE.is_match(content)
    }

    fn read_version(&self, content: &str) -> Option<String> {
        VERSION_RE
            .captures(content)
            .and_then(|caps| caps.get(1))
            .map(|m| m.as_str().to_string())
    }

    fn write_version(&self, content: &str, new_version: &str) -> Result<String, VersionFileError> {
        let re = &*VERSION_RE;
        if !re.is_match(content) {
            return Err(VersionFileError::NoVersionField);
        }

        // Replace only the first occurrence.
        let mut replaced = false;
        let result = re.replace(content, |caps: &regex::Captures<'_>| {
            if replaced {
                // Return the original match unchanged for subsequent occurrences.
                return caps[0].to_string();
            }
            replaced = true;
            let full = &caps[0];
            let version_start = caps.get(1).unwrap().start() - caps.get(0).unwrap().start();
            let version_end = caps.get(1).unwrap().end() - caps.get(0).unwrap().start();
            format!(
                "{}{}{}",
                &full[..version_start],
                new_version,
                &full[version_end..],
            )
        });

        Ok(result.into_owned())
    }
}

// ---------------------------------------------------------------------------
// Tests
// ---------------------------------------------------------------------------

#[cfg(test)]
mod tests {
    use super::*;

    // =======================================================================
    // JsonVersionFile
    // =======================================================================

    const PACKAGE_JSON: &str = r#"{
  "name": "my-app",
  "version": "1.2.3",
  "description": "An example package"
}
"#;

    const PACKAGE_JSON_NO_VERSION: &str = r#"{
  "name": "my-app",
  "description": "No version here"
}
"#;

    // --- detect ---

    #[test]
    fn json_detect_with_version() {
        assert!(JsonVersionFile.detect(PACKAGE_JSON));
    }

    #[test]
    fn json_detect_without_version() {
        assert!(!JsonVersionFile.detect(PACKAGE_JSON_NO_VERSION));
    }

    #[test]
    fn json_detect_invalid_json() {
        assert!(!JsonVersionFile.detect("not json at all"));
    }

    // --- read_version ---

    #[test]
    fn json_read_version() {
        assert_eq!(
            JsonVersionFile.read_version(PACKAGE_JSON),
            Some("1.2.3".to_string()),
        );
    }

    #[test]
    fn json_read_version_missing() {
        assert_eq!(JsonVersionFile.read_version(PACKAGE_JSON_NO_VERSION), None);
    }

    // --- write_version ---

    #[test]
    fn json_write_version_updates_value() {
        let result = JsonVersionFile
            .write_version(PACKAGE_JSON, "2.0.0")
            .unwrap();
        assert!(result.contains(r#""version": "2.0.0""#));
    }

    #[test]
    fn json_write_version_preserves_other_fields() {
        let result = JsonVersionFile
            .write_version(PACKAGE_JSON, "2.0.0")
            .unwrap();
        assert!(result.contains(r#""name": "my-app""#));
        assert!(result.contains(r#""description": "An example package""#));
    }

    #[test]
    fn json_write_version_preserves_key_order() {
        let input = r#"{
  "name": "my-app",
  "version": "1.0.0",
  "description": "example",
  "main": "index.js"
}
"#;
        let result = JsonVersionFile.write_version(input, "2.0.0").unwrap();
        // Key order must be identical to the input.
        let expected = r#"{
  "name": "my-app",
  "version": "2.0.0",
  "description": "example",
  "main": "index.js"
}
"#;
        assert_eq!(result, expected);
    }

    #[test]
    fn json_write_version_trailing_newline() {
        let result = JsonVersionFile
            .write_version(PACKAGE_JSON, "2.0.0")
            .unwrap();
        assert!(result.ends_with('\n'));
    }

    #[test]
    fn json_write_version_no_field_returns_error() {
        let err = JsonVersionFile.write_version(PACKAGE_JSON_NO_VERSION, "1.0.0");
        assert!(err.is_err());
    }

    // =======================================================================
    // DenoVersionFile
    // =======================================================================

    const DENO_JSON: &str = r#"{
  "version": "0.5.0",
  "tasks": {
    "dev": "deno run --watch main.ts"
  }
}
"#;

    const DENO_JSONC: &str = r#"{
  // The current release version.
  "version": "0.5.0",
  "tasks": {
    "dev": "deno run --watch main.ts"
  }
}
"#;

    const DENO_NO_VERSION: &str = r#"{
  "tasks": {
    "dev": "deno run --watch main.ts"
  }
}
"#;

    // --- detect ---

    #[test]
    fn deno_detect_json() {
        assert!(DenoVersionFile.detect(DENO_JSON));
    }

    #[test]
    fn deno_detect_jsonc() {
        assert!(DenoVersionFile.detect(DENO_JSONC));
    }

    #[test]
    fn deno_detect_no_version() {
        assert!(!DenoVersionFile.detect(DENO_NO_VERSION));
    }

    // --- read_version ---

    #[test]
    fn deno_read_version_json() {
        assert_eq!(
            DenoVersionFile.read_version(DENO_JSON),
            Some("0.5.0".to_string()),
        );
    }

    #[test]
    fn deno_read_version_jsonc() {
        assert_eq!(
            DenoVersionFile.read_version(DENO_JSONC),
            Some("0.5.0".to_string()),
        );
    }

    #[test]
    fn deno_read_version_missing() {
        assert_eq!(DenoVersionFile.read_version(DENO_NO_VERSION), None);
    }

    // --- write_version ---

    #[test]
    fn deno_write_version_json() {
        let result = DenoVersionFile.write_version(DENO_JSON, "1.0.0").unwrap();
        assert!(result.contains(r#""version": "1.0.0""#));
        // Other content preserved.
        assert!(result.contains("tasks"));
    }

    #[test]
    fn deno_write_version_jsonc_preserves_comments() {
        let result = DenoVersionFile.write_version(DENO_JSONC, "1.0.0").unwrap();
        assert!(result.contains(r#""version": "1.0.0""#));
        assert!(result.contains("// The current release version."));
    }

    #[test]
    fn deno_write_version_no_field_returns_error() {
        let err = DenoVersionFile.write_version(DENO_NO_VERSION, "1.0.0");
        assert!(err.is_err());
    }

    // =======================================================================
    // Integration tests with tempdir
    // =======================================================================

    #[test]
    fn integration_update_package_json() {
        use crate::version_file::update_version_files;

        let dir = tempfile::tempdir().unwrap();
        let pkg = dir.path().join("package.json");
        std::fs::write(&pkg, PACKAGE_JSON).unwrap();

        let results = update_version_files(dir.path(), "3.0.0", &[]).unwrap();

        assert_eq!(results.len(), 1);
        assert_eq!(results[0].old_version, "1.2.3");
        assert_eq!(results[0].new_version, "3.0.0");
        assert_eq!(results[0].name, "package.json");

        let on_disk = std::fs::read_to_string(&pkg).unwrap();
        assert!(on_disk.contains(r#""version": "3.0.0""#));
    }

    #[test]
    fn integration_update_deno_json() {
        use crate::version_file::update_version_files;

        let dir = tempfile::tempdir().unwrap();
        let deno = dir.path().join("deno.json");
        std::fs::write(&deno, DENO_JSON).unwrap();

        let results = update_version_files(dir.path(), "1.0.0", &[]).unwrap();

        assert_eq!(results.len(), 1);
        assert_eq!(results[0].old_version, "0.5.0");
        assert_eq!(results[0].new_version, "1.0.0");
        assert_eq!(results[0].name, "deno.json");

        let on_disk = std::fs::read_to_string(&deno).unwrap();
        assert!(on_disk.contains(r#""version": "1.0.0""#));
    }

    #[test]
    fn integration_update_deno_jsonc() {
        use crate::version_file::update_version_files;

        let dir = tempfile::tempdir().unwrap();
        let deno = dir.path().join("deno.jsonc");
        std::fs::write(&deno, DENO_JSONC).unwrap();

        let results = update_version_files(dir.path(), "2.0.0", &[]).unwrap();

        assert_eq!(results.len(), 1);
        assert_eq!(results[0].old_version, "0.5.0");
        assert_eq!(results[0].new_version, "2.0.0");
        assert_eq!(results[0].name, "deno.json");

        let on_disk = std::fs::read_to_string(&deno).unwrap();
        assert!(on_disk.contains(r#""version": "2.0.0""#));
        assert!(on_disk.contains("// The current release version."));
    }
}