1 - Initialize Script to auto-version (#2)

* 1 - Initialize script

* 1 - Only console log the new version

* 1 - Update node version to v23.4.0 to remove warnings

* 1 - Update README docs on how to use npm library

* 1 - Add initialize-script details

* 1 - Update NPM Readme Docs

* 1 - error if there's no package.json

* 1 - Write tests

* 1 - update pr template

Author: TheBookKnight

.github/pull_request_template.md

@@ -1,3 +1,7 @@
-# PR
+# Pull Request
 
-Insert notes here
+Add PR details here
+
+## Testing Instructions (or AC)
+
+Add testing instructions or AC here

.github/workflows/deploy.yml

@@ -0,0 +1,25 @@
+name: Publish Package to npmjs
+
+# Trigger the workflow on a new release in Github
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      # Setup .npmrc file to publish to npm
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          registry-url: "https://registry.npmjs.org"
+          cache: "npm"
+      - run: npm ci
+      - run: npm publish --provenance --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,17 @@
+name: Tests Workflow
+
+on:
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          cache: "npm"
+      - run: npm ci
+      - run: npm run test

.nvmrc

@@ -1 +1 @@
-v23.1.0
+v23.4.0

README.md

@@ -1,11 +1,57 @@
-# nodejs
+# npm-gitver
 
-Nodejs template. Use node version in nvmrc file
+`npm-gitver` is an NPM library for managing versioning in your Node.js projects using Git tags.
 
+## Installation
+
+Install the library using npm:
+
+```bash
+npm install npm-gitver --save-dev
 ```
-nvm use
+
+## Usage
+
+### Running via npm script
+
+1. Ensure you are using the correct Node.js version specified in the `.nvmrc` file:
+
+   ```bash
+   nvm use
+   ```
+
+2. Add a script in your `package.json` to run `npm-gitver`:
+
+   ```json
+   "scripts": {
+     "version": "npm-gitver"
+   }
+   ```
+
+3. Run the versioning script:
+
+   ```bash
+   npm run version
+   ```
+
+   This will automatically update your project version based on Git tags.
+
+### Running directly via CLI
+
+You can also run `npm-gitver` directly using `npx` without adding it to your `package.json`:
+
+```bash
+npx npm-gitver
 ```
 
+This will execute the package directly from the command line, creating or updating the version based on Git tags.
+
 ## Linting
 
-https://eslint.org/docs/latest/
+Follow best practices for linting your code. Refer to the ESLint documentation for setup and configuration:
+
+[ESLint Documentation](https://eslint.org/docs/latest/)
+
+## Additional Information
+
+For more details on how `npm-gitver` works, refer to the [GitHub repository](https://github.com/your-repo/npm-gitver).

bin/npm-gitver.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+
+const { generateGitVersion } = require('../index');
+
+const version = generateGitVersion();
+console.log(version);

index.js

@@ -0,0 +1,33 @@
+const fs = require('fs');
+const childProcess = require('child_process');
+const path = require('path');
+
+function getShortGitSHA() {
+    return childProcess.execSync('git rev-parse --short HEAD').toString().trim();
+}
+
+function readPackageJson() {
+    const pkgPath = path.resolve(process.cwd(), 'package.json');
+    if (!fs.existsSync(pkgPath)) {
+        throw new Error('package.json not found in the current working directory.');
+    }
+    const raw = fs.readFileSync(pkgPath);
+    return JSON.parse(raw);
+}
+
+function generateGitVersion() {
+    const sha = getShortGitSHA();
+    const pkg = readPackageJson();
+
+    if (!pkg.version) {
+        throw new Error('The "version" key is missing in package.json.');
+    }
+    const baseVersion = pkg.version.split('-')[0]; // remove any pre-release suffix
+    const newVersion = `${baseVersion}-${sha}`;
+
+    return newVersion;
+}
+
+module.exports = {
+    generateGitVersion,
+};

package-lock.json

@@ -1,30 +1,34 @@
 {
-  "name": "nodejs",
+  "name": "npm-gitver",
   "version": "1.0.0",
-  "description": "Node template",
+  "description": "npm gitver is a simple command line tool that allows you to easily manage your git versioning.",
+  "bin": {
+    "npm-gitver": "./bin/npm-gitver.js"
+  },
   "keywords": [
     "nodejs",
-    "javascript"
+    "javascript",
+    "git"
   ],
-  "homepage": "https://github.com/TheBookKnight/nodejs#readme",
+  "homepage": "https://github.com/TheBookKnight/npm-gitver#readme",
   "bugs": {
-    "url": "https://github.com/TheBookKnight/nodejs/issues"
+    "url": "https://github.com/TheBookKnight/npm-gitver/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/TheBookKnight/nodejs.git"
+    "url": "git+https://github.com/TheBookKnight/npm-gitver.git"
   },
   "license": "ISC",
   "author": "Joshua Cadavez",
-  "type": "commonjs",
   "main": "index.js",
   "scripts": {
     "lint": "eslint .",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "node --test"
   },
   "devDependencies": {
     "@eslint/js": "^9.21.0",
     "eslint": "^9.21.0",
-    "globals": "^16.0.0"
+    "globals": "^16.0.0",
+    "sinon": "^20.0.0"
   }
-}
+}