Meta: integrate aspell for spelling checks #3335

michaelficarra · 2024-05-25T00:20:24Z

Integrates aspell to check the spelling in spec.html. Currently just a package.json script, but if we want this enforced during CI, we should be able to do that, too. Updates a bunch of spellings for a variety of reasons. Commits should be reviewed individually.

ljharb · 2024-05-28T16:22:51Z

"fulfill" has three L's. We don't generally strictly adhere to UK spellings, which imo is a good thing.

Also, "callbackfn" and "comparefn" aren't misspellings, and updating that sort of thing would force MDN to do a lot of updates.

michaelficarra · 2024-05-28T16:34:21Z

We don't generally strictly adhere to UK spellings, which imo is a good thing.

We're very much expected to.

Also, "callbackfn" and "comparefn" aren't misspellings, and updating that sort of thing would force MDN to do a lot of updates.

I think the change is an improvement. I'm fine backing it out, but not on the grounds that MDN ties their documentation to the aliases we use in the spec. There is no stability guarantee for our alias name choices; we should always strive to use whatever we think communicates best.

ljharb · 2024-05-28T16:40:14Z

ecma expects a lot of things that we elect not to do, for the betterment of tc39 and this spec :-)

michaelficarra · 2024-05-28T16:45:32Z

Yes, and the editor group has quite explicitly agreed upon our divergences, such as:

But we've no good reason to diverge from the OED spelling requirement, IMO. We'll talk about it in editor call.

spec.html

bakkot · 2024-05-29T22:58:32Z

Summarizing my preferences from the call:

We'll review the changes in this PR individually. I lean towards using UK spellings just so there's an easy rule to follow.
We should have a package.json script which runs against the current spec and extracts a list of words which are already used. Compound words, like AbstractOperationNames, should get split up in the obvious way. Then we can have a separate script which consumes that list as the dictionary. In CI, we can run the first script on the upstream version, and the second script on the PR, and that will tell us if the PR introduces any new potential misspellings (with possibly some false negatives, but whatever). Ideally it would leave these as comments on the PR, and should not be treated as a check which has to pass to land the change.

linusg

US vs UK spelling aside, I'm a big fan of the outerPrivEnv → outerPrivateEnv / iterNextObj → iteratorResult / ... changes! I've been spelling these words out when translating spec text into code and it usually leads to improved readability.

syg · 2024-06-05T21:22:58Z

spec.html

@@ -47634,7 +47634,7 @@ <h1>GetGeneratorKind ( ): ~non-generator~, ~sync~, or ~async~</h1>
      <emu-clause id="sec-generatoryield" type="abstract operation">
        <h1>
          GeneratorYield (
-            _iterNextObj_: an Object that conforms to the <i>IteratorResult</i> interface,
+            _iteratorResult_: an Object that conforms to the <i>IteratorResult</i> interface,


Maybe iteratorResultToYield?

syg · 2024-06-05T21:24:08Z

spec.html

        <p>This method performs the following steps when called:</p>
        <emu-alg>
          1. Let _S_ be the *this* value.
-          1. Return ? CreateHTML(_S_, *"font"*, *"color"*, _color_).
+          1. Return ? CreateHTML(_S_, *"font"*, *"color"*, _colour_).


Let's keep these color. I'd prefer algorithm steps and aliases to be American spelling, like code.

syg · 2024-06-05T21:24:49Z

spec.html

-            1. Let _shiftCount_ be ℝ(_rnum_) modulo 32.
-            1. Return the result of left shifting _lnum_ by _shiftCount_ bits. The mathematical value of the result is exactly representable as a 32-bit two's complement bit string.
+            1. Let _lNum_ be ! ToInt32(_x_).
+            1. Let _rNum_ be ! ToUint32(_y_).


I do not like rFoo and lFoo over rfoo and lfoo.

syg · 2024-06-05T21:25:28Z

spec.html

@@ -50440,8 +50440,8 @@ <h1>Changes to FunctionDeclarationInstantiation</h1>
                1. When the |FunctionDeclaration| _f_ is evaluated, perform the following steps in place of the |FunctionDeclaration| Evaluation algorithm provided in <emu-xref href="#sec-function-definitions-runtime-semantics-evaluation"></emu-xref>:
                  1. Let _fEnv_ be the running execution context's VariableEnvironment.
                  1. Let _bEnv_ be the running execution context's LexicalEnvironment.
-                  1. Let _fobj_ be ! _bEnv_.GetBindingValue(_F_, *false*).
-                  1. Perform ! _fEnv_.SetMutableBinding(_F_, _fobj_, *false*).
+                  1. Let _fObj_ be ! _bEnv_.GetBindingValue(_F_, *false*).


I also do not like fObj over fobj. Overall not a fan of one lowercase letter then capitalized word.

syg · 2024-06-05T21:27:17Z

spec.html

@@ -26881,7 +26881,7 @@ <h1>Example Cyclic Module Record Graphs</h1>
          <ul>
            <li>Evaluation must be only performed once, as it can cause side effects; it is thus important to remember whether evaluation has already been performed, even if unsuccessfully. (In the error case, it makes sense to also remember the exception because otherwise subsequent Evaluate() calls would have to synthesize a new one.)</li>
            <li>Linking, on the other hand, is side-effect-free, and thus even if it fails, it can be retried at a later time with no issues.</li>
-            <li>Loading closely interacts with the host, and it may be desiderable for some of them to allow users to retry failed loads (for example, if the failure is caused by temporarily bad network conditions).</li>
+            <li>Loading closely interacts with the host, and it may be desirable for some of them to allow users to retry failed loads (for example, if the failure is caused by temporarily bad network conditions).</li>


Desiderable should be a word I tell you what.

syg · 2024-06-05T21:28:07Z

spec.html

@@ -42954,8 +42954,8 @@ <h1>
            1. Let _rawBytes_ be a List whose elements are the 8 bytes that are the IEEE 754-2019 binary64 format encoding of _value_. The bytes are arranged in little endian order. If _value_ is *NaN*, _rawBytes_ may be set to any implementation chosen IEEE 754-2019 binary64 format Not-a-Number encoding. An implementation must always choose the same encoding for each implementation distinguishable *NaN* value.
          1. Else,
            1. Let _n_ be the Element Size value specified in <emu-xref href="#table-the-typedarray-constructors"></emu-xref> for Element Type _type_.
-            1. Let _convOp_ be the abstract operation named in the Conversion Operation column in <emu-xref href="#table-the-typedarray-constructors"></emu-xref> for Element Type _type_.
-            1. Let _intValue_ be ℝ(_convOp_(_value_)).
+            1. Let _conversionOperation_ be the abstract operation named in the Conversion Operation column in <emu-xref href="#table-the-typedarray-constructors"></emu-xref> for Element Type _type_.


Eh, kinda long. Maybe just op?

bakkot · 2024-07-26T00:33:47Z

spec.html

@@ -17851,7 +17851,7 @@ <h1>Rules of Automatic Semicolon Insertion</h1>

          AsyncArrowFunction[In, Yield, Await] :
            `async` [no LineTerminator here] AsyncArrowBindingIdentifier[?Yield] [no LineTerminator here] `=>` AsyncConciseBody[?In]
-            CoverCallExpressionAndAsyncArrowHead[?Yield, ?Await] [no LineTerminator here] `=>` AsyncConciseBody[?In] #callcover
+            CoverCallExpressionAndAsyncArrowHead[?Yield, ?Await] [no LineTerminator here] `=>` AsyncConciseBody[?In] #callCover


I wouldn't worry about purely internal stuff like this.

+1, here and below, prefer no change to the ids.

bakkot · 2024-07-26T01:09:27Z

spec.html

@@ -7121,7 +7121,7 @@ <h1>

    <emu-clause id="sec-createiterresultobject" type="abstract operation">
      <h1>
-        CreateIterResultObject (
+        CreateIteratorResultObject (


Maybe worth giving the clause an ID to match the new name? With an oldid, of course.

spec.html

bakkot · 2024-07-26T01:12:32Z

spec.html

@@ -46873,7 +46869,7 @@ <h1>Promise Resolve Functions</h1>

      <emu-clause id="sec-fulfillpromise" type="abstract operation">


I don't see a need to always update the IDs to match the text. We're just going to have to oldid it anyway.

spec.html

scripts/spellcheck.mjs

syg · 2024-08-07T21:48:31Z

spec.html

@@ -17851,7 +17851,7 @@ <h1>Rules of Automatic Semicolon Insertion</h1>

          AsyncArrowFunction[In, Yield, Await] :
            `async` [no LineTerminator here] AsyncArrowBindingIdentifier[?Yield] [no LineTerminator here] `=>` AsyncConciseBody[?In]
-            CoverCallExpressionAndAsyncArrowHead[?Yield, ?Await] [no LineTerminator here] `=>` AsyncConciseBody[?In] #callcover
+            CoverCallExpressionAndAsyncArrowHead[?Yield, ?Await] [no LineTerminator here] `=>` AsyncConciseBody[?In] #callCover


+1, here and below, prefer no change to the ids.

spec.html

syg · 2024-08-07T22:00:27Z

spec.html

@@ -50790,11 +50786,11 @@ <h1>String.prototype.fixed ( )</h1>
      </emu-annex>

      <emu-annex id="sec-string.prototype.fontcolor">
-        <h1>String.prototype.fontcolor ( _color_ )</h1>
+        <h1>String.prototype.fontcolor ( _colour_ )</h1>


I hate this very much but I guess it's fine.

the argument has always been named "color", imo this isn't just spec-internal and shouldn't be changed.

Yeah we were back and forth on this one. Definitely open to changing it back in a follow-up, but the PR was in a good-enough state for now.

michaelficarra added editorial change meta editor call to be discussed in the next editor call labels May 25, 2024

michaelficarra requested a review from a team May 25, 2024 00:20

jmdyck reviewed May 29, 2024

View reviewed changes

spec.html Outdated Show resolved Hide resolved

bakkot removed the editor call to be discussed in the next editor call label Jun 4, 2024

linusg reviewed Jun 5, 2024

View reviewed changes

syg reviewed Jun 5, 2024

View reviewed changes

michaelficarra force-pushed the spelling branch from fe4e842 to 696c141 Compare July 26, 2024 00:21

bakkot reviewed Jul 26, 2024

View reviewed changes

scripts/spellcheck.mjs Show resolved Hide resolved

michaelficarra force-pushed the spelling branch 3 times, most recently from 733031d to aab4308 Compare July 26, 2024 01:40

michaelficarra added the editor call to be discussed in the next editor call label Jul 26, 2024

michaelficarra force-pushed the spelling branch from 7b89e02 to 30911f2 Compare August 7, 2024 21:52

syg reviewed Aug 7, 2024

View reviewed changes

syg approved these changes Aug 7, 2024

View reviewed changes

michaelficarra added ready to merge Editors believe this PR needs no further reviews, and is ready to land. and removed editor call to be discussed in the next editor call labels Aug 7, 2024

michaelficarra added 2 commits August 8, 2024 10:56

Meta: add spellchecking (#3335)

7810d18

Editorial: fix spelling inconsistencies (#3335)

4bc2d8d

ljharb force-pushed the spelling branch from 4fb41a1 to 4bc2d8d Compare August 7, 2024 22:56

ljharb changed the title ~~integrate aspell for spelling checks~~ Meta: integrate aspell for spelling checks Aug 7, 2024

ljharb merged commit 4bc2d8d into main Aug 7, 2024
9 checks passed

ljharb deleted the spelling branch August 7, 2024 23:08

michaelficarra mentioned this pull request Aug 8, 2024

Editorial: rename IDs that were embedded in emu-grammar elements back #3384

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Meta: integrate aspell for spelling checks #3335

Meta: integrate aspell for spelling checks #3335

michaelficarra commented May 25, 2024

ljharb commented May 28, 2024

michaelficarra commented May 28, 2024

ljharb commented May 28, 2024

michaelficarra commented May 28, 2024

bakkot commented May 29, 2024

linusg left a comment

syg Jun 5, 2024

syg Jun 5, 2024

syg Jun 5, 2024

syg Jun 5, 2024

syg Jun 5, 2024

syg Jun 5, 2024

bakkot Jul 26, 2024

syg Aug 7, 2024

bakkot Jul 26, 2024

bakkot Jul 26, 2024

michaelficarra Jul 26, 2024

syg Aug 7, 2024

syg Aug 7, 2024

ljharb Aug 7, 2024

michaelficarra Aug 7, 2024

		@@ -46873,7 +46869,7 @@ <h1>Promise Resolve Functions</h1>

		<emu-clause id="sec-fulfillpromise" type="abstract operation">

Meta: integrate aspell for spelling checks #3335

Meta: integrate aspell for spelling checks #3335

Conversation

michaelficarra commented May 25, 2024

ljharb commented May 28, 2024

michaelficarra commented May 28, 2024

ljharb commented May 28, 2024

michaelficarra commented May 28, 2024

bakkot commented May 29, 2024

linusg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment