Skip to content

Commit 5f033a7

Browse files
author
John van Leeuwen
committed
feat: support aliases for git log usernames
1 parent 04ddb07 commit 5f033a7

4 files changed

Lines changed: 20 additions & 0 deletions

File tree

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,21 @@ npm i @softarc/detective -D
3939
npx detective
4040
```
4141

42+
## Defining aliases
43+
44+
In case users have used multiple names, as appearing in the `git log`, use the `aliases` option in the file `.detective/config.json` created the first time detective runs:
45+
46+
```json
47+
{
48+
[...]
49+
"aliases": {
50+
"jdoe": "John Doe",
51+
"janedoe": "Jane Doe"
52+
}
53+
[...]
54+
}
55+
```
56+
4257
## Defining Teams
4358

4459
For the Team Alignment Analysis, you need to map team names to the names of your team members as found in `git log`. This is done in the file `.detective/config.json` created the first time detective runs:

apps/backend/src/infrastructure/config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ const initConfig: Config = {
1313
files: [],
1414
logs: [],
1515
},
16+
aliases: {},
1617
teams: {
1718
'example-team-a': ['John Doe', 'Jane Doe'],
1819
'example-team-b': ['Max Muster', 'Susi Sorglos'],

apps/backend/src/model/config.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,15 @@ export type Config = {
88
groups: string[];
99
filter: Filter;
1010
teams: Record<string, string[]>;
11+
aliases: Record<string, string>;
1112
entries: [];
1213
};
1314

1415
export const emptyConfig: Config = {
1516
scopes: [],
1617
groups: [],
1718
teams: {},
19+
aliases: {},
1820
entries: [],
1921
filter: {
2022
logs: [],

apps/backend/src/services/team-alignment.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ export async function calcTeamAlignment(
5050
}
5151
}
5252

53+
userName = config.aliases?.[userName] || userName;
54+
5355
users.add(userName);
5456

5557
const key = calcKey(byUser, userName, userToTeam);

0 commit comments

Comments
 (0)