Merge pull request #125 from rkotze/create-coauthor-file

Fix: Create global coauthor file

Author: rkotze

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 Follows [Semantic Versioning](https://semver.org/).
 
+## git-mob-core 0.9.1
+
+### Fixes
+
+- When creating a new `.git-coauthors` using the `createCoAuthorsFile` it is created only globally by providing internally the global path.
+
 ## git-mob-core 0.9.0
 
 ### Added

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "git-mob-core",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "description": "Git Mob Core library to manage co-authoring",
   "homepage": "https://github.com/rkotze/git-mob/blob/master/packages/git-mob-core/README.md",
   "main": "./dist/index.js",

packages/git-mob-core/package-lock.json

@@ -2,7 +2,7 @@ import { existsSync } from 'node:fs';
 import { mockGitAuthors as mockGitAuthorsFn } from '../../test-helpers/author-mocks';
 import { Author } from '../author';
 import { createCoAuthorsFile } from './create-coauthors-file';
-import { gitAuthors } from '.';
+import { gitAuthors, globalGitCoAuthorsPath } from '.';
 
 jest.mock('node:fs');
 jest.mock('.');
@@ -23,12 +23,21 @@ test('Throw error if coauthor file exists', async () => {
 });
 
 test('Save coauthor file in home directory', async () => {
+  const defaultAuthor = {
+    pa: {
+      name: 'Placeholder Author',
+      email: 'placeholder@author.org',
+    },
+  };
   mockExistsSync.mockReturnValueOnce(false);
   const mockGitAuthorsObject = mockGitAuthorsFn(['jo', 'hu']);
   mockGitAuthors.mockReturnValue(mockGitAuthorsObject);
 
   await expect(createCoAuthorsFile()).resolves.toEqual(true);
-  expect(mockGitAuthorsObject.overwrite).toHaveBeenCalled();
+  expect(mockGitAuthorsObject.overwrite).toHaveBeenCalledWith(
+    { coauthors: defaultAuthor },
+    globalGitCoAuthorsPath()
+  );
 });
 
 test('Save coauthor file with defined coauthor list', async () => {
@@ -49,7 +58,10 @@ test('Save coauthor file with defined coauthor list', async () => {
     createCoAuthorsFile([new Author('rk', 'rich kid', 'richkid@gmail.com')])
   ).resolves.toEqual(true);
 
-  expect(mockGitAuthorsObject.overwrite).toHaveBeenCalledWith({
-    coauthors: expectAuthor,
-  });
+  expect(mockGitAuthorsObject.overwrite).toHaveBeenCalledWith(
+    {
+      coauthors: expectAuthor,
+    },
+    globalGitCoAuthorsPath()
+  );
 });

packages/git-mob-core/package.json

@@ -4,14 +4,14 @@ import { gitAuthors, gitCoauthorsFileName, globalGitCoAuthorsPath } from './inde
 
 const coAuthorSchema = {
   coauthors: {
-    hh: {
-      name: 'Hulk Hogan',
-      email: 'hulk_hogan22@hotmail.org',
+    pa: {
+      name: 'Placeholder Author',
+      email: 'placeholder@author.org',
     },
   },
 };
 
-export async function createCoAuthorsFile(authorList: Author[]): Promise<boolean> {
+export async function createCoAuthorsFile(authorList?: Author[]): Promise<boolean> {
   const authorOps = gitAuthors();
   const coAuthorFilePath: string = globalGitCoAuthorsPath();
   if (existsSync(coAuthorFilePath)) {
@@ -20,9 +20,9 @@ export async function createCoAuthorsFile(authorList: Author[]): Promise<boolean
 
   if (authorList && authorList.length > 0) {
     const schema = authorOps.toObject(authorList);
-    await authorOps.overwrite(schema);
+    await authorOps.overwrite(schema, coAuthorFilePath);
   } else {
-    await authorOps.overwrite(coAuthorSchema);
+    await authorOps.overwrite(coAuthorSchema, coAuthorFilePath);
   }
 
   return true;

packages/git-mob-core/src/git-mob-api/git-authors/create-coauthors-file.spec.ts

@@ -14,18 +14,18 @@ export function gitAuthors(
   overwriteFilePromise?: () => Promise<void>
 ) {
   return {
-    read: async () => {
+    read: async (path?: string) => {
       const readPromise = readFilePromise || promisify(fs.readFile);
       const authorJsonString = (await readPromise(
-        await pathToCoAuthors()
+        path || (await pathToCoAuthors())
       )) as string;
       return JSON.parse(authorJsonString) as CoAuthorSchema;
     },
 
-    overwrite: async (authorJson: CoAuthorSchema) => {
+    overwrite: async (authorJson: CoAuthorSchema, path?: string) => {
       const overwritePromise = overwriteFilePromise || promisify(fs.writeFile);
       return overwritePromise(
-        await pathToCoAuthors(),
+        path || (await pathToCoAuthors()),
         JSON.stringify(authorJson, null, 2)
       );
     },

packages/git-mob-core/src/git-mob-api/git-authors/create-coauthors-file.ts

@@ -24,8 +24,6 @@ export function mockGitAuthors(keys: string[]) {
   return {
     read: jest.fn(async () => coAuthors),
     overwrite: jest.fn(async () => ''),
-    coAuthors: jest.fn(() => []),
-    author: jest.fn(() => ({})),
     toList: jest.fn(() => authors),
     toObject: jest.fn(() => ({ coauthors: {} })),
   };