Add themes (#2)

* Add socio theme

* Add generator package and theme script

* Add support for themes in Logger

* Add getTheme function to retrieve logger options from a theme

jest.config.ts

@@ -19,7 +19,9 @@ export default {
   // An array of glob patterns indicating a set of files for which coverage information should be collected
   collectCoverageFrom: [
     'src/**/*.ts',
+    '!src/**/_generated/**',
     '!src/**/types.ts',
+    '!src/themes/**',
     '!src/index.ts',
     '!src/sandbox.ts',
   ],

package.json

@@ -4,8 +4,9 @@
   "description": "A logging utility for managing and displaying logs in a structured manner.",
   "author": "CasperSocio",
   "scripts": {
-    "build": "tsc",
+    "build": "npm run generate:theme && tsc",
     "dev": "ts-node src/sandbox.ts",
+    "generate:theme": "ts-node scripts/generateThemeTypes.ts",
     "prepare": "husky install",
     "test": "jest",
     "test:ci": "jest --ci --coverage=false",
@@ -36,6 +37,7 @@
   ],
   "license": "MIT",
   "devDependencies": {
+    "@socio-development/generator": "^0.1.0-alpha.3",
     "@types/jest": "^29.5.11",
     "@types/node": "^20.10.4",
     "husky": "^8.0.3",

scripts/generateThemeTypes.ts

@@ -0,0 +1,30 @@
+import { generate } from '@socio-development/generator'
+import { existsSync, readdirSync } from 'fs'
+import { resolve } from 'path'
+
+const rootPath = resolve('.')
+const themesPath = resolve(rootPath, 'src', 'themes')
+
+if (!existsSync(themesPath)) {
+  throw new Error(`Themes path does not exist: ${themesPath}`)
+}
+
+const themeFiles = readdirSync(themesPath)
+const themeNames = themeFiles
+  .filter((file) => file.endsWith('.ts'))
+  .map((file) => file.replace('.ts', ''))
+
+const code = `
+export const themeNames = ['${themeNames.join("', '")}'] as const
+
+export type ThemeName = (typeof themeNames)[number]
+
+`
+
+console.log(code)
+
+generate({
+  code,
+  file: 'theme.ts',
+  path: 'src',
+})

src/__tests__/classes/Logger.test.ts

@@ -10,6 +10,12 @@ describe('Logger', () => {
 
       expect(logger).toBeInstanceOf(Logger)
     })
+
+    it('should create a new logger with a theme', () => {
+      const logger = new Logger('socio')
+
+      expect(logger).toBeInstanceOf(Logger)
+    })
   })
 
   describe('.entries', () => {

src/_generated/theme.ts

@@ -0,0 +1,3 @@
+export const themeNames = ['socio'] as const
+
+export type ThemeName = (typeof themeNames)[number]

src/classes/Logger.ts

@@ -4,6 +4,7 @@ import {
   LoggerData,
   LoggerOptions,
 } from 'src/types'
+import { ThemeName } from '../_generated/theme'
 import LogEntry from './LogEntry'
 
 const defaultOptions: LoggerConfig = {
@@ -48,23 +49,34 @@ export default class Logger {
   private _separator: string
   private _timestampFormat: string
 
-  constructor(options: Partial<LoggerOptions> = {}) {
-    if (options.indentSize && options.indentSize < 1) {
+  constructor(theme?: ThemeName)
+  constructor(options?: LoggerOptions)
+  constructor(optionsOrTheme: LoggerOptions | ThemeName = {}) {
+    let config: LoggerOptions
+
+    if (typeof optionsOrTheme === 'string') {
+      const theme = require(`../themes/${optionsOrTheme}`).default
+      config = theme
+    } else {
+      config = optionsOrTheme
+    }
+
+    if (config.indentSize && config.indentSize < 1) {
       throw new Error('Indent size must be greater than 0')
     }
 
     this._currentIndent = 0
-    this._indentSize = options.indentSize || defaultOptions.indentSize
+    this._indentSize = config.indentSize || defaultOptions.indentSize
     this._entries = []
-    this._prefix = options.prefix
-    this._separator = options.separator || defaultOptions.separator
+    this._prefix = config.prefix
+    this._separator = config.separator || defaultOptions.separator
     this._timestampFormat =
-      options.timestampFormat || defaultOptions.timestampFormat
+      config.timestampFormat || defaultOptions.timestampFormat
 
-    if (options.composition) {
+    if (config.composition) {
       this._composition = {
         ...defaultOptions.composition,
-        ...options.composition,
+        ...config.composition,
       }
     } else {
       this._composition = defaultOptions.composition

src/index.ts

@@ -1 +1,19 @@
+import { ThemeName } from './_generated/theme'
+import { LoggerOptions } from './types'
+
 export { default as Logger } from './classes/Logger'
+
+/**
+ * Gets the logger options from a theme.
+ * @param theme The theme name.
+ * @returns The logger options.
+ */
+export function getTheme(theme: ThemeName): LoggerOptions {
+  const options = require(`./themes/${theme}`).default
+
+  if (!options) {
+    throw new Error(`Theme "${theme}" does not contain a valid configuration.`)
+  }
+
+  return options
+}

src/themes/socio.ts

@@ -0,0 +1,42 @@
+import { LoggerConfig } from 'src/types'
+
+export default {
+  composition: {
+    default: [
+      'timestamp',
+      'color:socio',
+      'prefix',
+      'color:reset',
+      'indent',
+      'message',
+    ],
+    error: [
+      'timestamp',
+      'color:socio',
+      'prefix',
+      'color:red',
+      'indent',
+      'message',
+    ],
+    info: [
+      'timestamp',
+      'color:socio',
+      'prefix',
+      'color:blue',
+      'indent',
+      'message',
+    ],
+    warn: [
+      'timestamp',
+      'color:socio',
+      'prefix',
+      'color:yellow',
+      'indent',
+      'message',
+    ],
+  },
+  indentSize: 2,
+  prefix: '[SOCIO]',
+  separator: ' ',
+  timestampFormat: 'HH:mm:ss',
+} satisfies LoggerConfig