@riebeckite/git-history 0.0.0-stage → 0.0.33
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +8 -2
- package/README_ja.md +10 -0
- package/dist/index.d.ts +14 -0
- package/dist/index.js +151 -0
- package/dist/src/repo_paths.d.ts +69 -0
- package/dist/src/run_git.d.ts +44 -0
- package/dist/test-support.d.ts +22 -0
- package/dist/test-support.js +62 -0
- package/package.json +55 -3
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright Rerurate_514
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,3 +1,9 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @riebeckite/git-history
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[日本語](./README_ja.md)
|
|
4
|
+
|
|
5
|
+
Shared Git repository access for Riebeckite plugins. It resolves the work tree
|
|
6
|
+
that owns a content directory and runs Git commands with predictable encoding.
|
|
7
|
+
|
|
8
|
+
`@riebeckite/git-history/test-support` provides a throw-away nested repository
|
|
9
|
+
used by the changelog and diff plugin tests.
|
package/README_ja.md
ADDED
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { type GitRepositoryPaths, type RepositoryPathsResolution } from "./src/repo_paths.js";
|
|
2
|
+
export { type GitRepositoryPaths, isResolvedRepository, normalizeContentPath, type RepositoryPathsResolution, resolveRepositoryPaths, toContentPath, toRepositoryPath, } from "./src/repo_paths.js";
|
|
3
|
+
export { isGitCommandFailure, runGit } from "./src/run_git.js";
|
|
4
|
+
export type GitRepositoryOptions = {
|
|
5
|
+
cwd?: string;
|
|
6
|
+
};
|
|
7
|
+
export declare class GitRepository {
|
|
8
|
+
#private;
|
|
9
|
+
constructor(options?: GitRepositoryOptions);
|
|
10
|
+
resolve(): Promise<RepositoryPathsResolution>;
|
|
11
|
+
isAvailable(): Promise<boolean>;
|
|
12
|
+
paths(): Promise<GitRepositoryPaths | null>;
|
|
13
|
+
getStateFingerprint(): Promise<string | null>;
|
|
14
|
+
}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
// index.ts
|
|
2
|
+
import path2 from "node:path";
|
|
3
|
+
|
|
4
|
+
// src/repo_paths.ts
|
|
5
|
+
import path from "node:path";
|
|
6
|
+
|
|
7
|
+
// src/run_git.ts
|
|
8
|
+
import { execFile } from "node:child_process";
|
|
9
|
+
import { promisify } from "node:util";
|
|
10
|
+
var execFileAsync = promisify(execFile);
|
|
11
|
+
function isGitCommandFailure(result) {
|
|
12
|
+
return result.ok === false;
|
|
13
|
+
}
|
|
14
|
+
async function runGit(args, cwd) {
|
|
15
|
+
try {
|
|
16
|
+
const { stdout } = await execFileAsync(
|
|
17
|
+
"git",
|
|
18
|
+
["-c", "core.quotePath=false", ...args],
|
|
19
|
+
{
|
|
20
|
+
...cwd === void 0 ? {} : { cwd },
|
|
21
|
+
maxBuffer: 1024 * 1024 * 10
|
|
22
|
+
}
|
|
23
|
+
);
|
|
24
|
+
return { ok: true, stdout };
|
|
25
|
+
} catch (error) {
|
|
26
|
+
return {
|
|
27
|
+
ok: false,
|
|
28
|
+
spawnError: isSpawnFailure(readErrorCode(error)),
|
|
29
|
+
detail: describeGitFailure(error)
|
|
30
|
+
};
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
function readErrorCode(error) {
|
|
34
|
+
return typeof error === "object" && error !== null && "code" in error ? error.code : void 0;
|
|
35
|
+
}
|
|
36
|
+
function isSpawnFailure(code) {
|
|
37
|
+
return typeof code === "string" && !code.startsWith("ERR_");
|
|
38
|
+
}
|
|
39
|
+
function describeGitFailure(error) {
|
|
40
|
+
if (typeof error !== "object" || error === null) {
|
|
41
|
+
return error instanceof Error ? error.message : String(error);
|
|
42
|
+
}
|
|
43
|
+
const stderr = "stderr" in error ? error.stderr : void 0;
|
|
44
|
+
if (typeof stderr === "string" && stderr.trim()) return stderr.trim();
|
|
45
|
+
if (error instanceof Error) return error.message;
|
|
46
|
+
return String(error);
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
// src/repo_paths.ts
|
|
50
|
+
async function resolveRepositoryPaths(contentRoot) {
|
|
51
|
+
const resolvedContentRoot = path.resolve(contentRoot);
|
|
52
|
+
const result = await runGit([
|
|
53
|
+
"-C",
|
|
54
|
+
resolvedContentRoot,
|
|
55
|
+
"rev-parse",
|
|
56
|
+
"--show-toplevel",
|
|
57
|
+
"--show-prefix"
|
|
58
|
+
]);
|
|
59
|
+
if (isGitCommandFailure(result)) {
|
|
60
|
+
return result.spawnError ? { kind: "git-unavailable", detail: result.detail } : { kind: "content-outside-repository", detail: result.detail };
|
|
61
|
+
}
|
|
62
|
+
const [toplevel, prefix] = parseRevParseOutput(result.stdout);
|
|
63
|
+
if (!toplevel) {
|
|
64
|
+
return {
|
|
65
|
+
kind: "content-outside-repository",
|
|
66
|
+
detail: "git rev-parse reported no work tree root"
|
|
67
|
+
};
|
|
68
|
+
}
|
|
69
|
+
return {
|
|
70
|
+
kind: "resolved",
|
|
71
|
+
paths: {
|
|
72
|
+
repositoryRoot: toPosixPath(path.normalize(toplevel)),
|
|
73
|
+
contentRoot: toPosixPath(resolvedContentRoot),
|
|
74
|
+
contentPrefix: toPosixPath(prefix).replace(/\/+$/, "")
|
|
75
|
+
}
|
|
76
|
+
};
|
|
77
|
+
}
|
|
78
|
+
function toRepositoryPath(paths, contentRelativePath) {
|
|
79
|
+
const normalized = normalizeContentPath(contentRelativePath);
|
|
80
|
+
if (!paths.contentPrefix) return normalized;
|
|
81
|
+
if (!normalized) return paths.contentPrefix;
|
|
82
|
+
return `${paths.contentPrefix}/${normalized}`;
|
|
83
|
+
}
|
|
84
|
+
function toContentPath(paths, repositoryRelativePath) {
|
|
85
|
+
const normalized = normalizeContentPath(repositoryRelativePath);
|
|
86
|
+
if (!normalized) return null;
|
|
87
|
+
if (!paths.contentPrefix) return normalized;
|
|
88
|
+
if (!normalized.startsWith(`${paths.contentPrefix}/`)) return null;
|
|
89
|
+
return normalized.slice(paths.contentPrefix.length + 1);
|
|
90
|
+
}
|
|
91
|
+
function normalizeContentPath(value) {
|
|
92
|
+
return value.replace(/\\/g, "/").replace(/^\.\//, "");
|
|
93
|
+
}
|
|
94
|
+
function isResolvedRepository(resolution) {
|
|
95
|
+
return resolution.kind === "resolved";
|
|
96
|
+
}
|
|
97
|
+
function parseRevParseOutput(stdout) {
|
|
98
|
+
const [toplevel = "", prefix = ""] = stdout.split(/\r?\n/);
|
|
99
|
+
return [toplevel.trim(), prefix.trim()];
|
|
100
|
+
}
|
|
101
|
+
function toPosixPath(value) {
|
|
102
|
+
return value.replace(/\\/g, "/");
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
// index.ts
|
|
106
|
+
var GitRepository = class {
|
|
107
|
+
#contentRoot;
|
|
108
|
+
#resolution;
|
|
109
|
+
constructor(options = {}) {
|
|
110
|
+
this.#contentRoot = path2.resolve(options.cwd ?? process.cwd());
|
|
111
|
+
}
|
|
112
|
+
resolve() {
|
|
113
|
+
this.#resolution ??= resolveRepositoryPaths(this.#contentRoot);
|
|
114
|
+
return this.#resolution;
|
|
115
|
+
}
|
|
116
|
+
async isAvailable() {
|
|
117
|
+
return isResolvedRepository(await this.resolve());
|
|
118
|
+
}
|
|
119
|
+
async paths() {
|
|
120
|
+
const resolution = await this.resolve();
|
|
121
|
+
if (!isResolvedRepository(resolution)) return null;
|
|
122
|
+
return resolution.paths;
|
|
123
|
+
}
|
|
124
|
+
async getStateFingerprint() {
|
|
125
|
+
const paths = await this.paths();
|
|
126
|
+
if (!paths) return null;
|
|
127
|
+
const results = await Promise.all([
|
|
128
|
+
runGit(["rev-parse", "HEAD"], paths.repositoryRoot),
|
|
129
|
+
runGit(
|
|
130
|
+
["status", "--porcelain=v1", "--untracked-files=all"],
|
|
131
|
+
paths.repositoryRoot
|
|
132
|
+
),
|
|
133
|
+
runGit(
|
|
134
|
+
["for-each-ref", "--format=%(refname):%(objectname)"],
|
|
135
|
+
paths.repositoryRoot
|
|
136
|
+
)
|
|
137
|
+
]);
|
|
138
|
+
if (results.some((result) => !result.ok)) return null;
|
|
139
|
+
return results.filter((result) => result.ok).map((result) => result.stdout).join("");
|
|
140
|
+
}
|
|
141
|
+
};
|
|
142
|
+
export {
|
|
143
|
+
GitRepository,
|
|
144
|
+
isGitCommandFailure,
|
|
145
|
+
isResolvedRepository,
|
|
146
|
+
normalizeContentPath,
|
|
147
|
+
resolveRepositoryPaths,
|
|
148
|
+
runGit,
|
|
149
|
+
toContentPath,
|
|
150
|
+
toRepositoryPath
|
|
151
|
+
};
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The paths that locate a content directory inside a Git work tree.
|
|
3
|
+
*
|
|
4
|
+
* Every field is a POSIX-separated path (`git` prints and accepts those on every
|
|
5
|
+
* platform, including Windows).
|
|
6
|
+
*/
|
|
7
|
+
export type GitRepositoryPaths = {
|
|
8
|
+
/** Work tree root reported by `git rev-parse --show-toplevel`. */
|
|
9
|
+
repositoryRoot: string;
|
|
10
|
+
/** Absolute path of the content directory. */
|
|
11
|
+
contentRoot: string;
|
|
12
|
+
/**
|
|
13
|
+
* Content directory relative to `repositoryRoot`, without a trailing slash.
|
|
14
|
+
* Empty when the content directory is the work tree root itself.
|
|
15
|
+
*/
|
|
16
|
+
contentPrefix: string;
|
|
17
|
+
};
|
|
18
|
+
/**
|
|
19
|
+
* Why Git history cannot be read for a content directory.
|
|
20
|
+
*
|
|
21
|
+
* The reason is modelled explicitly so a plugin can report an actionable
|
|
22
|
+
* diagnostic instead of quietly rendering nothing.
|
|
23
|
+
*/
|
|
24
|
+
export type RepositoryPathsResolution = {
|
|
25
|
+
kind: "resolved";
|
|
26
|
+
paths: GitRepositoryPaths;
|
|
27
|
+
}
|
|
28
|
+
/** Git is not installed, or could not be started. */
|
|
29
|
+
| {
|
|
30
|
+
kind: "git-unavailable";
|
|
31
|
+
detail: string;
|
|
32
|
+
}
|
|
33
|
+
/** Git ran, but the content directory does not live in a work tree. */
|
|
34
|
+
| {
|
|
35
|
+
kind: "content-outside-repository";
|
|
36
|
+
detail: string;
|
|
37
|
+
};
|
|
38
|
+
/**
|
|
39
|
+
* Locates the Git work tree that owns `contentRoot`.
|
|
40
|
+
*
|
|
41
|
+
* Both the work tree root and the content prefix come from Git itself, so their
|
|
42
|
+
* casing and symlink resolution always agree with the paths `git log` prints —
|
|
43
|
+
* the reason content-relative paths can be translated without guessing.
|
|
44
|
+
*
|
|
45
|
+
* The work tree is resolved through `git -C <contentRoot>` rather than by
|
|
46
|
+
* running Git in `contentRoot`, so a missing directory surfaces as a Git
|
|
47
|
+
* failure instead of an indistinguishable spawn failure.
|
|
48
|
+
*/
|
|
49
|
+
export declare function resolveRepositoryPaths(contentRoot: string): Promise<RepositoryPathsResolution>;
|
|
50
|
+
/**
|
|
51
|
+
* Translates a content-relative path into the work tree-relative path that
|
|
52
|
+
* `git log` pathspecs and `git show <rev>:<path>` expect.
|
|
53
|
+
*/
|
|
54
|
+
export declare function toRepositoryPath(paths: GitRepositoryPaths, contentRelativePath: string): string;
|
|
55
|
+
/**
|
|
56
|
+
* Translates a work tree-relative path printed by `git` back into a
|
|
57
|
+
* content-relative path, or returns `null` when the path lies outside the
|
|
58
|
+
* content directory.
|
|
59
|
+
*/
|
|
60
|
+
export declare function toContentPath(paths: GitRepositoryPaths, repositoryRelativePath: string): string | null;
|
|
61
|
+
/** Normalizes a path to the POSIX form used for content and work tree paths. */
|
|
62
|
+
export declare function normalizeContentPath(value: string): string;
|
|
63
|
+
/**
|
|
64
|
+
* True when the content directory has a usable work tree. Narrows the
|
|
65
|
+
* resolution so callers can read `paths`.
|
|
66
|
+
*/
|
|
67
|
+
export declare function isResolvedRepository(resolution: RepositoryPathsResolution): resolution is Extract<RepositoryPathsResolution, {
|
|
68
|
+
kind: "resolved";
|
|
69
|
+
}>;
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Result of a `git` invocation.
|
|
3
|
+
*
|
|
4
|
+
* Failures are returned instead of thrown: a site whose Git history cannot be
|
|
5
|
+
* read must still build, so every caller decides what an unavailable repository
|
|
6
|
+
* means for its own output.
|
|
7
|
+
*/
|
|
8
|
+
type GitCommandResult = {
|
|
9
|
+
ok: true;
|
|
10
|
+
stdout: string;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* `spawnError` separates "Git could not be started" (missing or unexecutable
|
|
14
|
+
* binary) from "Git ran and rejected the command" (not a work tree, unknown
|
|
15
|
+
* revision, unreadable path). The distinction drives which diagnostic a
|
|
16
|
+
* plugin reports.
|
|
17
|
+
*/
|
|
18
|
+
| {
|
|
19
|
+
ok: false;
|
|
20
|
+
spawnError: boolean;
|
|
21
|
+
detail: string;
|
|
22
|
+
};
|
|
23
|
+
/**
|
|
24
|
+
* Narrows a failed command so its failure fields can be read.
|
|
25
|
+
*
|
|
26
|
+
* Type predicates are used instead of `result.ok` checks throughout this
|
|
27
|
+
* package because the build type-checks without `strictNullChecks`, where
|
|
28
|
+
* discriminant narrowing of an inline condition does not apply.
|
|
29
|
+
*/
|
|
30
|
+
export declare function isGitCommandFailure(result: GitCommandResult): result is Extract<GitCommandResult, {
|
|
31
|
+
ok: false;
|
|
32
|
+
}>;
|
|
33
|
+
/**
|
|
34
|
+
* Runs `git` with `args`.
|
|
35
|
+
*
|
|
36
|
+
* `core.quotePath=false` keeps non-ASCII paths verbatim so the printed paths
|
|
37
|
+
* match the ones the content index reports; Git otherwise escapes them into
|
|
38
|
+
* octal sequences that no path lookup can resolve.
|
|
39
|
+
*
|
|
40
|
+
* @param cwd Directory Git runs in. Omit when the command carries its own
|
|
41
|
+
* `-C <dir>` argument.
|
|
42
|
+
*/
|
|
43
|
+
export declare function runGit(args: readonly string[], cwd?: string): Promise<GitCommandResult>;
|
|
44
|
+
export {};
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/** True when a usable `git` executable is on PATH. */
|
|
2
|
+
export declare const gitAvailable: boolean;
|
|
3
|
+
/** Files written by one commit. A `null` value deletes the file. */
|
|
4
|
+
export type CommitFiles = Record<string, string | null>;
|
|
5
|
+
export type TestRepository = {
|
|
6
|
+
/** Work tree root, which is deliberately not the content root. */
|
|
7
|
+
root: string;
|
|
8
|
+
/** Content directory holding the notes. */
|
|
9
|
+
contentRoot: string;
|
|
10
|
+
/** A directory outside the work tree entirely. */
|
|
11
|
+
outsiderRoot: string;
|
|
12
|
+
/** Writes the given files and commits them; returns the commit hash. */
|
|
13
|
+
commit(files: CommitFiles, message: string, date: string, cwd?: string): string;
|
|
14
|
+
dispose(): void;
|
|
15
|
+
};
|
|
16
|
+
/**
|
|
17
|
+
* Builds a throw-away Git repository whose content directory is nested one
|
|
18
|
+
* level below the work tree root. That offset is the whole point: it reproduces
|
|
19
|
+
* a monorepo where the build working directory, the repository root, and the
|
|
20
|
+
* content directory are three different places.
|
|
21
|
+
*/
|
|
22
|
+
export declare function createTestRepository(prefix: string): TestRepository;
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
// test-support.ts
|
|
2
|
+
import { execFileSync } from "node:child_process";
|
|
3
|
+
import fs from "node:fs";
|
|
4
|
+
import os from "node:os";
|
|
5
|
+
import path from "node:path";
|
|
6
|
+
var gitAvailable = isGitAvailable();
|
|
7
|
+
function createTestRepository(prefix) {
|
|
8
|
+
const root = fs.mkdtempSync(path.join(os.tmpdir(), prefix));
|
|
9
|
+
const contentRoot = path.join(root, "notes");
|
|
10
|
+
const outsiderRoot = fs.mkdtempSync(path.join(os.tmpdir(), `${prefix}out-`));
|
|
11
|
+
fs.mkdirSync(contentRoot, { recursive: true });
|
|
12
|
+
git(root, ["init", "--quiet"]);
|
|
13
|
+
git(root, ["config", "user.email", "test@riebeckite.dev"]);
|
|
14
|
+
git(root, ["config", "user.name", "Riebeckite Test"]);
|
|
15
|
+
git(root, ["config", "commit.gpgsign", "false"]);
|
|
16
|
+
git(root, ["config", "core.autocrlf", "false"]);
|
|
17
|
+
return {
|
|
18
|
+
root,
|
|
19
|
+
contentRoot,
|
|
20
|
+
outsiderRoot,
|
|
21
|
+
commit(files, message, date, cwd = root) {
|
|
22
|
+
for (const [relativePath, content] of Object.entries(files)) {
|
|
23
|
+
const target = path.join(cwd, relativePath);
|
|
24
|
+
if (content === null) {
|
|
25
|
+
fs.rmSync(target, { force: true });
|
|
26
|
+
continue;
|
|
27
|
+
}
|
|
28
|
+
fs.mkdirSync(path.dirname(target), { recursive: true });
|
|
29
|
+
fs.writeFileSync(target, content);
|
|
30
|
+
}
|
|
31
|
+
git(cwd, ["add", "-A"]);
|
|
32
|
+
git(cwd, ["commit", "--quiet", "-m", message], {
|
|
33
|
+
GIT_AUTHOR_DATE: date,
|
|
34
|
+
GIT_COMMITTER_DATE: date
|
|
35
|
+
});
|
|
36
|
+
return git(cwd, ["rev-parse", "HEAD"]);
|
|
37
|
+
},
|
|
38
|
+
dispose() {
|
|
39
|
+
fs.rmSync(root, { recursive: true, force: true });
|
|
40
|
+
fs.rmSync(outsiderRoot, { recursive: true, force: true });
|
|
41
|
+
}
|
|
42
|
+
};
|
|
43
|
+
}
|
|
44
|
+
function git(cwd, args, env) {
|
|
45
|
+
return execFileSync("git", args, {
|
|
46
|
+
cwd,
|
|
47
|
+
encoding: "utf8",
|
|
48
|
+
env: { ...process.env, ...env }
|
|
49
|
+
}).trim();
|
|
50
|
+
}
|
|
51
|
+
function isGitAvailable() {
|
|
52
|
+
try {
|
|
53
|
+
execFileSync("git", ["--version"], { stdio: "ignore" });
|
|
54
|
+
return true;
|
|
55
|
+
} catch {
|
|
56
|
+
return false;
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
export {
|
|
60
|
+
createTestRepository,
|
|
61
|
+
gitAvailable
|
|
62
|
+
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,58 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@riebeckite/git-history",
|
|
3
|
-
"version": "0.0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
3
|
+
"version": "0.0.33",
|
|
4
|
+
"license": "Apache-2.0",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "./dist/index.js",
|
|
7
|
+
"types": "./dist/index.d.ts",
|
|
8
|
+
"exports": {
|
|
9
|
+
".": {
|
|
10
|
+
"types": "./dist/index.d.ts",
|
|
11
|
+
"import": "./dist/index.js",
|
|
12
|
+
"source": "./index.ts",
|
|
13
|
+
"default": "./dist/index.js"
|
|
14
|
+
},
|
|
15
|
+
"./test-support": {
|
|
16
|
+
"types": "./dist/test-support.d.ts",
|
|
17
|
+
"import": "./dist/test-support.js",
|
|
18
|
+
"source": "./test-support.ts",
|
|
19
|
+
"default": "./dist/test-support.js"
|
|
20
|
+
}
|
|
21
|
+
},
|
|
22
|
+
"files": [
|
|
23
|
+
"LICENSE",
|
|
24
|
+
"README.md",
|
|
25
|
+
"README_ja.md",
|
|
26
|
+
"dist"
|
|
27
|
+
],
|
|
28
|
+
"publishConfig": {
|
|
29
|
+
"access": "public"
|
|
30
|
+
},
|
|
31
|
+
"devDependencies": {
|
|
32
|
+
"@types/node": "^24.5.2",
|
|
33
|
+
"tsx": "^4.22.4"
|
|
34
|
+
},
|
|
35
|
+
"repository": {
|
|
36
|
+
"type": "git",
|
|
37
|
+
"url": "https://github.com/Rerurate514/riebeckite.git",
|
|
38
|
+
"directory": "packages/git-history"
|
|
39
|
+
},
|
|
40
|
+
"homepage": "https://github.com/Rerurate514/riebeckite#readme",
|
|
41
|
+
"bugs": {
|
|
42
|
+
"url": "https://github.com/Rerurate514/riebeckite/issues"
|
|
43
|
+
},
|
|
44
|
+
"description": "Shared Git repository access for Riebeckite plugins.",
|
|
45
|
+
"keywords": [
|
|
46
|
+
"riebeckite",
|
|
47
|
+
"git",
|
|
48
|
+
"history"
|
|
49
|
+
],
|
|
50
|
+
"engines": {
|
|
51
|
+
"node": "^20.19.0 || >=22.12.0"
|
|
52
|
+
},
|
|
53
|
+
"sideEffects": false,
|
|
54
|
+
"scripts": {
|
|
55
|
+
"build": "node ../../scripts/build_package.mjs",
|
|
56
|
+
"test": "node --import tsx --test \"test/*.test.ts\""
|
|
57
|
+
}
|
|
6
58
|
}
|