4 |
5 | **Commit with Date & Identity** is an Visual Studio Code extension that allows you to create and amend Git commits with manually set author and committer dates and identities.
6 |
7 | ## Features
8 |
9 | ### Author and committer support
10 |
11 | Provides the ability to set author details, committer details, or both. Also allows you to synchronize the two with a single click.
12 |
13 | ### Default values
14 |
15 | Significant effort has been made to use the same default dates that Git uses for standard commits, amending, rebasing, and merging.
16 |
17 | ### Preset dates
18 |
19 | Provides convenient buttons to use and modify dates and identities from relevant commits. Always provides a button to select the author/commit dates and identities from `HEAD`.
20 |
21 | ### Merge and rebase support
22 |
23 | Support for continuing during rebases and committing during merges. When rebasing, provides a button to use the dates and identities of the former commit (`REBASE_HEAD`). When merging, provides to use the dates and identities from their commit (`MERGE_HEAD`).
24 |
25 | ## Testing
26 |
27 | The extension repository contains predefined Git repository states that can be used to make sure different features of the extension are working.
28 |
29 | To use one of these states, use the command `npm run test-repo --state=[STATE]` where name is the optional name of the state. If no name is provided, a prompt will be shown. After the repository is created, you will have the opportunity to view the Git log to validate the author and committer details.
30 |
--------------------------------------------------------------------------------
/tests/create-test-repo.mjs:
--------------------------------------------------------------------------------
1 | import { readFile, writeFile, mkdir, readdir } from 'node:fs/promises';
2 | import { exec } from 'node:child_process';
3 | import { join, dirname } from 'node:path';
4 | import { fileURLToPath } from 'node:url';
5 | import { createInterface } from 'node:readline/promises';
6 | import { stdin as input, stdout as output } from 'node:process';
7 | import { emptyDir } from 'fs-extra';
8 | import { existsSync } from 'node:fs';
9 |
10 | const lineRegex = /^([A-Z]+): ?(.+?)(?: = (.+)|)$/;
11 | const testDir = dirname(fileURLToPath(import.meta.url));
12 |
13 | let state;
14 |
15 | if (process.env.npm_config_state) {
16 | state = process.env.npm_config_state;
17 | } else {
18 | const rl = createInterface({ input, output });
19 | const states = await readdir(join(testDir, 'states'));
20 |
21 | states.forEach((name, i) => {
22 | console.log(`${i + 1}) ${name}`);
23 | });
24 |
25 | const num = +(await rl.question('\nEnter state number: ')) - 1;
26 | rl.close();
27 |
28 | state = states[num];
29 | }
30 |
31 | const contents = await readFile(join(testDir, 'states', state), 'utf-8');
32 | const lines = contents.split(/\r?\n/);
33 | const folder = join(testDir, 'test-repo');
34 |
35 | await emptyDir(folder);
36 |
37 | if (!existsSync(folder)) {
38 | await mkdir(folder);
39 | }
40 |
41 | for (let line of lines) {
42 | const match = lineRegex.exec(line);
43 |
44 | if (!match) {
45 | throw new Error('Invalid line: ' + line);
46 | }
47 |
48 | console.log(line);
49 |
50 | const [, command, arg, extra] = match;
51 |
52 | switch (command) {
53 | case 'GIT':
54 | await new Promise((resolve) => {
55 | exec('git ' + arg, { cwd: folder }, (_, out, err) => {
56 | console.log(out);
57 | console.error(err);
58 | resolve();
59 | });
60 | });
61 | break;
62 | case 'FILE':
63 | await writeFile(join(folder, arg), extra);
64 | break;
65 | case 'SET':
66 | process.env[arg] = extra;
67 | break;
68 | case 'UNSET':
69 | delete process.env[arg];
70 | }
71 | }
72 |
--------------------------------------------------------------------------------
/src/webview/git-date-input.ts:
--------------------------------------------------------------------------------
1 | import GitDatumInput from './git-datum-input';
2 | import TimezoneInput from './timezone-input';
3 |
4 | export default class GitDateInput extends GitDatumInput--ignore-date is being used.';
54 | authorDateInput.alternativeForced = reasonSpan;
55 |
56 | const nowDateInput = new GitDateInput();
57 | nowDateInput.label = 'Commit Time';
58 | authorDateInput.alternative = nowDateInput;
59 |
60 | setInterval(() => {
61 | nowDateInput.forcedValue = GitDateInput.now();
62 | }, 500);
63 | }
64 |
65 | if (data.rebase?.cdIsAd) {
66 | const reasonSpan = document.createElement('span');
67 | reasonSpan.innerHTML =
68 | '--committer-date-is-author-date is being used.';
69 | commitDateInput.alternativeForced = reasonSpan;
70 | }
71 |
72 | commitDateInput.alternative = authorDateInput;
73 | committerIdentityInput.alternative = authorIdentityInput;
74 |
75 | submitButton.addEventListener('click', () => {
76 | vscode.postMessage({
77 | author: {
78 | identity: authorIdentityInput.value,
79 | date: authorDateInput.value,
80 | },
81 | committer: {
82 | identity: committerIdentityInput.value,
83 | date: commitDateInput.value,
84 | },
85 | amend: amendCheck.checked,
86 | rebaseAmend: data.rebase?.amend ?? false,
87 | editRM: data.rebase !== undefined,
88 | } as EndMessage);
89 | });
90 |
91 | if (data.rebase || !data.headDetails) {
92 | amendCheck.closest('div')!.style.display = 'none';
93 | } else {
94 | amendCheck.addEventListener('change', () => {
95 | if (!data?.headDetails) return;
96 |
97 | let amend = amendCheck.checked;
98 |
99 | authorDateInput.forcedValue = amend
100 | ? data.headDetails.author.date
101 | : GitDateInput.globalDefault;
102 | authorIdentityInput.forcedValue = amend
103 | ? data.headDetails.author.identity
104 | : data.authorIdent;
105 |
106 | // Reset committer details as well
107 | commitDateInput.forcedValue = GitDateInput.globalDefault;
108 | committerIdentityInput.forcedValue = data.committerIdent;
109 |
110 | loadPresets(data, amend);
111 | submitButton.textContent = amend ? 'Amend' : 'Commit';
112 | });
113 | }
114 |
115 | if (data.rebase) {
116 | authorDateInput.forcedValue = data.rebase.adIsNow
117 | ? GitDateInput.globalDefault
118 | : data.rebase.headDetails.author.date;
119 | authorIdentityInput.forcedValue =
120 | data.rebase.headDetails.author.identity;
121 |
122 | commitDateInput.forcedValue = data.rebase.cdIsAd
123 | ? data.rebase.headDetails.author.date
124 | : GitDateInput.globalDefault;
125 | committerIdentityInput.forcedValue =
126 | data.rebase.headDetails.committer.identity;
127 |
128 | submitButton.textContent = 'Continue';
129 | }
130 |
131 | loadPresets(data);
132 | submitButton.textContent = 'Commit';
133 | });
134 |
135 | vscode.postMessage({
136 | type: 'start-request',
137 | } as StartRequestMessage);
138 |
--------------------------------------------------------------------------------
/src/webview/git-datum-input.ts:
--------------------------------------------------------------------------------
1 | export interface Preset {
2 | label: string;
3 | tooltip?: string;
4 | value: string | (() => string);
5 | }
6 |
7 | export default abstract class GitDatumInput<
8 | PrimaryInputType extends HTMLElement & { disabled: boolean },
9 | > extends HTMLElement {
10 | static readonly observedAttributes = ['label', 'disabled'];
11 |
12 | protected readonly alternativeCnt: HTMLDivElement;
13 | protected readonly labelEl: HTMLLabelElement;
14 |
15 | protected readonly aboveRow: HTMLDivElement;
16 | protected readonly aboveContainer: HTMLDivElement;
17 | protected readonly inputRow: HTMLDivElement;
18 | protected readonly presetRow: HTMLDivElement;
19 | protected readonly presetContainer: HTMLDivElement;
20 |
21 | private alternativeInput?:
22 | | HTMLInputElement
23 | | GitDatumInputCommit with Date & Identity
219 |
220 |
224 |
225 |
226 |
229 |
230 |
233 |
234 |
235 |
236 |
237 |
238 |
239 | `;
240 |
241 | let data = await new Promise