You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix: Add codespell: workflow, config and fix typos it finds (#1843)
* Add github action to codespell main on push and PRs
* Add rudimentary codespell config
* Ignore some common short words
* [DATALAD RUNCMD] Do interactive fixing of some ambigous typos
* Manually committing selected fixed by codespell to those files in the tests
* Skip __tests__
* [DATALAD RUNCMD] run codespell throughout fixing typo automagically
* docs: add @yarikoptic as a contributor
<p>Since it succeeded, it will show up on the <ahref="https://github.com/isomorphic-git/isomorphic-git">Github page</a>
276
276
near the top, under "Your recently pushed branches:". I go there and click the "Compare & pull request" button.</p>
277
277
<p>By default, Github uses the commit message as the PR title, which is usually fine.
278
278
However, now I will tack on "(fixes #107)" to the end of the title just so Github automatically creates a hyperlink between
279
279
the issue and the PR.</p>
280
280
<p>... I lied. Github is not smart enough to use the PR title. :eyeroll:
281
-
I edit the PR description to be "fixes #107" and <em>then</em> Github adds the "wmhilton referened this issue a minute ago" link to the PR to the issue.</p>
281
+
I edit the PR description to be "fixes #107" and <em>then</em> Github adds the "wmhilton referenced this issue a minute ago" link to the PR to the issue.</p>
282
282
<p>Now we wait for the Continuous Integration (CI) system to do its thing.
283
283
I didn't actually check if it would work in the browser -
284
284
which we could have done by running <code>npm run test</code> (which will run Jasmine and Karma) instead of just <code>jest</code> -
<p>Since it succeeded, it will show up on the <ahref="https://github.com/isomorphic-git/isomorphic-git">Github page</a>
276
276
near the top, under "Your recently pushed branches:". I go there and click the "Compare & pull request" button.</p>
277
277
<p>By default, Github uses the commit message as the PR title, which is usually fine.
278
278
However, now I will tack on "(fixes #107)" to the end of the title just so Github automatically creates a hyperlink between
279
279
the issue and the PR.</p>
280
280
<p>... I lied. Github is not smart enough to use the PR title. :eyeroll:
281
-
I edit the PR description to be "fixes #107" and <em>then</em> Github adds the "wmhilton referened this issue a minute ago" link to the PR to the issue.</p>
281
+
I edit the PR description to be "fixes #107" and <em>then</em> Github adds the "wmhilton referenced this issue a minute ago" link to the PR to the issue.</p>
282
282
<p>Now we wait for the Continuous Integration (CI) system to do its thing.
283
283
I didn't actually check if it would work in the browser -
284
284
which we could have done by running <code>npm run test</code> (which will run Jasmine and Karma) instead of just <code>jest</code> -
<p>The functions themselves have been tweaked so that the <ahref="https://github.com/isomorphic-git/isomorphic-git/blob/master/src/typedefs.js">core object interfaces</a> (<code>CommitObject</code>, <code>TreeEntry</code>, <code>TagObject</code>, etc) are reused wherever possible,
85
-
so that all the functions feel consistant and there are no surprises.
85
+
so that all the functions feel consistent and there are no surprises.
86
86
The result is a cleaner API where the documentation comes to you, right where you are.</p>
<p>The return types gel with TS better now. For example, <code>readObject</code> returns a "discriminated union" type, so you can take advantage of powerful type inference, like this:</p>
<li>The <code>autoTranslateSSH</code> feature was removed, since it is trivial to implement your own version using just the <code>UnknownTransportError.data.suggestion</code></li>
185
185
<li>The <code>writeObject</code> function when used to write a tree now expects a plain array rather than an object with a property called <code>entries</code> which is the array. (This is so that argument to <code>writeObject</code> has the same shape as the arguments to <code>writeBlob</code>/<code>writeCommit</code>/<code>writeTag</code>/<code>writeTree</code>.)</li>
186
186
<li>The <code>noOverwrite</code> parameter was removed from <code>init</code> and is the new behavior.</li>
187
-
<li>The <code>author.date</code>, <code>committer.date</code>, <code>tagger.date</code> parameters were removed in favor of <code>author.timestamp</code>, <code>comitter.timestamp</code>, <code>tagger.timestamp</code> in order to be clear about what is actually written and share the same shape as the return types in <code>readCommit</code>, <code>log</code>, and <code>readTag</code>.</li>
187
+
<li>The <code>author.date</code>, <code>committer.date</code>, <code>tagger.date</code> parameters were removed in favor of <code>author.timestamp</code>, <code>committer.timestamp</code>, <code>tagger.timestamp</code> in order to be clear about what is actually written and share the same shape as the return types in <code>readCommit</code>, <code>log</code>, and <code>readTag</code>.</li>
<p>The functions themselves have been tweaked so that the <ahref="https://github.com/isomorphic-git/isomorphic-git/blob/master/src/typedefs.js">core object interfaces</a> (<code>CommitObject</code>, <code>TreeEntry</code>, <code>TagObject</code>, etc) are reused wherever possible,
85
-
so that all the functions feel consistant and there are no surprises.
85
+
so that all the functions feel consistent and there are no surprises.
86
86
The result is a cleaner API where the documentation comes to you, right where you are.</p>
<p>The return types gel with TS better now. For example, <code>readObject</code> returns a "discriminated union" type, so you can take advantage of powerful type inference, like this:</p>
<li>The <code>autoTranslateSSH</code> feature was removed, since it is trivial to implement your own version using just the <code>UnknownTransportError.data.suggestion</code></li>
185
185
<li>The <code>writeObject</code> function when used to write a tree now expects a plain array rather than an object with a property called <code>entries</code> which is the array. (This is so that argument to <code>writeObject</code> has the same shape as the arguments to <code>writeBlob</code>/<code>writeCommit</code>/<code>writeTag</code>/<code>writeTree</code>.)</li>
186
186
<li>The <code>noOverwrite</code> parameter was removed from <code>init</code> and is the new behavior.</li>
187
-
<li>The <code>author.date</code>, <code>committer.date</code>, <code>tagger.date</code> parameters were removed in favor of <code>author.timestamp</code>, <code>comitter.timestamp</code>, <code>tagger.timestamp</code> in order to be clear about what is actually written and share the same shape as the return types in <code>readCommit</code>, <code>log</code>, and <code>readTag</code>.</li>
187
+
<li>The <code>author.date</code>, <code>committer.date</code>, <code>tagger.date</code> parameters were removed in favor of <code>author.timestamp</code>, <code>committer.timestamp</code>, <code>tagger.timestamp</code> in order to be clear about what is actually written and share the same shape as the return types in <code>readCommit</code>, <code>log</code>, and <code>readTag</code>.</li>
<p>The functions themselves have been tweaked so that the <ahref="https://github.com/isomorphic-git/isomorphic-git/blob/master/src/typedefs.js">core object interfaces</a> (<code>CommitObject</code>, <code>TreeEntry</code>, <code>TagObject</code>, etc) are reused wherever possible,
85
-
so that all the functions feel consistant and there are no surprises.
85
+
so that all the functions feel consistent and there are no surprises.
86
86
The result is a cleaner API where the documentation comes to you, right where you are.</p>
<p>The return types gel with TS better now. For example, <code>readObject</code> returns a "discriminated union" type, so you can take advantage of powerful type inference, like this:</p>
<li>The <code>autoTranslateSSH</code> feature was removed, since it is trivial to implement your own version using just the <code>UnknownTransportError.data.suggestion</code></li>
185
185
<li>The <code>writeObject</code> function when used to write a tree now expects a plain array rather than an object with a property called <code>entries</code> which is the array. (This is so that argument to <code>writeObject</code> has the same shape as the arguments to <code>writeBlob</code>/<code>writeCommit</code>/<code>writeTag</code>/<code>writeTree</code>.)</li>
186
186
<li>The <code>noOverwrite</code> parameter was removed from <code>init</code> and is the new behavior.</li>
187
-
<li>The <code>author.date</code>, <code>committer.date</code>, <code>tagger.date</code> parameters were removed in favor of <code>author.timestamp</code>, <code>comitter.timestamp</code>, <code>tagger.timestamp</code> in order to be clear about what is actually written and share the same shape as the return types in <code>readCommit</code>, <code>log</code>, and <code>readTag</code>.</li>
187
+
<li>The <code>author.date</code>, <code>committer.date</code>, <code>tagger.date</code> parameters were removed in favor of <code>author.timestamp</code>, <code>committer.timestamp</code>, <code>tagger.timestamp</code> in order to be clear about what is actually written and share the same shape as the return types in <code>readCommit</code>, <code>log</code>, and <code>readTag</code>.</li>
<p>Since it succeeded, it will show up on the <ahref="https://github.com/isomorphic-git/isomorphic-git">Github page</a>
490
490
near the top, under "Your recently pushed branches:". I go there and click the "Compare & pull request" button.</p>
491
491
<p>By default, Github uses the commit message as the PR title, which is usually fine.
492
492
However, now I will tack on "(fixes #107)" to the end of the title just so Github automatically creates a hyperlink between
493
493
the issue and the PR.</p>
494
494
<p>... I lied. Github is not smart enough to use the PR title. :eyeroll:
495
-
I edit the PR description to be "fixes #107" and <em>then</em> Github adds the "wmhilton referened this issue a minute ago" link to the PR to the issue.</p>
495
+
I edit the PR description to be "fixes #107" and <em>then</em> Github adds the "wmhilton referenced this issue a minute ago" link to the PR to the issue.</p>
496
496
<p>Now we wait for the Continuous Integration (CI) system to do its thing.
497
497
I didn't actually check if it would work in the browser -
498
498
which we could have done by running <code>npm run test</code> (which will run Jasmine and Karma) instead of just <code>jest</code> -
Copy file name to clipboardExpand all lines: docs/en/0.70.7/annotatedTag.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -73,7 +73,7 @@
73
73
<tr><td>tagger.date</td><td>string</td><td>Set the tagger timestamp field. Default is the current date.</td></tr>
74
74
<tr><td>tagger.timestamp</td><td>string</td><td>Set the tagger timestamp field. This is an alternative to using <code>date</code> using an integer number of seconds since the Unix epoch instead of a JavaScript date object.</td></tr>
75
75
<tr><td>tagger.timezoneOffset</td><td>string</td><td>Set the tagger timezone offset field. This is the difference, in minutes, from the current timezone to UTC. Default is <code>(new Date()).getTimezoneOffset()</code>.</td></tr>
76
-
<tr><td>signature</td><td>string</td><td>The signature attatched to the tag object. (Mutually exclusive with the <code>signingKey</code> option.)</td></tr>
76
+
<tr><td>signature</td><td>string</td><td>The signature attached to the tag object. (Mutually exclusive with the <code>signingKey</code> option.)</td></tr>
77
77
<tr><td>signingKey</td><td>string</td><td>Sign the tag object using this private PGP key. (Mutually exclusive with the <code>signature</code> option.)</td></tr>
78
78
<tr><td>force</td><td>boolean = false</td><td>Instead of throwing an error if a tag named <code>ref</code> already exists, overwrite the existing tag. Note that this option does not modify the original tag object itself.</td></tr>
79
79
<tr><td>return</td><td>Promise<void></td><td>Resolves successfully when filesystem operations are complete</td></tr>
Copy file name to clipboardExpand all lines: docs/en/0.70.7/annotatedTag/index.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -73,7 +73,7 @@
73
73
<tr><td>tagger.date</td><td>string</td><td>Set the tagger timestamp field. Default is the current date.</td></tr>
74
74
<tr><td>tagger.timestamp</td><td>string</td><td>Set the tagger timestamp field. This is an alternative to using <code>date</code> using an integer number of seconds since the Unix epoch instead of a JavaScript date object.</td></tr>
75
75
<tr><td>tagger.timezoneOffset</td><td>string</td><td>Set the tagger timezone offset field. This is the difference, in minutes, from the current timezone to UTC. Default is <code>(new Date()).getTimezoneOffset()</code>.</td></tr>
76
-
<tr><td>signature</td><td>string</td><td>The signature attatched to the tag object. (Mutually exclusive with the <code>signingKey</code> option.)</td></tr>
76
+
<tr><td>signature</td><td>string</td><td>The signature attached to the tag object. (Mutually exclusive with the <code>signingKey</code> option.)</td></tr>
77
77
<tr><td>signingKey</td><td>string</td><td>Sign the tag object using this private PGP key. (Mutually exclusive with the <code>signature</code> option.)</td></tr>
78
78
<tr><td>force</td><td>boolean = false</td><td>Instead of throwing an error if a tag named <code>ref</code> already exists, overwrite the existing tag. Note that this option does not modify the original tag object itself.</td></tr>
79
79
<tr><td>return</td><td>Promise<void></td><td>Resolves successfully when filesystem operations are complete</td></tr>
0 commit comments