test: jest setup and unit tests

Author: coltenkrauter

jest.config.js

@@ -0,0 +1,27 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+export default {
+	preset: 'ts-jest/presets/default-esm',
+	testEnvironment: 'node',
+	extensionsToTreatAsEsm: ['.ts'],
+	moduleNameMapper: {
+		'^(\\.{1,2}/.*)\\.js$': '$1',
+	},
+	transform: {
+		'^.+\\.tsx?$': [
+			'ts-jest',
+			{
+				useESM: true,
+			},
+		],
+	},
+	rootDir: '.',
+	testMatch: ['<rootDir>/tests/**/*.test.ts'],
+	collectCoverageFrom: [
+		'src/**/*.ts',
+		'!src/**/*.d.ts',
+		'!src/**/index.ts',
+		'!src/**/structures.ts',
+	],
+	coverageDirectory: 'coverage',
+	coverageReporters: ['text', 'lcov', 'html'],
+} 

package.json

@@ -29,7 +29,10 @@
     "fix": "npm run lint -- --fix",
     "lint": "npx eslint src/**",
     "prepare": "husky || true",
-    "test": "npm run lint",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest",
+    "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch",
+    "test:coverage": "NODE_OPTIONS=--experimental-vm-modules jest --coverage",
+    "test:ci": "NODE_OPTIONS=--experimental-vm-modules jest --ci --coverage --reporters=default --reporters=jest-junit",
     "upgrade:all": "npx npm-check-updates -u && npm install"
   },
   "license": "ISC",
@@ -52,6 +55,7 @@
     "@vercel/ncc": "^0.38.3",
     "husky": "9.1.7",
     "jest": "^29.7.0",
+    "jest-junit": "^16.0.0",
     "make-coverage-badge": "^1.2.0",
     "ts-jest": "^29.3.0",
     "ts-node": "^10.9.2",

tests/utils/misc.test.ts

@@ -0,0 +1,51 @@
+import { getAgeBasedEmoji, getRelativeHumanReadableAge, haveOrHas } from '../../src/utils/misc.js'
+
+describe('Utils: Misc', () => {
+	describe('getAgeBasedEmoji', () => {
+		it('should return empty string for hours <= 8', () => {
+			expect(getAgeBasedEmoji(8)).toBe('')
+			expect(getAgeBasedEmoji(7)).toBe('')
+			expect(getAgeBasedEmoji(0)).toBe('')
+		})
+
+		it('should return a random emoji for hours > 8', () => {
+			const result = getAgeBasedEmoji(9)
+			expect(result).toMatch(/ :(red-sus|rish_sus):/)
+		})
+	})
+
+	describe('getRelativeHumanReadableAge', () => {
+		it('should return "in the last hour" for less than 1 hour', () => {
+			expect(getRelativeHumanReadableAge(0.5)).toBe('in the last hour')
+		})
+
+		it('should return hours with pluralization', () => {
+			expect(getRelativeHumanReadableAge(1)).toBe('1 hour ago')
+			expect(getRelativeHumanReadableAge(2)).toBe('2 hours ago')
+		})
+
+		it('should return days with pluralization', () => {
+			expect(getRelativeHumanReadableAge(24)).toBe('1 day ago')
+			expect(getRelativeHumanReadableAge(48)).toBe('2 days ago')
+		})
+
+		it('should handle without "ago" suffix', () => {
+			expect(getRelativeHumanReadableAge(1, false)).toBe('1 hour')
+			expect(getRelativeHumanReadableAge(2, false)).toBe('2 hours')
+			expect(getRelativeHumanReadableAge(24, false)).toBe('1 day')
+			expect(getRelativeHumanReadableAge(48, false)).toBe('2 days')
+		})
+	})
+
+	describe('haveOrHas', () => {
+		it('should return "has" for singular', () => {
+			expect(haveOrHas(1)).toBe('has')
+		})
+
+		it('should return "have" for plural', () => {
+			expect(haveOrHas(0)).toBe('have')
+			expect(haveOrHas(2)).toBe('have')
+			expect(haveOrHas(10)).toBe('have')
+		})
+	})
+}) 

tests/utils/slack/blocks.test.ts

@@ -0,0 +1,138 @@
+import { getContextMarkdownBlock, getEmojiBlocks, getFirstBlocks, getLastBlocks } from '../../../src/utils/slack/blocks.js'
+
+describe('Utils: Slack', () => {
+	describe('Blocks', () => {
+		describe('getContextMarkdownBlock', () => {
+			it('should create a context block with markdown text', () => {
+				const result = getContextMarkdownBlock('test markdown')
+				expect(result).toHaveLength(1)
+				expect(result[0]).toEqual({
+					elements: [
+						{
+							text: 'test markdown',
+							type: 'mrkdwn',
+						},
+					],
+					type: 'context',
+				})
+			})
+
+			it('should include indentation when specified', () => {
+				const result = getContextMarkdownBlock('test markdown', true)
+				expect(result).toHaveLength(1)
+				expect(result[0]).toEqual({
+					elements: [
+						{
+							text: ' ',
+							type: 'plain_text',
+						},
+						{
+							text: 'test markdown',
+							type: 'mrkdwn',
+						},
+					],
+					type: 'context',
+				})
+			})
+		})
+
+		describe('getEmojiBlocks', () => {
+			it('should return empty array when no emoji name provided', () => {
+				expect(getEmojiBlocks()).toEqual([])
+			})
+
+			it('should create rich text section blocks', () => {
+				const result = getEmojiBlocks('smile')
+				expect(result).toEqual([
+					{
+						name: 'smile',
+						type: 'emoji',
+					},
+					{
+						text: ' ',
+						type: 'text',
+					},
+				])
+			})
+
+			it('should create context blocks', () => {
+				const result = getEmojiBlocks('smile', 'context')
+				expect(result).toEqual([
+					{
+						emoji: true,
+						text: ':smile:',
+						type: 'plain_text',
+					},
+				])
+			})
+		})
+
+		describe('getFirstBlocks', () => {
+			it('should create header and action blocks', () => {
+				const result = getFirstBlocks(['org1'], 'Test Header')
+				expect(result).toHaveLength(2)
+				expect(result[0]).toEqual({
+					text: {
+						emoji: true,
+						text: 'Test Header',
+						type: 'plain_text',
+					},
+					type: 'header',
+				})
+				expect(result[1]).toEqual({
+					elements: [
+						{
+							text: {
+								emoji: true,
+								text: 'Org1 Org',
+								type: 'plain_text',
+							},
+							type: 'button',
+							url: 'https://github.com/org1',
+						},
+						{
+							text: {
+								emoji: true,
+								text: 'Org1 PRs',
+								type: 'plain_text',
+							},
+							type: 'button',
+							url: 'https://github.com/pulls?q=is%3Aopen+is%3Apr+archived%3Afalse+draft%3Afalse+user%3Aorg1',
+						},
+					],
+					type: 'actions',
+				})
+			})
+
+			it('should include sub-header text when provided', () => {
+				const result = getFirstBlocks(['org1'], 'Test Header', 'Sub-header text')
+				expect(result).toHaveLength(3)
+				expect(result[1]).toEqual({
+					elements: [
+						{
+							text: 'Sub-header text',
+							type: 'mrkdwn',
+						},
+					],
+					type: 'context',
+				})
+			})
+		})
+
+		describe('getLastBlocks', () => {
+			it('should create context block with footer text', () => {
+				const result = getLastBlocks('footer text')
+				expect(result).toHaveLength(1)
+				expect(result[0]).toEqual({
+					elements: [
+						{
+							text: 'footer text',
+							type: 'mrkdwn',
+						},
+					],
+					type: 'context',
+				})
+			})
+		})
+	})
+}) 

tsconfig.json

@@ -13,10 +13,12 @@
     "allowArbitraryExtensions": true,
     "verbatimModuleSyntax": false,
     "resolveJsonModule": true,
+    "isolatedModules": true
   },
   "include": [
     "src/**/*.ts",
-    "src/**/*.tsx"
+    "src/**/*.tsx",
+    "tests/**/*.ts"
   ],
   "exclude": ["node_modules", ".vscode"],
   "ts-node": {