|
| 1 | +/* |
| 2 | + * The MIT License (MIT) |
| 3 | + * |
| 4 | + * Copyright (c) 2015 - present Instructure, Inc. |
| 5 | + * |
| 6 | + * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 7 | + * of this software and associated documentation files (the "Software"), to deal |
| 8 | + * in the Software without restriction, including without limitation the rights |
| 9 | + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 10 | + * copies of the Software, and to permit persons to whom the Software is |
| 11 | + * furnished to do so, subject to the following conditions: |
| 12 | + * |
| 13 | + * The above copyright notice and this permission notice shall be included in all |
| 14 | + * copies or substantial portions of the Software. |
| 15 | + * |
| 16 | + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 17 | + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 18 | + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 19 | + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 20 | + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 21 | + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 22 | + * SOFTWARE. |
| 23 | + */ |
| 24 | + |
| 25 | +import { describe, it, expect, afterEach, vi } from 'vitest' |
| 26 | +import { mkdtempSync, mkdirSync, writeFileSync, readFileSync, rmSync } from 'fs' |
| 27 | +import { tmpdir } from 'os' |
| 28 | +import { join } from 'path' |
| 29 | +import generateCustomIndex from '../icons/generate-custom-index.ts' |
| 30 | + |
| 31 | +describe('generateCustomIndex', () => { |
| 32 | + let dir: string |
| 33 | + |
| 34 | + afterEach(() => { |
| 35 | + if (dir) rmSync(dir, { recursive: true, force: true }) |
| 36 | + vi.restoreAllMocks() |
| 37 | + }) |
| 38 | + |
| 39 | + function setupFixtures() { |
| 40 | + dir = mkdtempSync(join(tmpdir(), 'gen-custom-')) + '/' |
| 41 | + mkdirSync(dir + 'svg/Custom', { recursive: true }) |
| 42 | + writeFileSync( |
| 43 | + dir + 'svg/Custom/ai-info.svg', |
| 44 | + '<svg viewBox="0 0 24 24"><path d="M0,0" fill="currentColor"/></svg>' |
| 45 | + ) |
| 46 | + writeFileSync( |
| 47 | + dir + 'svg/Custom/canvas-logo.svg', |
| 48 | + '<svg viewBox="0 0 32 32"><circle cx="16" cy="16" r="8"/></svg>' |
| 49 | + ) |
| 50 | + vi.spyOn(process, 'cwd').mockReturnValue(dir.slice(0, -1)) |
| 51 | + vi.spyOn(console, 'log').mockImplementation(() => {}) |
| 52 | + } |
| 53 | + |
| 54 | + it('writes one InstUIIcon export per SVG file', () => { |
| 55 | + setupFixtures() |
| 56 | + generateCustomIndex() |
| 57 | + const content = readFileSync( |
| 58 | + dir + 'src/generated/custom/index.tsx', |
| 59 | + 'utf-8' |
| 60 | + ) |
| 61 | + const exportCount = (content.match(/^export const /gm) || []).length |
| 62 | + expect(exportCount).toBe(2) |
| 63 | + }) |
| 64 | + |
| 65 | + it('converts kebab-case filenames to PascalCase icon names', () => { |
| 66 | + setupFixtures() |
| 67 | + generateCustomIndex() |
| 68 | + const content = readFileSync( |
| 69 | + dir + 'src/generated/custom/index.tsx', |
| 70 | + 'utf-8' |
| 71 | + ) |
| 72 | + expect(content).toContain('export const AiInfoInstUIIcon') |
| 73 | + expect(content).toContain('export const CanvasLogoInstUIIcon') |
| 74 | + }) |
| 75 | + |
| 76 | + it('forwards the SVG viewBox to wrapCustomIcon', () => { |
| 77 | + setupFixtures() |
| 78 | + generateCustomIndex() |
| 79 | + const content = readFileSync( |
| 80 | + dir + 'src/generated/custom/index.tsx', |
| 81 | + 'utf-8' |
| 82 | + ) |
| 83 | + expect(content).toContain( |
| 84 | + "wrapCustomIcon(AiInfoPaths, 'AiInfo', '0 0 24 24')" |
| 85 | + ) |
| 86 | + expect(content).toContain( |
| 87 | + "wrapCustomIcon(CanvasLogoPaths, 'CanvasLogo', '0 0 32 32')" |
| 88 | + ) |
| 89 | + }) |
| 90 | + |
| 91 | + it('rewrites fill="currentColor" to ={color} so consumers can theme the icon', () => { |
| 92 | + setupFixtures() |
| 93 | + generateCustomIndex() |
| 94 | + const content = readFileSync( |
| 95 | + dir + 'src/generated/custom/index.tsx', |
| 96 | + 'utf-8' |
| 97 | + ) |
| 98 | + expect(content).toContain('fill={color}') |
| 99 | + expect(content).not.toContain('fill="currentColor"') |
| 100 | + }) |
| 101 | + |
| 102 | + it('throws if the svg/Custom directory does not exist', () => { |
| 103 | + dir = mkdtempSync(join(tmpdir(), 'gen-custom-')) + '/' |
| 104 | + vi.spyOn(process, 'cwd').mockReturnValue(dir.slice(0, -1)) |
| 105 | + vi.spyOn(console, 'log').mockImplementation(() => {}) |
| 106 | + expect(() => generateCustomIndex()).toThrow(/SVG directory not found/) |
| 107 | + }) |
| 108 | +}) |
0 commit comments