@vitus-labs/tools-favicon 1.5.2-alpha.4 → 1.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vitus-labs/tools-favicon",
-  "version": "1.5.2-alpha.4+45b8634",
+  "version": "1.6.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -29,15 +29,16 @@
   },
   "scripts": {
     "prepublish": "bun run build",
-    "build": "rm -rf lib && tsc"
+    "build": "rm -rf lib && tsc",
+    "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@vitus-labs/tools-core": "1.5.2-alpha.4+45b8634",
+    "@vitus-labs/tools-core": "1.6.0",
     "favicons": "^7.2.0"
   },
   "devDependencies": {
-    "@vitus-labs/tools-typescript": "1.5.2-alpha.4+45b8634",
+    "@vitus-labs/tools-typescript": "1.6.0",
     "typescript": "^5.9.3"
   },
-  "gitHead": "45b863472eafa888f12f8f56d347dd20b72cd4f9"
+  "gitHead": "cb7b3bfa4e5730ecb95b3c886d23074a3ce9e85f"
 }

package/src/baseConfig.test.ts

@@ -0,0 +1,47 @@
+import { describe, expect, it } from 'vitest'
+import { configuration } from './baseConfig.js'
+
+describe('favicon baseConfig', () => {
+  it('should have correct default display settings', () => {
+    expect(configuration.dir).toBe('auto')
+    expect(configuration.lang).toBe('en-US')
+    expect(configuration.display).toBe('standalone')
+    expect(configuration.orientation).toBe('any')
+  })
+
+  it('should have correct color settings', () => {
+    expect(configuration.background).toBe('#fff')
+    expect(configuration.theme_color).toBe('#fff')
+  })
+
+  it('should have apple status bar style', () => {
+    expect(configuration.appleStatusBarStyle).toBe('black-translucent')
+  })
+
+  it('should have correct URL settings', () => {
+    expect(configuration.scope).toBe('/')
+    expect(configuration.start_url).toBe('/?homescreen=1')
+  })
+
+  it('should have logging disabled by default', () => {
+    expect(configuration.logging).toBe(false)
+    expect(configuration.pixel_art).toBe(false)
+    expect(configuration.loadManifestWithCredentials).toBe(false)
+  })
+
+  it('should have all icon platforms enabled', () => {
+    const { icons } = configuration
+    expect(icons.android).toBe(true)
+    expect(icons.appleIcon).toBe(true)
+    expect(icons.appleStartup).toBe(true)
+    expect(icons.coast).toBe(true)
+    expect(icons.favicons).toBe(true)
+    expect(icons.firefox).toBe(true)
+    expect(icons.windows).toBe(true)
+    expect(icons.yandex).toBe(true)
+  })
+
+  it('should have version string', () => {
+    expect(configuration.version).toBe('1.0')
+  })
+})

package/src/generateFavicon.test.ts

@@ -0,0 +1,82 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest'
+
+const mockWriteFileSync = vi.fn()
+vi.mock('node:fs', () => ({
+  default: { writeFileSync: mockWriteFileSync },
+  writeFileSync: mockWriteFileSync,
+}))
+
+const mockFavicons = vi.fn()
+vi.mock('favicons', () => ({ default: mockFavicons }))
+
+vi.mock('@vitus-labs/tools-core', () => ({
+  VL_CONFIG: (_key: string) => ({
+    config: {},
+    get: vi.fn(),
+    merge: (config: any) => ({
+      config: {
+        ...config,
+        icons: [
+          { input: 'src/icon.png', output: 'public/icons', path: 'icons' },
+        ],
+        path: '/assets',
+      },
+    }),
+  }),
+}))
+
+describe('generateFavicons', () => {
+  beforeEach(() => {
+    mockWriteFileSync.mockClear()
+    mockFavicons.mockClear()
+  })
+
+  it('should generate favicons for each icon config', async () => {
+    mockFavicons.mockResolvedValue({
+      images: [{ name: 'favicon.ico', contents: Buffer.from('icon') }],
+      files: [{ name: 'manifest.json', contents: Buffer.from('{}') }],
+    })
+
+    vi.resetModules()
+    const { generateFavicons } = await import('./generateFavicon.js')
+
+    await generateFavicons()
+
+    expect(mockFavicons).toHaveBeenCalledTimes(1)
+    expect(mockWriteFileSync).toHaveBeenCalledTimes(2)
+  })
+
+  it('should handle favicon generation errors', async () => {
+    const consoleSpy = vi
+      .spyOn(console, 'log')
+      .mockImplementation(() => undefined)
+
+    mockFavicons.mockRejectedValue(new Error('Generation failed'))
+
+    vi.resetModules()
+    const { generateFavicons } = await import('./generateFavicon.js')
+
+    await generateFavicons()
+
+    expect(consoleSpy).toHaveBeenCalledWith('Generation failed')
+    consoleSpy.mockRestore()
+  })
+
+  it('should write images and manifests to output path', async () => {
+    mockFavicons.mockResolvedValue({
+      images: [
+        { name: 'icon-192.png', contents: Buffer.from('192') },
+        { name: 'icon-512.png', contents: Buffer.from('512') },
+      ],
+      files: [{ name: 'manifest.webmanifest', contents: Buffer.from('{}') }],
+    })
+
+    vi.resetModules()
+    const { generateFavicons } = await import('./generateFavicon.js')
+
+    await generateFavicons()
+
+    // 2 images + 1 manifest
+    expect(mockWriteFileSync).toHaveBeenCalledTimes(3)
+  })
+})

package/tsconfig.json

@@ -8,5 +8,5 @@
     "declarationDir": "./lib/types"
   },
   "include": ["src"],
-  "exclude": ["node_modules", "__stories__", "lib"]
+  "exclude": ["node_modules", "__stories__", "lib", "**/*.test.ts"]
 }

package/vitest.config.ts

@@ -0,0 +1,3 @@
+import { createVitestConfig } from '../../vitest.shared.js'
+
+export default createVitestConfig()