HCL doc update. Add YAML doc separator.

Author: cliffano

CHANGELOG.md

@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Added
+- Add HCL resource type support
+
+### Changed
+- YAML writing ensures --- document separator header
+
+### Fixed
+- Fix YAML unit test data incorrectly provided JSON
+
 ## 4.0.0 - 2025-07-02
 ### Changed
 - Switch release workflow to use release-action

README.md

@@ -167,6 +167,8 @@ Example `hcl` resource configuration:
       ]
     }
 
+NOTE: This requires 
+
 ### Managing version on Makefile file
 
 Example `makefile` resource configuration:

lib/resource-types/hcl.js

@@ -6,7 +6,7 @@ import hcl from 'hcl2-parser';
 
 /**
  * Set version value in the HCL resource's property (defined in dot-notation).
- * This will use hcledit CLI tool (https://github.com/minamijoyo/hcledit) to
+ * This uses hcledit CLI tool (https://github.com/minamijoyo/hcledit) to
  * modify the HCL file because there is no node.js library that can write HCL
  * files in a safe way while preserving original formatting. NOTE: hcledit
  * must be installed and available in the PATH for this to work.

lib/resource-types/yaml.js

@@ -17,12 +17,22 @@ function setVersion(version, resource, opts, cb) {
   const data = jsYaml.load(fs.readFileSync(resource.path, 'UTF-8'));
   setProperty(data, property, version);
   if (!opts.dryRun) {
-    fs.writeFile(resource.path, jsYaml.dump(data, { indent: 2 }), cb);
+    fs.writeFile(resource.path, _yamlDumpWithHeader(data), cb);
   } else {
     cb();
   }
 }
 
+/**
+ * Prepend YAML header (--- document separator) if missing.
+ * @param {String} data: the YAML data
+ * @returns {String} the YAML data with header
+ */
+function _yamlDumpWithHeader(data) {
+  const _data = jsYaml.dump(data, { indent: 2 });
+  return _data.startsWith('---\n') ? _data : `---\n${_data}`;
+}
+
 /**
  * Get version value from the YAML resource's property (defined in dot-notation).
  *

package-lock.json

@@ -5,6 +5,7 @@
   "keywords": [
     "release",
     "versioning",
+    "hcl",
     "json",
     "makefile",
     "text",
@@ -54,6 +55,7 @@
     "@iarna/toml": "^2.2.5"
   },
   "devDependencies": {
+    "esmock": "^2.7.3",
     "@sinonjs/referee": "^11.0.1",
     "sinon": "^21.0.0"
   },

package.json

@@ -42,8 +42,8 @@ describe('yaml', function() {
           property: 'version'
         }
       };
-      this.mockFs.expects('readFileSync').once().withExactArgs('someplaybook.yaml', 'UTF-8').returns('{ "version": "0.0.0" }');
-      this.mockFs.expects('writeFile').once().withExactArgs('someplaybook.yaml', 'version: 1.2.3\n', sinon.match.func).callsArgWith(2, null);
+      this.mockFs.expects('readFileSync').once().withExactArgs('someplaybook.yaml', 'UTF-8').returns('version: "0.0.0"');
+      this.mockFs.expects('writeFile').once().withExactArgs('someplaybook.yaml', '---\nversion: 1.2.3\n', sinon.match.func).callsArgWith(2, null);
       function cb(err, result) {
         assert.equal(err, null);
         done();
@@ -58,14 +58,30 @@ describe('yaml', function() {
           property: 'versions[1].minor'
         }
       };
-      this.mockFs.expects('readFileSync').once().withExactArgs('someplaybook.yaml', 'UTF-8').returns('{ "versions": [{ "major": 1, "minor": 2, "patch": 3 }, { "major": 8, "minor": 9, "patch": 0 }] }');
-      this.mockFs.expects('writeFile').once().withExactArgs('someplaybook.yaml', 'versions:\n  - major: 1\n    minor: 2\n    patch: 3\n  - major: 8\n    minor: 9\n    patch: 0\n', sinon.match.func).callsArgWith(2, null);
+      this.mockFs.expects('readFileSync').once().withExactArgs('someplaybook.yaml', 'UTF-8').returns('---\nversions:\n  - major: 1\n    minor: 2\n    patch: 3\n  - major: 8\n    minor: 9\n    patch: 0\n');
+      this.mockFs.expects('writeFile').once().withExactArgs('someplaybook.yaml', '---\nversions:\n  - major: 1\n    minor: 2\n    patch: 3\n  - major: 8\n    minor: 9\n    patch: 0\n', sinon.match.func).callsArgWith(2, null);
       function cb(err, result) {
         assert.equal(err, null);
         done();
       }
       resourceType.setReleaseVersion(9, resource, { dryRun: false }, cb);
     });
+    it('should not double up document separator YAML header when it already exists', function(done) {
+      const resource = {
+        path: 'someplaybook.yaml',
+        type: 'yaml',
+        params: {
+          property: 'version'
+        }
+      };
+      this.mockFs.expects('readFileSync').once().withExactArgs('someplaybook.yaml', 'UTF-8').returns('---\nversion: "0.0.0"');
+      this.mockFs.expects('writeFile').once().withExactArgs('someplaybook.yaml', '---\nversion: 1.2.3\n', sinon.match.func).callsArgWith(2, null);
+      function cb(err, result) {
+        assert.equal(err, null);
+        done();
+      }
+      resourceType.setReleaseVersion('1.2.3', resource, { dryRun: false }, cb);
+    });
   });
 
   describe('getVersion', function() {
@@ -77,7 +93,7 @@ describe('yaml', function() {
           property: 'version'
         }
       };
-      this.mockFs.expects('readFile').once().withExactArgs('someplaybook.yaml', 'UTF-8', sinon.match.func).callsArgWith(2, null, '{ "version": "0.0.0" }');
+      this.mockFs.expects('readFile').once().withExactArgs('someplaybook.yaml', 'UTF-8', sinon.match.func).callsArgWith(2, null, 'version: "0.0.0"');
       function cb(err, result) {
         assert.equal(err, null);
         assert.equal(result, '0.0.0');
@@ -93,7 +109,7 @@ describe('yaml', function() {
           property: 'versions[1].minor'
         }
       };
-      this.mockFs.expects('readFile').once().withExactArgs('someplaybook.yaml', 'UTF-8', sinon.match.func).callsArgWith(2, null, '{ "versions": [{ "major": 1, "minor": 2, "patch": 3 }, { "major": 8, "minor": 9, "patch": 0 }] }');
+      this.mockFs.expects('readFile').once().withExactArgs('someplaybook.yaml', 'UTF-8', sinon.match.func).callsArgWith(2, null, '---\nversions:\n  - major: 1\n    minor: 2\n    patch: 3\n  - major: 8\n    minor: 9\n    patch: 0\n');
       function cb(err, result) {
         assert.equal(err, null);
         assert.equal(result, 9);