test: add vitest setup and unit tests; chore: migrate to pnpm and add coverage

- Enable Corepack and pin pnpm via packageManager
- Remove yarn.lock and install via pnpm
- Add vitest and @vitest/coverage-v8; configure vitest
- Refactor index.js to export pure functions and defer env validation
- Add tests for buildChart and replaceCodestatsSection
- Update CI workflow to use pnpm and run tests + coverage

Author: vergissberlin

.github/workflows/docker-publish.yml

@@ -26,7 +26,28 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9.12.0
+          run_install: false
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
       - name: Run tests
+        run: pnpm test
+
+      - name: Run coverage
+        run: pnpm coverage
+
+      - name: Build Docker image for testing
         run: |
           if [ -f docker-compose.test.yml ]; then
             docker-compose --file docker-compose.test.yml build

index.js

@@ -10,65 +10,79 @@ if (typeof process.env.INPUT_DEBUG !== 'undefined') {
 	console.log(process.env)
 }
 
-// Validate environment varialbes
-if (typeof process.env.INPUT_CODESTATS_USERNAME == 'undefined')
-	throw new Error('InvalidArgumentExcpetion – The CODESTATS_USERNAME has to be set!')
+/**
+ * Create options from environment variables
+ */
+function createOptions() {
+	// Validate environment variables
+	if (typeof process.env.INPUT_CODESTATS_USERNAME == 'undefined')
+		throw new Error('InvalidArgumentExcpetion – The CODESTATS_USERNAME has to be set!')
 
-// Options
-const options = {
-	codestats: {
-		username: String(process.env.INPUT_CODESTATS_USERNAME),
-		url: `https://codestats.net/api/users/${process.env.INPUT_CODESTATS_USERNAME}`,
-		profile: `https://codestats.net/users/${process.env.INPUT_CODESTATS_USERNAME}`
-	},
-	git: {
-		username: String(process.env.GITHUB_ACTOR) || 'CodeStats bot',
-		message: String(process.env.INPUT_COMMIT_MESSAGE) || 'Update codestats metrics',
-		token: String(process.env.INPUT_GITHUB_TOKEN)
-	},
-	graph: {
-		width: Number(process.env.INPUT_GRAPH_WIDTH) || 42
-	},
-	readmeFile: String(process.env.INPUT_README_FILE) ? `${process.env.INPUT_README_FILE}` : `./README.md`,
-	show: {
-		title: Boolean(process.env.INPUT_SHOW_TITLE) || false,
-		link: Boolean(process.env.INPUT_SHOW_LINK) || false
+	return {
+		codestats: {
+			username: String(process.env.INPUT_CODESTATS_USERNAME),
+			url: `https://codestats.net/api/users/${process.env.INPUT_CODESTATS_USERNAME}`,
+			profile: `https://codestats.net/users/${process.env.INPUT_CODESTATS_USERNAME}`
+		},
+		git: {
+			username: String(process.env.GITHUB_ACTOR) || 'CodeStats bot',
+			message: String(process.env.INPUT_COMMIT_MESSAGE) || 'Update codestats metrics',
+			token: String(process.env.INPUT_GITHUB_TOKEN)
+		},
+		graph: {
+			width: Number(process.env.INPUT_GRAPH_WIDTH) || 42
+		},
+		readmeFile: String(process.env.INPUT_README_FILE) ? `${process.env.INPUT_README_FILE}` : `./README.md`,
+		show: {
+			title: Boolean(process.env.INPUT_SHOW_TITLE) || false,
+			link: Boolean(process.env.INPUT_SHOW_LINK) || false
+		}
 	}
 }
 
+// Lazily created options used by runtime start()
+let options = null
+
 /**
  * Request callback
  *
  * @param {*} error
  * @param {*} response
  * @param {*} body
  */
-const callback = function (error, response, body) {
-	if (!error && response.statusCode == 200) {
-		const languages = Object.entries(JSON.parse(body).languages)
-		updateReadme(buildChart(languages), commitChanges)
+const makeCallback = function (opts) {
+	return function (error, response, body) {
+		if (!error && response.statusCode == 200) {
+			const languages = Object.entries(JSON.parse(body).languages)
+			const updateReadmeForOpts = makeUpdateReadme(opts)
+			const commitChangesForOpts = makeCommitChanges(opts)
+			updateReadmeForOpts(buildChart(languages, opts.graph.width), commitChangesForOpts)
+		}
 	}
 }
 
 /**
  * Commit changes in README file
  */
-const commitChanges = function () {
-	const git = simpleGit()
-	if (typeof process.env.INPUT_DEBUG !== 'undefined') {
-		console.log('::: Commit changes')
-		git.status()
+const makeCommitChanges = function (opts) {
+	return function () {
+		const git = simpleGit()
+		if (typeof process.env.INPUT_DEBUG !== 'undefined') {
+			console.log('::: Commit changes')
+			git.status()
+		}
+		git.commit(opts.git.message, opts.readmeFile, { '--author': opts.git.username }).push()
 	}
-	git.commit(options.git.message, options.readmeFile, { '--author': options.git.username }).push()
 }
 
 /**
  * Build chart with data
  *
  * @param {Array} data
+ * @param {number} width
  * @returns {String}
  */
-const buildChart = function (data) {
+const buildChart = function (data, width = 42) {
 	let languageChart = {}
 
 	data.sort(function (a, b) {
@@ -80,7 +94,24 @@ const buildChart = function (data) {
 			[key]: value.xps
 		})
 	})
-	return bars(languageChart, { bar: '█', width: options.graph.width })
+	return bars(languageChart, { bar: '█', width })
+}
+
+/**
+ * Replace the codestats section in markdown content
+ *
+ * @param {string} markdown
+ * @param {string} content
+ * @param {string} header
+ * @param {string} footer
+ * @returns {string}
+ */
+const replaceCodestatsSection = function (markdown, content, header = '', footer = '') {
+	const replacement = `<!-- START_SECTION:codestats -->\n${header}\`\`\`text\n${content}\`\`\`\n${footer}<!-- END_SECTION:codestats -->`
+	return markdown.replace(
+		/((<!--.*START_SECTION:codestats.*-->)([\s\S]+)(<!--.*END_SECTION:codestats.*-->))/g,
+		replacement
+	)
 }
 
 /**
@@ -90,26 +121,46 @@ const buildChart = function (data) {
  * @param {*} callback
  * @returns {void}
  */
-const updateReadme = function (content, callback) {
-	fs.readFile(options.readmeFile, 'utf8', function (err, data) {
-		let header = options.show.title ? `*Language experience level (Last update ${new Date().toUTCString()})*\n\n` : '',
-			footer = options.show.link ? `\n> My [CodeStats profile](${options.codestats.profile}) in detail.\n` : ''
+const makeUpdateReadme = function (opts) {
+	return function (content, callback) {
+		fs.readFile(opts.readmeFile, 'utf8', function (err, data) {
+			let header = opts.show.title ? `*Language experience level (Last update ${new Date().toUTCString()})*\n\n` : '',
+				footer = opts.show.link ? `\n> My [CodeStats profile](${opts.codestats.profile}) in detail.\n` : ''
 
-		if (err) {
-			console.log(err)
-		}
-		let replacement = `<!-- START_SECTION:codestats -->\n${header}\`\`\`text\n${content}\`\`\`\n${footer}<!-- END_SECTION:codestats -->`
-		let result = data.replace(
-			/((<!--.*START_SECTION:codestats.*-->)([\s\S]+)(<!--.*END_SECTION:codestats.*-->))/g,
-			replacement
-		)
+			if (err) {
+				console.log(err)
+			}
+			const result = replaceCodestatsSection(data, content, header, footer)
 
-		fs.writeFile(options.readmeFile, result, 'utf8', function (err) {
-			if (err) console.log(err)
-			callback()
+			fs.writeFile(opts.readmeFile, result, 'utf8', function (err) {
+				if (err) console.log(err)
+				callback()
+			})
 		})
-	})
+	}
+}
+
+/**
+ * Start the action if called directly
+ */
+function start() {
+	const opts = createOptions()
+	const callback = makeCallback(opts)
+	request(opts.codestats, callback)
 }
 
-// Init request
-request(options.codestats, callback)
+// Export functions for testing
+module.exports = {
+	buildChart,
+	replaceCodestatsSection,
+	createOptions,
+	makeCallback,
+	makeUpdateReadme,
+	makeCommitChanges,
+	start
+}
+
+// Init request if called directly
+if (require.main === module) {
+	start()
+}