@hanseltime/template-repo-sync 1.1.0 → 1.3.0

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.
Files changed (72) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +14 -0
  3. package/docs/merge-plugins/CURRENT_PLUGINS.md +168 -0
  4. package/docs/merge-plugins/DEVELOPMENT.md +129 -0
  5. package/docs/merge-plugins/README.md +85 -0
  6. package/lib/cjs/checkout-drivers/git-checkout.d.ts +8 -0
  7. package/lib/cjs/checkout-drivers/git-checkout.js +17 -0
  8. package/lib/cjs/checkout-drivers/index.d.ts +2 -0
  9. package/lib/cjs/checkout-drivers/index.js +18 -0
  10. package/lib/cjs/checkout-drivers/types.d.ts +14 -0
  11. package/lib/cjs/checkout-drivers/types.js +2 -0
  12. package/lib/cjs/clone-drivers/git-clone.d.ts +2 -1
  13. package/lib/cjs/clone-drivers/git-clone.js +4 -1
  14. package/lib/cjs/clone-drivers/types.d.ts +12 -1
  15. package/lib/cjs/plugins/json-merge.js +30 -7
  16. package/lib/cjs/template-sync.d.ts +13 -0
  17. package/lib/cjs/template-sync.js +47 -8
  18. package/lib/cjs/types.d.ts +1 -1
  19. package/lib/esm/checkout-drivers/git-checkout.js +17 -0
  20. package/lib/esm/checkout-drivers/index.js +18 -0
  21. package/lib/esm/checkout-drivers/types.js +2 -0
  22. package/lib/esm/clone-drivers/git-clone.js +4 -1
  23. package/lib/esm/plugins/json-merge.js +30 -7
  24. package/lib/esm/template-sync.js +47 -8
  25. package/package.json +5 -8
  26. package/src/checkout-drivers/git-checkout.spec.ts +58 -0
  27. package/src/checkout-drivers/git-checkout.ts +22 -0
  28. package/src/checkout-drivers/index.ts +2 -0
  29. package/src/checkout-drivers/types.ts +14 -0
  30. package/src/clone-drivers/git-clone.ts +6 -2
  31. package/src/clone-drivers/types.ts +13 -1
  32. package/src/plugins/json-merge.spec.ts +86 -0
  33. package/src/plugins/json-merge.ts +9 -7
  34. package/src/template-sync.spec.ts +53 -2
  35. package/src/template-sync.ts +46 -9
  36. package/src/types.ts +1 -1
  37. package/test-fixtures/testGitRepo/README.md +17 -0
  38. package/test-fixtures/testGitRepo/gitDir/COMMIT_EDITMSG +14 -0
  39. package/test-fixtures/testGitRepo/gitDir/HEAD +1 -0
  40. package/test-fixtures/testGitRepo/gitDir/config +7 -0
  41. package/test-fixtures/testGitRepo/gitDir/description +1 -0
  42. package/test-fixtures/testGitRepo/gitDir/hooks/applypatch-msg.sample +15 -0
  43. package/test-fixtures/testGitRepo/gitDir/hooks/commit-msg.sample +24 -0
  44. package/test-fixtures/testGitRepo/gitDir/hooks/fsmonitor-watchman.sample +174 -0
  45. package/test-fixtures/testGitRepo/gitDir/hooks/post-update.sample +8 -0
  46. package/test-fixtures/testGitRepo/gitDir/hooks/pre-applypatch.sample +14 -0
  47. package/test-fixtures/testGitRepo/gitDir/hooks/pre-commit.sample +49 -0
  48. package/test-fixtures/testGitRepo/gitDir/hooks/pre-merge-commit.sample +13 -0
  49. package/test-fixtures/testGitRepo/gitDir/hooks/pre-push.sample +53 -0
  50. package/test-fixtures/testGitRepo/gitDir/hooks/pre-rebase.sample +169 -0
  51. package/test-fixtures/testGitRepo/gitDir/hooks/pre-receive.sample +24 -0
  52. package/test-fixtures/testGitRepo/gitDir/hooks/prepare-commit-msg.sample +42 -0
  53. package/test-fixtures/testGitRepo/gitDir/hooks/push-to-checkout.sample +78 -0
  54. package/test-fixtures/testGitRepo/gitDir/hooks/sendemail-validate.sample +77 -0
  55. package/test-fixtures/testGitRepo/gitDir/hooks/update.sample +128 -0
  56. package/test-fixtures/testGitRepo/gitDir/index +0 -0
  57. package/test-fixtures/testGitRepo/gitDir/info/exclude +6 -0
  58. package/test-fixtures/testGitRepo/gitDir/logs/HEAD +5 -0
  59. package/test-fixtures/testGitRepo/gitDir/logs/refs/heads/master +2 -0
  60. package/test-fixtures/testGitRepo/gitDir/logs/refs/heads/test-branch +2 -0
  61. package/test-fixtures/testGitRepo/gitDir/objects/4b/825dc642cb6eb9a060e54bf8d69288fbee4904 +0 -0
  62. package/test-fixtures/testGitRepo/gitDir/objects/6e/187bee8d02f39d0a1be8331dd8fe6a00c9b613 +0 -0
  63. package/test-fixtures/testGitRepo/gitDir/objects/73/185f1f3f5a6345e087d9f46dc4af77cc59449f +2 -0
  64. package/test-fixtures/testGitRepo/gitDir/objects/90/e7ea1089f939840e9649fd617584c1ad117159 +3 -0
  65. package/test-fixtures/testGitRepo/gitDir/objects/ba/99a452b9097047e9bfa8d5a08b3e452fcb364a +0 -0
  66. package/test-fixtures/testGitRepo/gitDir/objects/c5/8d400177cd5180b8566f82a127fafc5bf394b7 +0 -0
  67. package/test-fixtures/testGitRepo/gitDir/objects/e2/e668265db019249a7e8296d85f79000e3d71cf +0 -0
  68. package/test-fixtures/testGitRepo/gitDir/objects/e4/243e430c1ab69f3e344249f5b1859e90abc883 +1 -0
  69. package/test-fixtures/testGitRepo/gitDir/objects/ec/6c1cb72312605282ac61858cf1eaf1ea9f1d02 +0 -0
  70. package/test-fixtures/testGitRepo/gitDir/objects/fc/89cecc4ac0b5b075bd7d0ce9e09b2f50598b82 +0 -0
  71. package/test-fixtures/testGitRepo/gitDir/refs/heads/master +1 -0
  72. package/test-fixtures/testGitRepo/gitDir/refs/heads/test-branch +1 -0
@@ -7,14 +7,20 @@ import { existsSync, readFileSync, writeFileSync } from "fs";
7
7
 
8
8
  // Just return the test-fixture directory
9
9
  const dummyCloneDriver = async () => {
10
- return resolve(TEST_FIXTURES_DIR, "template");
10
+ return {
11
+ dir: resolve(TEST_FIXTURES_DIR, "template"),
12
+ remoteName: "ourRemote",
13
+ };
11
14
  };
12
15
 
16
+ const dummyCheckoutDriver = jest.fn();
17
+
13
18
  const downstreamDir = resolve(TEST_FIXTURES_DIR, "downstream");
14
19
 
15
20
  describe("templateSync", () => {
16
21
  let tmpDir: string;
17
22
  beforeEach(async () => {
23
+ jest.resetAllMocks();
18
24
  tmpDir = await mkdtemp(tempDir());
19
25
  await copy(downstreamDir, tmpDir);
20
26
  });
@@ -32,6 +38,35 @@ describe("templateSync", () => {
32
38
  cloneDriver: dummyCloneDriver,
33
39
  repoUrl: "not-important",
34
40
  repoDir: emptyTmpDir,
41
+ checkoutDriver: dummyCheckoutDriver,
42
+ }),
43
+ ).toEqual({
44
+ // Expect no changes since there was no local sync file
45
+ localSkipFiles: [],
46
+ localFileChanges: {},
47
+ });
48
+
49
+ // Verify the files
50
+ await fileMatchTemplate(emptyTmpDir, "templatesync.json");
51
+ await fileMatchTemplate(emptyTmpDir, "package.json");
52
+ await fileMatchTemplate(emptyTmpDir, "src/templated.ts");
53
+
54
+ // Expect the ignores to not be a problem
55
+ expect(existsSync(resolve(emptyTmpDir, "src/index.ts"))).toBeFalsy();
56
+ expect(existsSync(resolve(emptyTmpDir, "src/custom-bin"))).toBeFalsy();
57
+
58
+ expect(dummyCheckoutDriver).not.toHaveBeenCalled();
59
+ });
60
+ it("Checks out the branch and then appropriately merges", async () => {
61
+ const emptyTmpDir = await mkdtemp(tempDir());
62
+ expect(
63
+ await templateSync({
64
+ tmpCloneDir: "stubbed-by-driver",
65
+ cloneDriver: dummyCloneDriver,
66
+ repoUrl: "not-important",
67
+ repoDir: emptyTmpDir,
68
+ branch: "new-template-test",
69
+ checkoutDriver: dummyCheckoutDriver,
35
70
  }),
36
71
  ).toEqual({
37
72
  // Expect no changes since there was no local sync file
@@ -47,6 +82,12 @@ describe("templateSync", () => {
47
82
  // Expect the ignores to not be a problem
48
83
  expect(existsSync(resolve(emptyTmpDir, "src/index.ts"))).toBeFalsy();
49
84
  expect(existsSync(resolve(emptyTmpDir, "src/custom-bin"))).toBeFalsy();
85
+ const cloneInfo = await dummyCloneDriver();
86
+ expect(dummyCheckoutDriver).toHaveBeenCalledWith({
87
+ tmpDir: cloneInfo.dir,
88
+ remoteName: cloneInfo.remoteName,
89
+ branch: "new-template-test",
90
+ });
50
91
  });
51
92
  it("appropriately merges according to just the templatesync config file in an existing repo", async () => {
52
93
  // Remove the local sync overrides
@@ -57,6 +98,7 @@ describe("templateSync", () => {
57
98
  cloneDriver: dummyCloneDriver,
58
99
  repoUrl: "not-important",
59
100
  repoDir: tmpDir,
101
+ checkoutDriver: dummyCheckoutDriver,
60
102
  });
61
103
 
62
104
  expect(result.localSkipFiles).toEqual([]);
@@ -93,6 +135,7 @@ describe("templateSync", () => {
93
135
  // Expect the ignores to not be a problem
94
136
  await fileMatchDownstream(tmpDir, "src/index.ts");
95
137
  await fileMatchDownstream(tmpDir, "plugins/custom-plugin.js");
138
+ expect(dummyCheckoutDriver).not.toHaveBeenCalled();
96
139
  });
97
140
  it("appropriately merges according to the templatesync config file and the local config in an existing repo", async () => {
98
141
  // Remove the local sync overrides
@@ -127,6 +170,7 @@ describe("templateSync", () => {
127
170
  cloneDriver: dummyCloneDriver,
128
171
  repoUrl: "not-important",
129
172
  repoDir: tmpDir,
173
+ checkoutDriver: dummyCheckoutDriver,
130
174
  });
131
175
 
132
176
  expect(result.localSkipFiles).toEqual(["src/templated.ts"]);
@@ -152,6 +196,7 @@ describe("templateSync", () => {
152
196
  // Expect the ignores to not be a problem
153
197
  await fileMatchDownstream(tmpDir, "src/index.ts");
154
198
  await fileMatchDownstream(tmpDir, "plugins/custom-plugin.js");
199
+ expect(dummyCheckoutDriver).not.toHaveBeenCalled();
155
200
  });
156
201
  it("appropriately merges according to the templatesync config file and the local config in an existing repo with afterRef", async () => {
157
202
  // Remove the local sync overrides
@@ -178,6 +223,7 @@ describe("templateSync", () => {
178
223
  repoUrl: "not-important",
179
224
  repoDir: tmpDir,
180
225
  diffDriver: mockDiffDriver,
226
+ checkoutDriver: dummyCheckoutDriver,
181
227
  });
182
228
 
183
229
  // since there was no override for this file, not changes from the local file
@@ -191,6 +237,7 @@ describe("templateSync", () => {
191
237
  await fileMatchDownstream(tmpDir, "src/index.ts");
192
238
  await fileMatchDownstream(tmpDir, "plugins/custom-plugin.js");
193
239
  await fileMatchDownstream(tmpDir, "package.json");
240
+ expect(dummyCheckoutDriver).not.toHaveBeenCalled();
194
241
  });
195
242
  it("updates the local templatesync with the current ref if updateAfterRef is true", async () => {
196
243
  // Remove the local sync overrides
@@ -224,6 +271,7 @@ describe("templateSync", () => {
224
271
  updateAfterRef: true,
225
272
  diffDriver: mockDiffDriver,
226
273
  currentRefDriver: mockCurrentRefDriver,
274
+ checkoutDriver: dummyCheckoutDriver,
227
275
  });
228
276
 
229
277
  // since there was no override for this file, not changes from the local file
@@ -247,6 +295,7 @@ describe("templateSync", () => {
247
295
  ...mockLocalConfig,
248
296
  afterRef: "newestSha",
249
297
  });
298
+ expect(dummyCheckoutDriver).not.toHaveBeenCalled();
250
299
  });
251
300
  it("creates the local templatesync with the current ref if updateAfterRef is true and no local template exists", async () => {
252
301
  // Remove the local sync overrides
@@ -267,6 +316,7 @@ describe("templateSync", () => {
267
316
  updateAfterRef: true,
268
317
  diffDriver: mockDiffDriver,
269
318
  currentRefDriver: mockCurrentRefDriver,
319
+ checkoutDriver: dummyCheckoutDriver,
270
320
  });
271
321
 
272
322
  // since there was no override for this file, not changes from the local file
@@ -313,6 +363,7 @@ describe("templateSync", () => {
313
363
  afterRef: "newestSha",
314
364
  });
315
365
  });
366
+ expect(dummyCheckoutDriver).not.toHaveBeenCalled();
316
367
  });
317
368
 
318
369
  // helper
@@ -330,7 +381,7 @@ async function fileMatch(
330
381
  source: "downstream" | "template",
331
382
  ) {
332
383
  const dir =
333
- source === "downstream" ? downstreamDir : await dummyCloneDriver();
384
+ source === "downstream" ? downstreamDir : (await dummyCloneDriver()).dir;
334
385
  expect((await readFile(resolve(tmpDir, relPath))).toString()).toEqual(
335
386
  (await readFile(resolve(dir, relPath))).toString(),
336
387
  );
@@ -10,10 +10,21 @@ import { TemplateDiffDriverFn, gitDiff } from "./diff-drivers";
10
10
  import { gitCurrentRef } from "./ref-drivers";
11
11
  import { TemplateRefDriverFn } from "./ref-drivers/types";
12
12
  import { inferJSONIndent } from "./formatting";
13
+ import * as commentJSON from "comment-json";
14
+ import { TemplateCheckoutDriverFn, gitCheckout } from "./checkout-drivers";
13
15
 
14
16
  export interface TemplateSyncOptions {
17
+ /**
18
+ * This is the url of the template repo
19
+ */
15
20
  repoUrl: string;
16
21
 
22
+ /**
23
+ * Optional Branch to check out - if not specified, this checks out the
24
+ * default branch of the template repo
25
+ */
26
+ branch?: string;
27
+
17
28
  /**
18
29
  * The directory for cloning our template repo into via the cloneDriver
19
30
  */
@@ -44,6 +55,11 @@ export interface TemplateSyncOptions {
44
55
  * Defaults to using git current ref
45
56
  */
46
57
  currentRefDriver?: TemplateRefDriverFn;
58
+
59
+ /**
60
+ * Defaults to using git checkout driver
61
+ */
62
+ checkoutDriver?: TemplateCheckoutDriverFn;
47
63
  }
48
64
 
49
65
  export interface TemplateSyncReturn {
@@ -71,21 +87,42 @@ export async function templateSync(
71
87
  const cloneDriver = options.cloneDriver ?? gitClone;
72
88
  const diffDriver = options.diffDriver ?? gitDiff;
73
89
  const currentRefDriver = options.currentRefDriver ?? gitCurrentRef;
74
- const tempCloneDir = await cloneDriver(options.tmpCloneDir, options.repoUrl);
90
+ const checkoutDriver = options.checkoutDriver ?? gitCheckout;
91
+ const cloneReturn = await cloneDriver(options.tmpCloneDir, options.repoUrl);
92
+
93
+ const { dir: tempCloneDir, remoteName } =
94
+ typeof cloneReturn === "string"
95
+ ? {
96
+ dir: cloneReturn,
97
+ remoteName: "origin", // Default to this
98
+ }
99
+ : cloneReturn;
100
+
101
+ if (options.branch) {
102
+ await checkoutDriver({
103
+ tmpDir: tempCloneDir,
104
+ remoteName,
105
+ branch: options.branch,
106
+ });
107
+ }
75
108
 
76
109
  // Get the clone Config
77
110
  const cloneConfigPath = join(tempCloneDir, `${TEMPLATE_SYNC_CONFIG}.json`);
78
111
  const templateSyncConfig: Config = existsSync(cloneConfigPath)
79
- ? JSON.parse(readFileSync(cloneConfigPath).toString())
80
- : {};
112
+ ? (commentJSON.parse(
113
+ readFileSync(cloneConfigPath).toString(),
114
+ ) as unknown as Config)
115
+ : { ignore: [] };
81
116
 
82
117
  const localConfigPath = join(
83
118
  options.repoDir,
84
119
  `${TEMPLATE_SYNC_LOCAL_CONFIG}.json`,
85
120
  );
86
- const localTemplateSyncConfig = existsSync(localConfigPath)
87
- ? JSON.parse(readFileSync(localConfigPath).toString())
88
- : ({} as LocalConfig);
121
+ const localTemplateSyncConfig: LocalConfig = existsSync(localConfigPath)
122
+ ? (commentJSON.parse(
123
+ readFileSync(localConfigPath).toString(),
124
+ ) as unknown as LocalConfig)
125
+ : { ignore: [] };
89
126
 
90
127
  let filesToSync: string[];
91
128
  if (localTemplateSyncConfig.afterRef) {
@@ -129,16 +166,16 @@ export async function templateSync(
129
166
 
130
167
  if (existsSync(localConfigPath)) {
131
168
  const configStr = readFileSync(localConfigPath).toString();
132
- const config = JSON.parse(configStr) as LocalConfig;
169
+ const config = commentJSON.parse(configStr) as unknown as LocalConfig;
133
170
  config.afterRef = ref;
134
171
  writeFileSync(
135
172
  localConfigPath,
136
- JSON.stringify(config, null, inferJSONIndent(configStr)),
173
+ commentJSON.stringify(config, null, inferJSONIndent(configStr)),
137
174
  );
138
175
  } else {
139
176
  writeFileSync(
140
177
  localConfigPath,
141
- JSON.stringify({ afterRef: ref }, null, 4),
178
+ commentJSON.stringify({ afterRef: ref }, null, 4),
142
179
  );
143
180
  }
144
181
  }
package/src/types.ts CHANGED
@@ -42,7 +42,7 @@ export interface MergeConfig<T> {
42
42
  */
43
43
  plugin?: string;
44
44
  /**
45
- * An array of first match file globs that will
45
+ * An array of first match file globs that will then call the plugin with the appropriate options
46
46
  */
47
47
  rules: { glob: string; options: MergePluginOptions | T }[];
48
48
  }
@@ -0,0 +1,17 @@
1
+ # This is the master branch
2
+
3
+ How to update this?
4
+
5
+ You will want to "re-initialize this folder" by createing your .git repo
6
+
7
+ ```shell
8
+ mv gitDir .git
9
+ ```
10
+
11
+ From here, you can CD into the folder and run git commands. Anything you do will be recorded into the .git
12
+
13
+ Before you commit those git history changes, please create the gitDir again from the new .git
14
+
15
+ ```shell
16
+ mv .git gitDir
17
+ ```
@@ -0,0 +1,14 @@
1
+ first commit
2
+
3
+ # Please enter the commit message for your changes. Lines starting
4
+ # with '#' will be ignored, and an empty message aborts the commit.
5
+ #
6
+ # Date: Sun Jun 9 13:06:24 2024 -0600
7
+ #
8
+ # On branch master
9
+ #
10
+ # Initial commit
11
+ #
12
+ # Changes to be committed:
13
+ # new file: README.md
14
+ #
@@ -0,0 +1 @@
1
+ ref: refs/heads/master
@@ -0,0 +1,7 @@
1
+ [core]
2
+ repositoryformatversion = 0
3
+ filemode = true
4
+ bare = false
5
+ logallrefupdates = true
6
+ ignorecase = true
7
+ precomposeunicode = true
@@ -0,0 +1 @@
1
+ Unnamed repository; edit this file 'description' to name the repository.
@@ -0,0 +1,15 @@
1
+ #!/bin/sh
2
+ #
3
+ # An example hook script to check the commit log message taken by
4
+ # applypatch from an e-mail message.
5
+ #
6
+ # The hook should exit with non-zero status after issuing an
7
+ # appropriate message if it wants to stop the commit. The hook is
8
+ # allowed to edit the commit message file.
9
+ #
10
+ # To enable this hook, rename this file to "applypatch-msg".
11
+
12
+ . git-sh-setup
13
+ commitmsg="$(git rev-parse --git-path hooks/commit-msg)"
14
+ test -x "$commitmsg" && exec "$commitmsg" ${1+"$@"}
15
+ :
@@ -0,0 +1,24 @@
1
+ #!/bin/sh
2
+ #
3
+ # An example hook script to check the commit log message.
4
+ # Called by "git commit" with one argument, the name of the file
5
+ # that has the commit message. The hook should exit with non-zero
6
+ # status after issuing an appropriate message if it wants to stop the
7
+ # commit. The hook is allowed to edit the commit message file.
8
+ #
9
+ # To enable this hook, rename this file to "commit-msg".
10
+
11
+ # Uncomment the below to add a Signed-off-by line to the message.
12
+ # Doing this in a hook is a bad idea in general, but the prepare-commit-msg
13
+ # hook is more suited to it.
14
+ #
15
+ # SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
16
+ # grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
17
+
18
+ # This example catches duplicate Signed-off-by lines.
19
+
20
+ test "" = "$(grep '^Signed-off-by: ' "$1" |
21
+ sort | uniq -c | sed -e '/^[ ]*1[ ]/d')" || {
22
+ echo >&2 Duplicate Signed-off-by lines.
23
+ exit 1
24
+ }
@@ -0,0 +1,174 @@
1
+ #!/usr/bin/perl
2
+
3
+ use strict;
4
+ use warnings;
5
+ use IPC::Open2;
6
+
7
+ # An example hook script to integrate Watchman
8
+ # (https://facebook.github.io/watchman/) with git to speed up detecting
9
+ # new and modified files.
10
+ #
11
+ # The hook is passed a version (currently 2) and last update token
12
+ # formatted as a string and outputs to stdout a new update token and
13
+ # all files that have been modified since the update token. Paths must
14
+ # be relative to the root of the working tree and separated by a single NUL.
15
+ #
16
+ # To enable this hook, rename this file to "query-watchman" and set
17
+ # 'git config core.fsmonitor .git/hooks/query-watchman'
18
+ #
19
+ my ($version, $last_update_token) = @ARGV;
20
+
21
+ # Uncomment for debugging
22
+ # print STDERR "$0 $version $last_update_token\n";
23
+
24
+ # Check the hook interface version
25
+ if ($version ne 2) {
26
+ die "Unsupported query-fsmonitor hook version '$version'.\n" .
27
+ "Falling back to scanning...\n";
28
+ }
29
+
30
+ my $git_work_tree = get_working_dir();
31
+
32
+ my $retry = 1;
33
+
34
+ my $json_pkg;
35
+ eval {
36
+ require JSON::XS;
37
+ $json_pkg = "JSON::XS";
38
+ 1;
39
+ } or do {
40
+ require JSON::PP;
41
+ $json_pkg = "JSON::PP";
42
+ };
43
+
44
+ launch_watchman();
45
+
46
+ sub launch_watchman {
47
+ my $o = watchman_query();
48
+ if (is_work_tree_watched($o)) {
49
+ output_result($o->{clock}, @{$o->{files}});
50
+ }
51
+ }
52
+
53
+ sub output_result {
54
+ my ($clockid, @files) = @_;
55
+
56
+ # Uncomment for debugging watchman output
57
+ # open (my $fh, ">", ".git/watchman-output.out");
58
+ # binmode $fh, ":utf8";
59
+ # print $fh "$clockid\n@files\n";
60
+ # close $fh;
61
+
62
+ binmode STDOUT, ":utf8";
63
+ print $clockid;
64
+ print "\0";
65
+ local $, = "\0";
66
+ print @files;
67
+ }
68
+
69
+ sub watchman_clock {
70
+ my $response = qx/watchman clock "$git_work_tree"/;
71
+ die "Failed to get clock id on '$git_work_tree'.\n" .
72
+ "Falling back to scanning...\n" if $? != 0;
73
+
74
+ return $json_pkg->new->utf8->decode($response);
75
+ }
76
+
77
+ sub watchman_query {
78
+ my $pid = open2(\*CHLD_OUT, \*CHLD_IN, 'watchman -j --no-pretty')
79
+ or die "open2() failed: $!\n" .
80
+ "Falling back to scanning...\n";
81
+
82
+ # In the query expression below we're asking for names of files that
83
+ # changed since $last_update_token but not from the .git folder.
84
+ #
85
+ # To accomplish this, we're using the "since" generator to use the
86
+ # recency index to select candidate nodes and "fields" to limit the
87
+ # output to file names only. Then we're using the "expression" term to
88
+ # further constrain the results.
89
+ my $last_update_line = "";
90
+ if (substr($last_update_token, 0, 1) eq "c") {
91
+ $last_update_token = "\"$last_update_token\"";
92
+ $last_update_line = qq[\n"since": $last_update_token,];
93
+ }
94
+ my $query = <<" END";
95
+ ["query", "$git_work_tree", {$last_update_line
96
+ "fields": ["name"],
97
+ "expression": ["not", ["dirname", ".git"]]
98
+ }]
99
+ END
100
+
101
+ # Uncomment for debugging the watchman query
102
+ # open (my $fh, ">", ".git/watchman-query.json");
103
+ # print $fh $query;
104
+ # close $fh;
105
+
106
+ print CHLD_IN $query;
107
+ close CHLD_IN;
108
+ my $response = do {local $/; <CHLD_OUT>};
109
+
110
+ # Uncomment for debugging the watch response
111
+ # open ($fh, ">", ".git/watchman-response.json");
112
+ # print $fh $response;
113
+ # close $fh;
114
+
115
+ die "Watchman: command returned no output.\n" .
116
+ "Falling back to scanning...\n" if $response eq "";
117
+ die "Watchman: command returned invalid output: $response\n" .
118
+ "Falling back to scanning...\n" unless $response =~ /^\{/;
119
+
120
+ return $json_pkg->new->utf8->decode($response);
121
+ }
122
+
123
+ sub is_work_tree_watched {
124
+ my ($output) = @_;
125
+ my $error = $output->{error};
126
+ if ($retry > 0 and $error and $error =~ m/unable to resolve root .* directory (.*) is not watched/) {
127
+ $retry--;
128
+ my $response = qx/watchman watch "$git_work_tree"/;
129
+ die "Failed to make watchman watch '$git_work_tree'.\n" .
130
+ "Falling back to scanning...\n" if $? != 0;
131
+ $output = $json_pkg->new->utf8->decode($response);
132
+ $error = $output->{error};
133
+ die "Watchman: $error.\n" .
134
+ "Falling back to scanning...\n" if $error;
135
+
136
+ # Uncomment for debugging watchman output
137
+ # open (my $fh, ">", ".git/watchman-output.out");
138
+ # close $fh;
139
+
140
+ # Watchman will always return all files on the first query so
141
+ # return the fast "everything is dirty" flag to git and do the
142
+ # Watchman query just to get it over with now so we won't pay
143
+ # the cost in git to look up each individual file.
144
+ my $o = watchman_clock();
145
+ $error = $output->{error};
146
+
147
+ die "Watchman: $error.\n" .
148
+ "Falling back to scanning...\n" if $error;
149
+
150
+ output_result($o->{clock}, ("/"));
151
+ $last_update_token = $o->{clock};
152
+
153
+ eval { launch_watchman() };
154
+ return 0;
155
+ }
156
+
157
+ die "Watchman: $error.\n" .
158
+ "Falling back to scanning...\n" if $error;
159
+
160
+ return 1;
161
+ }
162
+
163
+ sub get_working_dir {
164
+ my $working_dir;
165
+ if ($^O =~ 'msys' || $^O =~ 'cygwin') {
166
+ $working_dir = Win32::GetCwd();
167
+ $working_dir =~ tr/\\/\//;
168
+ } else {
169
+ require Cwd;
170
+ $working_dir = Cwd::cwd();
171
+ }
172
+
173
+ return $working_dir;
174
+ }
@@ -0,0 +1,8 @@
1
+ #!/bin/sh
2
+ #
3
+ # An example hook script to prepare a packed repository for use over
4
+ # dumb transports.
5
+ #
6
+ # To enable this hook, rename this file to "post-update".
7
+
8
+ exec git update-server-info
@@ -0,0 +1,14 @@
1
+ #!/bin/sh
2
+ #
3
+ # An example hook script to verify what is about to be committed
4
+ # by applypatch from an e-mail message.
5
+ #
6
+ # The hook should exit with non-zero status after issuing an
7
+ # appropriate message if it wants to stop the commit.
8
+ #
9
+ # To enable this hook, rename this file to "pre-applypatch".
10
+
11
+ . git-sh-setup
12
+ precommit="$(git rev-parse --git-path hooks/pre-commit)"
13
+ test -x "$precommit" && exec "$precommit" ${1+"$@"}
14
+ :
@@ -0,0 +1,49 @@
1
+ #!/bin/sh
2
+ #
3
+ # An example hook script to verify what is about to be committed.
4
+ # Called by "git commit" with no arguments. The hook should
5
+ # exit with non-zero status after issuing an appropriate message if
6
+ # it wants to stop the commit.
7
+ #
8
+ # To enable this hook, rename this file to "pre-commit".
9
+
10
+ if git rev-parse --verify HEAD >/dev/null 2>&1
11
+ then
12
+ against=HEAD
13
+ else
14
+ # Initial commit: diff against an empty tree object
15
+ against=$(git hash-object -t tree /dev/null)
16
+ fi
17
+
18
+ # If you want to allow non-ASCII filenames set this variable to true.
19
+ allownonascii=$(git config --type=bool hooks.allownonascii)
20
+
21
+ # Redirect output to stderr.
22
+ exec 1>&2
23
+
24
+ # Cross platform projects tend to avoid non-ASCII filenames; prevent
25
+ # them from being added to the repository. We exploit the fact that the
26
+ # printable range starts at the space character and ends with tilde.
27
+ if [ "$allownonascii" != "true" ] &&
28
+ # Note that the use of brackets around a tr range is ok here, (it's
29
+ # even required, for portability to Solaris 10's /usr/bin/tr), since
30
+ # the square bracket bytes happen to fall in the designated range.
31
+ test $(git diff --cached --name-only --diff-filter=A -z $against |
32
+ LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0
33
+ then
34
+ cat <<\EOF
35
+ Error: Attempt to add a non-ASCII file name.
36
+
37
+ This can cause problems if you want to work with people on other platforms.
38
+
39
+ To be portable it is advisable to rename the file.
40
+
41
+ If you know what you are doing you can disable this check using:
42
+
43
+ git config hooks.allownonascii true
44
+ EOF
45
+ exit 1
46
+ fi
47
+
48
+ # If there are whitespace errors, print the offending file names and fail.
49
+ exec git diff-index --check --cached $against --
@@ -0,0 +1,13 @@
1
+ #!/bin/sh
2
+ #
3
+ # An example hook script to verify what is about to be committed.
4
+ # Called by "git merge" with no arguments. The hook should
5
+ # exit with non-zero status after issuing an appropriate message to
6
+ # stderr if it wants to stop the merge commit.
7
+ #
8
+ # To enable this hook, rename this file to "pre-merge-commit".
9
+
10
+ . git-sh-setup
11
+ test -x "$GIT_DIR/hooks/pre-commit" &&
12
+ exec "$GIT_DIR/hooks/pre-commit"
13
+ :
@@ -0,0 +1,53 @@
1
+ #!/bin/sh
2
+
3
+ # An example hook script to verify what is about to be pushed. Called by "git
4
+ # push" after it has checked the remote status, but before anything has been
5
+ # pushed. If this script exits with a non-zero status nothing will be pushed.
6
+ #
7
+ # This hook is called with the following parameters:
8
+ #
9
+ # $1 -- Name of the remote to which the push is being done
10
+ # $2 -- URL to which the push is being done
11
+ #
12
+ # If pushing without using a named remote those arguments will be equal.
13
+ #
14
+ # Information about the commits which are being pushed is supplied as lines to
15
+ # the standard input in the form:
16
+ #
17
+ # <local ref> <local oid> <remote ref> <remote oid>
18
+ #
19
+ # This sample shows how to prevent push of commits where the log message starts
20
+ # with "WIP" (work in progress).
21
+
22
+ remote="$1"
23
+ url="$2"
24
+
25
+ zero=$(git hash-object --stdin </dev/null | tr '[0-9a-f]' '0')
26
+
27
+ while read local_ref local_oid remote_ref remote_oid
28
+ do
29
+ if test "$local_oid" = "$zero"
30
+ then
31
+ # Handle delete
32
+ :
33
+ else
34
+ if test "$remote_oid" = "$zero"
35
+ then
36
+ # New branch, examine all commits
37
+ range="$local_oid"
38
+ else
39
+ # Update to existing branch, examine new commits
40
+ range="$remote_oid..$local_oid"
41
+ fi
42
+
43
+ # Check for WIP commit
44
+ commit=$(git rev-list -n 1 --grep '^WIP' "$range")
45
+ if test -n "$commit"
46
+ then
47
+ echo >&2 "Found WIP commit in $local_ref, not pushing"
48
+ exit 1
49
+ fi
50
+ fi
51
+ done
52
+
53
+ exit 0