refactor: use the same implementation pattern as the 'yaml' updater

README.md

@@ -109,6 +109,14 @@ This is going to read and update only the `<Version>` tag in the file.
 commit-and-tag-version --packageFiles <YOUR-PROJECT-NAME>.csproj --bumpFiles <YOUR-PROJECT-NAME>.csproj
 ```
 
+### YAML Support
+
+If you are using YAML files.
+This is going to read and update only the `version:` tag in the file.
+
+```sh
+commit-and-tag-version --packageFiles file.yaml --bumpFiles file.yaml
+```
 ### OpenAPI Support
 
 If you are using OpenAPI, then just point to your `openapi.yaml` file.

lib/updaters/index.js

@@ -6,6 +6,7 @@ const updatersByType = {
   maven: require('./types/maven'),
   gradle: require('./types/gradle'),
   csproj: require('./types/csproj'),
+  yaml: require('./types/yaml'),
   openapi: require('./types/openapi'),
 };
 const PLAIN_TEXT_BUMP_FILES = ['VERSION.txt', 'version.txt'];
@@ -34,6 +35,9 @@ function getUpdaterByFilename(filename) {
   if (filename.endsWith('.csproj')) {
     return getUpdaterByType('csproj');
   }
+  if (/\.ya?ml$/.test(filename)) {
+    return getUpdaterByType('yaml');
+  }
   if (/openapi.yaml/.test(filename)) {
     return getUpdaterByType('openapi');
   }

lib/updaters/types/openapi.js

@@ -1,15 +1,15 @@
-const versionRegex = /(^.*?\r?\ninfo:\r?\n.*?version: ")([\d\w\-.]+)(".*?(?=\r?\n\w).*$)/s;
+const yaml = require('yaml');
+const detectNewline = require('detect-newline');
 
 module.exports.readVersion = function (contents) {
-  const matches = versionRegex.exec(contents);
-  if (matches === null || matches.length !== 4) {
-    throw new Error(
-      'Failed to read the version field in your openapi file - is it present?',
-    );
-  }
-  return matches[2];
-}
+  return yaml.parse(contents).info.version;
+};
 
 module.exports.writeVersion = function (contents, version) {
-  return contents.replace(versionRegex, `$1${version}$3`);
-}
+  const newline = detectNewline(contents);
+  const document = yaml.parseDocument(contents);
+
+  document.get('info').set('version', version);
+
+  return document.toString().replace(/\r?\n/g, newline);
+};

lib/updaters/types/yaml.js

@@ -0,0 +1,15 @@
+const yaml = require('yaml');
+const detectNewline = require('detect-newline');
+
+module.exports.readVersion = function (contents) {
+  return yaml.parse(contents).version;
+};
+
+module.exports.writeVersion = function (contents, version) {
+  const newline = detectNewline(contents);
+  const document = yaml.parseDocument(contents);
+
+  document.set('version', version);
+
+  return document.toString().replace(/\r?\n/g, newline);
+};

package.json

@@ -52,6 +52,7 @@
     "jsdom": "^23.2.0",
     "semver": "^7.5.4",
     "w3c-xmlserializer": "^5.0.0",
+    "yaml": "^2.4.1",
     "yargs": "^17.7.2"
   },
   "devDependencies": {

test/core.spec.js

@@ -1433,6 +1433,78 @@ describe('cli', function () {
       verifyPackageVersion({ writeFileSyncSpy, expectedVersion: '1.1.0' });
     });
 
+    it('bumps version in Dart `pubspec.yaml` file', async function () {
+      const expected = fs.readFileSync(
+        './test/mocks/pubspec-6.4.0.yaml',
+        'utf-8',
+      );
+
+      const filename = 'pubspec.yaml';
+      mock({
+        bump: 'minor',
+        realTestFiles: [
+          {
+            filename,
+            path: './test/mocks/pubspec-6.3.1.yaml',
+          },
+        ],
+      });
+
+      await exec({
+        packageFiles: [{ filename, type: 'yaml' }],
+        bumpFiles: [{ filename, type: 'yaml' }],
+      });
+
+      // filePath is the first arg passed to writeFileSync
+      const packageJsonWriteFileSynchCall = findWriteFileCallForPath({
+        writeFileSyncSpy,
+        filename,
+      });
+
+      if (!packageJsonWriteFileSynchCall) {
+        throw new Error(`writeFileSynch not invoked with path ${filename}`);
+      }
+
+      const calledWithContentStr = packageJsonWriteFileSynchCall[1];
+      expect(calledWithContentStr).toEqual(expected);
+    });
+
+    it('bumps version in Dart `pubspec.yaml` file with CRLF line endings', async function () {
+      const expected = fs.readFileSync(
+        './test/mocks/pubspec-6.4.0-crlf.yaml',
+        'utf-8',
+      );
+
+      const filename = 'pubspec.yaml';
+      mock({
+        bump: 'minor',
+        realTestFiles: [
+          {
+            filename,
+            path: './test/mocks/pubspec-6.3.1-crlf.yaml',
+          },
+        ],
+      });
+
+      await exec({
+        packageFiles: [{ filename, type: 'yaml' }],
+        bumpFiles: [{ filename, type: 'yaml' }],
+      });
+
+      // filePath is the first arg passed to writeFileSync
+      const packageJsonWriteFileSynchCall = findWriteFileCallForPath({
+        writeFileSyncSpy,
+        filename,
+      });
+
+      if (!packageJsonWriteFileSynchCall) {
+        throw new Error(`writeFileSynch not invoked with path ${filename}`);
+      }
+
+      const calledWithContentStr = packageJsonWriteFileSynchCall[1];
+      expect(calledWithContentStr).toEqual(expected);
+    });
+
     describe('skip', function () {
       it('allows bump and changelog generation to be skipped', async function () {
         const changelogContent = 'legacy header format<a name="1.0.0">\n';