@codeyam/codeyam-cli 0.1.0-staging.dbc742d → 0.1.0-staging.df25827

package/codeyam-cli/src/utils/__tests__/glossaryAdd.test.js

@@ -0,0 +1,177 @@
+import { validateGlossaryEntry, mergeGlossaryEntries } from "../glossaryAdd.js";
+describe('glossaryAdd', () => {
+    describe('validateGlossaryEntry', () => {
+        it('should accept a valid entry with all required fields', () => {
+            const result = validateGlossaryEntry({
+                name: 'DrinkCard',
+                filePath: 'app/components/DrinkCard.tsx',
+                description: 'Displays a single drink item',
+            });
+            expect(result.valid).toBe(true);
+            expect(result.error).toBeUndefined();
+        });
+        it('should reject missing name', () => {
+            const result = validateGlossaryEntry({
+                filePath: 'app/components/DrinkCard.tsx',
+                description: 'Displays a single drink item',
+            });
+            expect(result.valid).toBe(false);
+            expect(result.error).toContain('name');
+        });
+        it('should reject missing filePath', () => {
+            const result = validateGlossaryEntry({
+                name: 'DrinkCard',
+                description: 'Displays a single drink item',
+            });
+            expect(result.valid).toBe(false);
+            expect(result.error).toContain('filePath');
+        });
+        it('should reject missing description', () => {
+            const result = validateGlossaryEntry({
+                name: 'DrinkCard',
+                filePath: 'app/components/DrinkCard.tsx',
+            });
+            expect(result.valid).toBe(false);
+            expect(result.error).toContain('description');
+        });
+        it('should reject non-object input', () => {
+            expect(validateGlossaryEntry('string').valid).toBe(false);
+            expect(validateGlossaryEntry(null).valid).toBe(false);
+            expect(validateGlossaryEntry(42).valid).toBe(false);
+        });
+    });
+    describe('mergeGlossaryEntries', () => {
+        it('should append new entry to empty array', () => {
+            const result = mergeGlossaryEntries([], [
+                {
+                    name: 'DrinkCard',
+                    filePath: 'app/components/DrinkCard.tsx',
+                    description: 'A drink card',
+                },
+            ]);
+            expect(result.entries).toHaveLength(1);
+            expect(result.entries[0].name).toBe('DrinkCard');
+            expect(result.added).toBe(1);
+            expect(result.updated).toBe(0);
+            expect(result.errors).toHaveLength(0);
+        });
+        it('should append new entry to existing array', () => {
+            const existing = [
+                {
+                    name: 'Header',
+                    filePath: 'app/components/Header.tsx',
+                    description: 'Page header',
+                },
+            ];
+            const result = mergeGlossaryEntries(existing, [
+                {
+                    name: 'DrinkCard',
+                    filePath: 'app/components/DrinkCard.tsx',
+                    description: 'A drink card',
+                },
+            ]);
+            expect(result.entries).toHaveLength(2);
+            expect(result.added).toBe(1);
+            expect(result.updated).toBe(0);
+        });
+        it('should update existing entry when name + filePath match', () => {
+            const existing = [
+                {
+                    name: 'DrinkCard',
+                    filePath: 'app/components/DrinkCard.tsx',
+                    description: 'Old description',
+                },
+            ];
+            const result = mergeGlossaryEntries(existing, [
+                {
+                    name: 'DrinkCard',
+                    filePath: 'app/components/DrinkCard.tsx',
+                    description: 'New description',
+                },
+            ]);
+            expect(result.entries).toHaveLength(1);
+            expect(result.entries[0].description).toBe('New description');
+            expect(result.added).toBe(0);
+            expect(result.updated).toBe(1);
+        });
+        it('should handle mix of new and updated entries', () => {
+            const existing = [
+                {
+                    name: 'Header',
+                    filePath: 'app/components/Header.tsx',
+                    description: 'Page header',
+                },
+                {
+                    name: 'DrinkCard',
+                    filePath: 'app/components/DrinkCard.tsx',
+                    description: 'Old',
+                },
+            ];
+            const result = mergeGlossaryEntries(existing, [
+                {
+                    name: 'DrinkCard',
+                    filePath: 'app/components/DrinkCard.tsx',
+                    description: 'Updated',
+                },
+                {
+                    name: 'Footer',
+                    filePath: 'app/components/Footer.tsx',
+                    description: 'Page footer',
+                },
+            ]);
+            expect(result.entries).toHaveLength(3);
+            expect(result.added).toBe(1);
+            expect(result.updated).toBe(1);
+            // Updated entry should preserve its position
+            expect(result.entries[1].name).toBe('DrinkCard');
+            expect(result.entries[1].description).toBe('Updated');
+        });
+        it('should return correct added/updated counts', () => {
+            const existing = [
+                { name: 'A', filePath: 'a.ts', description: 'a' },
+                { name: 'B', filePath: 'b.ts', description: 'b' },
+            ];
+            const result = mergeGlossaryEntries(existing, [
+                { name: 'A', filePath: 'a.ts', description: 'updated a' },
+                { name: 'C', filePath: 'c.ts', description: 'new c' },
+                { name: 'D', filePath: 'd.ts', description: 'new d' },
+            ]);
+            expect(result.added).toBe(2);
+            expect(result.updated).toBe(1);
+            expect(result.entries).toHaveLength(4);
+        });
+        it('should preserve extra fields on existing entries not in incoming', () => {
+            const existing = [
+                {
+                    name: 'DrinkCard',
+                    filePath: 'app/components/DrinkCard.tsx',
+                    description: 'Old',
+                    returnType: 'JSX.Element',
+                    testFile: 'tests/DrinkCard.test.ts',
+                },
+            ];
+            const result = mergeGlossaryEntries(existing, [
+                {
+                    name: 'DrinkCard',
+                    filePath: 'app/components/DrinkCard.tsx',
+                    description: 'New',
+                },
+            ]);
+            expect(result.entries[0].returnType).toBe('JSX.Element');
+            expect(result.entries[0].testFile).toBe('tests/DrinkCard.test.ts');
+            expect(result.entries[0].description).toBe('New');
+        });
+        it('should report errors for invalid entries', () => {
+            const result = mergeGlossaryEntries([], [
+                { name: 'Good', filePath: 'a.ts', description: 'valid' },
+                { filePath: 'b.ts', description: 'missing name' },
+                { name: 'Also Good', filePath: 'c.ts', description: 'valid' },
+            ]);
+            expect(result.entries).toHaveLength(2);
+            expect(result.added).toBe(2);
+            expect(result.errors).toHaveLength(1);
+            expect(result.errors[0].index).toBe(1);
+        });
+    });
+});
+//# sourceMappingURL=glossaryAdd.test.js.map

package/codeyam-cli/src/utils/__tests__/glossaryAdd.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"glossaryAdd.test.js","sourceRoot":"","sources":["../../../../../src/utils/__tests__/glossaryAdd.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAE7E,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;QACrC,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;YAC9D,MAAM,MAAM,GAAG,qBAAqB,CAAC;gBACnC,IAAI,EAAE,WAAW;gBACjB,QAAQ,EAAE,8BAA8B;gBACxC,WAAW,EAAE,8BAA8B;aAC5C,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAChC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;YACpC,MAAM,MAAM,GAAG,qBAAqB,CAAC;gBACnC,QAAQ,EAAE,8BAA8B;gBACxC,WAAW,EAAE,8BAA8B;aAC5C,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACjC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;YACxC,MAAM,MAAM,GAAG,qBAAqB,CAAC;gBACnC,IAAI,EAAE,WAAW;gBACjB,WAAW,EAAE,8BAA8B;aAC5C,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACjC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;YAC3C,MAAM,MAAM,GAAG,qBAAqB,CAAC;gBACnC,IAAI,EAAE,WAAW;gBACjB,QAAQ,EAAE,8BAA8B;aACzC,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACjC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;YACxC,MAAM,CAAC,qBAAqB,CAAC,QAAe,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACjE,MAAM,CAAC,qBAAqB,CAAC,IAAW,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC7D,MAAM,CAAC,qBAAqB,CAAC,EAAS,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;QACpC,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAChD,MAAM,MAAM,GAAG,oBAAoB,CACjC,EAAE,EACF;gBACE;oBACE,IAAI,EAAE,WAAW;oBACjB,QAAQ,EAAE,8BAA8B;oBACxC,WAAW,EAAE,cAAc;iBAC5B;aACF,CACF,CAAC;YACF,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACjD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC7B,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC/B,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACnD,MAAM,QAAQ,GAAG;gBACf;oBACE,IAAI,EAAE,QAAQ;oBACd,QAAQ,EAAE,2BAA2B;oBACrC,WAAW,EAAE,aAAa;iBAC3B;aACF,CAAC;YACF,MAAM,MAAM,GAAG,oBAAoB,CAAC,QAAQ,EAAE;gBAC5C;oBACE,IAAI,EAAE,WAAW;oBACjB,QAAQ,EAAE,8BAA8B;oBACxC,WAAW,EAAE,cAAc;iBAC5B;aACF,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC7B,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;YACjE,MAAM,QAAQ,GAAG;gBACf;oBACE,IAAI,EAAE,WAAW;oBACjB,QAAQ,EAAE,8BAA8B;oBACxC,WAAW,EAAE,iBAAiB;iBAC/B;aACF,CAAC;YACF,MAAM,MAAM,GAAG,oBAAoB,CAAC,QAAQ,EAAE;gBAC5C;oBACE,IAAI,EAAE,WAAW;oBACjB,QAAQ,EAAE,8BAA8B;oBACxC,WAAW,EAAE,iBAAiB;iBAC/B;aACF,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAC9D,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC7B,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,MAAM,QAAQ,GAAG;gBACf;oBACE,IAAI,EAAE,QAAQ;oBACd,QAAQ,EAAE,2BAA2B;oBACrC,WAAW,EAAE,aAAa;iBAC3B;gBACD;oBACE,IAAI,EAAE,WAAW;oBACjB,QAAQ,EAAE,8BAA8B;oBACxC,WAAW,EAAE,KAAK;iBACnB;aACF,CAAC;YACF,MAAM,MAAM,GAAG,oBAAoB,CAAC,QAAQ,EAAE;gBAC5C;oBACE,IAAI,EAAE,WAAW;oBACjB,QAAQ,EAAE,8BAA8B;oBACxC,WAAW,EAAE,SAAS;iBACvB;gBACD;oBACE,IAAI,EAAE,QAAQ;oBACd,QAAQ,EAAE,2BAA2B;oBACrC,WAAW,EAAE,aAAa;iBAC3B;aACF,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC7B,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC/B,6CAA6C;YAC7C,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACjD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,MAAM,QAAQ,GAAG;gBACf,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE;gBACjD,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE;aAClD,CAAC;YACF,MAAM,MAAM,GAAG,oBAAoB,CAAC,QAAQ,EAAE;gBAC5C,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE;gBACzD,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE;gBACrD,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE;aACtD,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC7B,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC/B,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kEAAkE,EAAE,GAAG,EAAE;YAC1E,MAAM,QAAQ,GAAG;gBACf;oBACE,IAAI,EAAE,WAAW;oBACjB,QAAQ,EAAE,8BAA8B;oBACxC,WAAW,EAAE,KAAK;oBAClB,UAAU,EAAE,aAAa;oBACzB,QAAQ,EAAE,yBAAyB;iBACpC;aACF,CAAC;YACF,MAAM,MAAM,GAAG,oBAAoB,CAAC,QAAQ,EAAE;gBAC5C;oBACE,IAAI,EAAE,WAAW;oBACjB,QAAQ,EAAE,8BAA8B;oBACxC,WAAW,EAAE,KAAK;iBACnB;aACF,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YACzD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;YACnE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;YAClD,MAAM,MAAM,GAAG,oBAAoB,CACjC,EAAE,EACF;gBACE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE;gBACxD,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,cAAc,EAAS;gBACxD,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE;aAC9D,CACF,CAAC;YACF,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC7B,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACtC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}