@temir.ra/create-ts-lib 0.4.1 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Version 0
 
+## 0.5.0
+
+1. Changed `buildinfo.txt` generation and testing to align with [https://semver.org](https://semver.org).
+
 ## 0.4.1
 
 1. Fixed `destinationPath` resolution in `cli.ts` to use the full resolved path instead of just the basename.

package/buildinfo.txt

@@ -1 +1 @@
-0.4.1+afad763
+0.5.0+68f9673

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temir.ra/create-ts-lib",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "Typescript library template",
   "author": "temir.ra",
   "license": "MIT",

package/template/scripts/buildinfo.ts

@@ -5,7 +5,7 @@ import { readFileSync, writeFileSync } from 'fs';
 const BUILD_INFO_FILE = 'buildinfo.txt';
 const GIT_COMMAND = 'git rev-parse --short HEAD';
 
-const { version } = JSON.parse(readFileSync('package.json', 'utf-8'));
+const version: string = JSON.parse(readFileSync('package.json', 'utf-8')).version;
 
 let gitHash = '';
 try {
@@ -14,8 +14,12 @@ try {
         .trim();
 } catch { }
 
-const buildinfo = gitHash ? `${version}+${gitHash}` : version;
+const buildinfo = gitHash
+    ? version.includes('+')
+        ? `${version}.${gitHash}`
+        : `${version}+${gitHash}`
+    : version;
 
-writeFileSync(BUILD_INFO_FILE, buildinfo);
+writeFileSync(BUILD_INFO_FILE, buildinfo.trim(), 'utf-8');
 
 console.log(`'${BUILD_INFO_FILE}' has been updated with build info: ${buildinfo}`);

package/template/tests/buildinfo.test.ts

@@ -2,28 +2,22 @@ import { describe, it, expect } from 'bun:test';
 import { readFileSync } from 'fs';
 import { fileURLToPath } from 'url';
 
-const buildinfoUrl = new URL('../buildinfo.txt', import.meta.url);
 
+const buildinfoUrl = new URL('../buildinfo.txt', import.meta.url);
 
-describe('buildInfo', () => {
+// taken from https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
+// Captures: [1]=major, [2]=minor, [3]=patch, [4]=pre-release, [5]=build-metadata
+const SEMVER_REGEX =
+    /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/;
 
-    it('should follow semantic versioning format with optional commit hash', () => {
-        const buildinfoPath = fileURLToPath(buildinfoUrl);
-        const buildinfo = readFileSync(buildinfoPath, 'utf-8').trim();
-        expect(buildinfo).toMatch(/^\d+\.\d+\.\d+(-[a-zA-Z0-9.-]+)?(\+[a-zA-Z0-9.-]+)?$/);
-    });
+function readBuildinfo(): string {
+    return readFileSync(fileURLToPath(buildinfoUrl), 'utf-8').trim();
+}
 
-    it('should not contain whitespace', () => {
-        const buildinfoPath = fileURLToPath(buildinfoUrl);
-        const buildinfo = readFileSync(buildinfoPath, 'utf-8').trim();
-        expect(buildinfo).not.toMatch(/\s/);
-    });
+describe('buildInfo', () => {
 
-    it('should not be empty or dash', () => {
-        const buildinfoPath = fileURLToPath(buildinfoUrl);
-        const buildinfo = readFileSync(buildinfoPath, 'utf-8').trim();
-        expect(buildinfo.length).toBeGreaterThan(0);
-        expect(buildinfo).not.toBe('-');
+    it('should be a valid semver string', () => {
+        expect(readBuildinfo()).toMatch(SEMVER_REGEX);
     });
 
-});
+});