Skip to content

Convert to ecmarkup - #120

Open
gesa wants to merge 10 commits into
WinterTC55:mainfrom
gesa:convert-to-ecmarkup
Open

Convert to ecmarkup#120
gesa wants to merge 10 commits into
WinterTC55:mainfrom
gesa:convert-to-ecmarkup

Conversation

@gesa

@gesa gesa commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

I wish git did a better job of letting a file be renamed and then changed. or changed and then renamed. basically, I wish git could handle renaming files.

@gesa
gesa requested review from ctcpip and jasnell August 28, 2026 14:06
@gesa gesa added the enhancement New feature or request label Aug 28, 2026
@gesa

gesa commented Aug 28, 2026

Copy link
Copy Markdown
Contributor Author

@gesa gesa left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Differences to watch for:

  • Clause 5.3 Web workers is now identified as normative-optional, due to the fact that supporting web workers is not a requirement, but if an implementation does support web workers, the requirements apply.
  • references to Clause 6 are weird. the clause title is "The global scope" which makes for odd mid-sentence reference. Maybe just use "see clause 6" or manually title xrefs as 'the global scope'.

Suggestions

  • Add "ECMAScript" as a term in clause 4
  • Rename all Clause 5 subclauses to drop "Methods and properties defined in" and "Interfaces defined in". Maybe add another single sentence to clarify in clause 5 or at the beginning of clauses 5.1 & 5.2
  • I think I've tested most of the links? someone should do so systematically. or add a script into ecmarkup/emu-format to do that for me.

I've updated the files in the comment above (and torched the cache) with the last few commits

Comment thread index.emu.html

<p>Since code running in web browsers makes up the vast majority of ECMAScript code, runtimes are incentivised to support the same APIs as web browsers. However, without a specification of which web platform APIs to be implemented, the resulting landscape provides poor interoperability across such environments.</p>

<p>As such, this Ecma Standard defines the Minimum common web API specification, which defines a subset of Web Platform APIs for server runtimes to implement for interoperability with the web. This is the first edition of the standard, corresponding to the 2025 snapshot. As the web platform and web server runtimes grow and evolve, the committee will aim to publish with an annual cadence.</p>

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<p>As such, this Ecma Standard defines the Minimum common web API specification, which defines a subset of Web Platform APIs for server runtimes to implement for interoperability with the web. This is the first edition of the standard, corresponding to the 2025 snapshot. As the web platform and web server runtimes grow and evolve, the committee will aim to publish with an annual cadence.</p>
<p>As such, this Ecma Standard defines a minimum common web API, which identifies a subset of Web Platform APIs for server runtimes to implement for interoperability with the web. This is the first edition of the standard, corresponding to the 2025 snapshot. As the web platform and web server runtimes grow and evolve, the committee will aim to publish with a regular cadence.</p>

Comment thread index.emu.html
<emu-clause id="sec-scope">
<h1>Scope</h1>

<p>This Standard defines the 2025 snapshot of the Minimum common web API, a curated subset of APIs defined by web platform standards from W3C and WHATWG, which is intended to define a minimum set of capabilities common to browser and web server runtime environments based on ECMAScript.</p>

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<p>This Standard defines the 2025 snapshot of the Minimum common web API, a curated subset of APIs defined by web platform standards from W3C and WHATWG, which is intended to define a minimum set of capabilities common to browser and web server runtime environments based on ECMAScript.</p>
<p>This Standard defines the 2025 snapshot of the minimum common web API, a curated subset of APIs within web platform standards from standards organizations such as W3C and WHATWG, which is intended to define a minimum set of capabilities common to browser and web server runtime environments based on ECMAScript.</p>

Comment thread index.emu.html
<emu-clause id="sec-conformance">
<h1>Conformance</h1>

<p>A conforming implementation of this Standard shall provide the interfaces and properties listed in this specification, according to their definition in the corresponding W3C or WHATWG standard. A conforming implementation shall also conform to ECMA-262.</p>

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<p>A conforming implementation of this Standard shall provide the interfaces and properties listed in this specification, according to their definition in the corresponding W3C or WHATWG standard. A conforming implementation shall also conform to ECMA-262.</p>
<p>A conforming implementation of this Standard shall provide the interfaces and properties listed in this specification, according to their definition in the corresponding standard. A conforming implementation shall also conform to ECMA-262.</p>

@gesa
gesa marked this pull request as ready for review August 31, 2026 14:00
Comment thread package.json
"build": "mkdir -p out && curl --retry 2 --fail https://www.w3.org/publications/spec-generator/ --output out/index.html -F type=bikeshed-spec -F die-on=fatal -F file=@index.bs"
"clean": "rm -rf out",
"prebuild": "npm run clean && mkdir out && cp -R img out",
"build": "ecmarkup --verbose index.emu.html out/index.html --assets external --assets-dir out",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if we wanted, we could have the pdf also built automatically and available on the website.

@jasnell jasnell left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with the additional suggested edits.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants