Set author and co-authors using git mob core

.github/workflows/ci.yml

@@ -39,9 +39,6 @@ jobs:
       - name: Build package
         run: npm run build
 
-      - name: Install Git-Mob (link)
-        run: npm link
-
       - name: Run lint and tests
         run: npm run checks
 

CHANGELOG.md

@@ -2,6 +2,35 @@
 
 Follows [Semantic Versioning](https://semver.org/).
 
+## git-mob-core 0.6.0 current
+
+### Added
+
+```ts
+gitMobConfig = {
+  localTemplate(): <Promise<boolean>>,
+  fetchFromGitHub(): <Promise<boolean>>,
+};
+
+gitConfig = {
+  getLocalCommitTemplate(): <Promise<string>>,
+  getGlobalCommitTemplate(): <Promise<string>>,
+};
+
+gitRevParse = {
+  insideWorkTree(): string,
+  topLevelDirectory(): boolean,
+};
+```
+
+## git-mob 2.5.0 current
+
+### Added
+
+- Integrated git-mob-core for main `git mob` features
+- Reduced the calls to `git` CLI to speed up command execution for `git mob`
+- Convert src git-mob and spec files from JS to TS
+
 ## git-mob-core 0.5.0 10-06-2023
 
 ### Added

packages/bob/git-mob.config.js

@@ -2,7 +2,7 @@ const glob = require('glob');
 
 const baseConfig = {
   entryPoints: [
-    './src/git-mob.js',
+    './src/git-mob.ts',
     './src/solo.js',
     './src/git-add-coauthor.ts',
     './src/git-delete-coauthor.js',

packages/git-mob-core/README.md

@@ -15,22 +15,38 @@ npm i git-mob-core
 ```TS
 saveNewCoAuthors(authors): <Promise<Author[]>>
 getAllAuthors(): <Promise<Author[]>>
-getPrimaryAuthor(): Author | null
+getPrimaryAuthor(): Author | undefined
 getSelectedCoAuthors(allAuthors): Author[]
 setCoAuthors(keys): <Promise<Author[]>>
 setPrimaryAuthor(author): void
-solo(): void
+solo(): <Promise<void>>
 updateGitTemplate(selectedAuthors): void
 fetchGitHubAuthors(userNames: string[], userAgent: string): <Promise<Author[]>>
 pathToCoAuthors(): string
 getConfig(prop: string): string | undefined
 updateConfig(prop: string, value: string): void
+gitMobConfig = {
+  localTemplate(): <Promise<boolean>>,
+  fetchFromGitHub(): <Promise<boolean>>,
+};
+
+gitConfig = {
+  getLocalCommitTemplate(): <Promise<string>>,
+  getGlobalCommitTemplate(): <Promise<string>>,
+};
+
+gitRevParse = {
+  insideWorkTree(): string,
+  topLevelDirectory(): boolean,
+};
 class Author
 ```
 
 ## Author class
 
 ```TS
+class Author;
+
 // Properties
 Author.key: string
 Author.name: string

packages/git-mob-core/package.json

@@ -2,6 +2,7 @@
   "name": "git-mob-core",
   "version": "0.5.0",
   "description": "Core Git Mob library to manage co-authoring",
+  "homepage": "https://github.com/rkotze/git-mob/blob/master/packages/git-mob-core/README.md",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "scripts": {

packages/git-mob-core/src/commands.js

@@ -1,26 +1,5 @@
-const { exec } = require('child_process');
-const { promisify } = require('util');
 const { silentRun } = require('./silent-run');
-const { getConfig } = require('./config-manager');
-
-/**
- * Runs the given command in a shell.
- * @param {string} command The command to execute
- * @returns {Promise} stdout string
- */
-async function silentExec(command) {
-  const execAsync = promisify(exec);
-  try {
-    const cmdConfig = {};
-    const processCwd = getConfig('processCwd');
-    if (processCwd) cmdConfig.cwd = processCwd;
-    const response = await execAsync(command, cmdOptions(cmdConfig));
-
-    return response.stdout;
-  } catch (error) {
-    return `GitMob silentExec: "${command}" ${error.message}`;
-  }
-}
+const { execCommand } = require('./git-mob-api/exec-command');
 
 function handleResponse(query) {
   try {
@@ -77,20 +56,13 @@ function gitAddCoAuthor(coAuthor) {
 }
 
 async function getRepoAuthors() {
-  return silentExec(`git shortlog -sen HEAD`);
+  return execCommand('git shortlog -sen HEAD');
 }
 
 function removeGitMobSection() {
   return silentRun(`git config --global --remove-section git-mob`);
 }
 
-function cmdOptions(extendOptions = {}) {
-  return {
-    ...extendOptions,
-    encoding: 'utf8',
-  };
-}
-
 module.exports = {
   config: {
     getAll,

packages/git-mob-core/src/git-mob-api/errors/author-not-found.ts

@@ -0,0 +1,5 @@
+export class AuthorNotFound extends Error {
+  constructor(initials: string) {
+    super(`Author with initials "${initials}" not found!`);
+  }
+}

packages/git-mob-core/src/git-mob-api/exec-command.ts

@@ -0,0 +1,39 @@
+import { exec } from 'node:child_process';
+import { promisify } from 'node:util';
+import { getConfig as cmGetConfig } from '../config-manager';
+
+type ExecCommandOptions = {
+  encoding: string;
+  cwd?: string;
+};
+
+// Runs the given command in a shell.
+export async function execCommand(command: string): Promise<string> {
+  const cmdConfig: ExecCommandOptions = { encoding: 'utf8' };
+  const processCwd = cmGetConfig('processCwd');
+  if (processCwd) cmdConfig.cwd = processCwd;
+  const execAsync = promisify(exec);
+  const { stderr, stdout } = await execAsync(command, cmdConfig);
+
+  if (stderr) {
+    throw new Error(`GitMob execCommand: "${command}" ${stderr.trim()}`);
+  }
+
+  return stdout.trim();
+}
+
+export async function getConfig(key: string) {
+  try {
+    return await execCommand(`git config --get ${key}`);
+  } catch {
+    return undefined;
+  }
+}
+
+export async function getAllConfig(key: string) {
+  try {
+    return await execCommand(`git config --get-all ${key}`);
+  } catch {
+    return undefined;
+  }
+}

packages/git-mob-core/src/git-mob-api/git-authors/fetch-github-authors.spec.ts

@@ -9,6 +9,7 @@ const ghRkotzeResponse = {
   id: 123,
   login: 'rkotze',
   name: 'Richard Kotze',
+  stars: 2,
 };
 
 const ghDidelerResponse = {
@@ -83,6 +84,26 @@ test('Query for two GitHub users and build AuthorList', async () => {
   ]);
 });
 
+test('Handle GitHub user with no name', async () => {
+  mockedFetch.mockResolvedValue(
+    buildBasicResponse({
+      id: 329,
+      name: null,
+      login: 'kotze',
+    })
+  );
+
+  const actualAuthorList = await fetchGitHubAuthors(['kotze'], agentHeader);
+
+  expect(actualAuthorList).toEqual([
+    {
+      key: 'kotze',
+      name: 'kotze',
+      email: '329+kotze@users.noreply.github.com',
+    },
+  ]);
+});
+
 test('Error if no user agent specified', async () => {
   await expect(fetchGitHubAuthors(['badrequestuser'], '')).rejects.toThrow(
     /Error no user-agent header string given./

packages/git-mob-core/src/git-mob-api/git-authors/fetch-github-authors.ts

@@ -14,7 +14,7 @@ const getHeaders: RequestOptions = {
 type GitHubUser = {
   id: number;
   login: string;
-  name: string;
+  name?: string;
 };
 
 function validateGhUser(o: any): o is GitHubUser {
@@ -49,7 +49,7 @@ async function fetchGitHubAuthors(
     if (validateGhUser(ghUser.data)) {
       const { login, id, name } = ghUser.data;
       authorAuthorList.push(
-        new Author(login, name, `${id}+${login}@users.noreply.github.com`)
+        new Author(login, name || login, `${id}+${login}@users.noreply.github.com`)
       );
     }
   }

packages/git-mob-core/src/git-mob-api/git-authors/index.js

@@ -3,7 +3,7 @@ const os = require('os');
 const path = require('path');
 const { promisify } = require('util');
 const { Author } = require('../author');
-const { topLevelDirectory } = require('../../git-rev-parse');
+const { topLevelDirectory } = require('../git-rev-parse');
 
 function gitAuthors(readFilePromise, writeFilePromise, overwriteFilePromise) {
   async function readFile(path) {

packages/git-mob-core/src/git-mob-api/git-authors/index.spec.js

@@ -1,7 +1,7 @@
 const path = require('path');
 const fs = require('fs');
 const { Author } = require('../author');
-const { topLevelDirectory } = require('../../git-rev-parse');
+const { topLevelDirectory } = require('../git-rev-parse');
 const { gitAuthors, pathToCoAuthors } = require('.');
 
 const validJsonString = `

packages/git-mob-core/src/git-mob-api/git-config.ts

@@ -0,0 +1,9 @@
+import { getConfig } from './exec-command';
+
+export async function getLocalCommitTemplate() {
+  return getConfig('--local commit.template');
+}
+
+export async function getGlobalCommitTemplate() {
+  return getConfig('--global commit.template');
+}

packages/git-mob-core/src/git-mob-api/git-mob-config.ts

@@ -0,0 +1,15 @@
+import { getConfig, getAllConfig } from './exec-command';
+
+export async function localTemplate() {
+  const localTemplate = await getConfig('--local git-mob-config.use-local-template');
+  return localTemplate === 'true';
+}
+
+export async function fetchFromGitHub() {
+  const githubFetch = await getConfig('--global git-mob-config.github-fetch');
+  return githubFetch === 'true';
+}
+
+export async function getSetCoAuthors() {
+  return getAllConfig('--global git-mob.co-author');
+}