tc39 / tc39/ecmarkup

Render ecma262 in PRs

Open
#175 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
245
Forks
80
Avg merge
10h 46m
Merged PRs (30d)
2

Description

Since https://github.com/tc39/ecma262 is the main consumer of this project, I think it would make sense to render it on every PR using the PR's branch of this project, so we can see the effect of the PR (and confirm that it builds at all). It should be pretty straightforward:

npm ci
npm run build
git clone --depth=1 https://github.com/tc39/ecma262.git
mkdir -p out
cp -r ecma262/img out
node bin/ecmarkup.js --verbose ecma262/spec.html out/index.html --css out/ecmarkup.css --js out/ecmarkup.js

Possibly we should also include some sort of warning that these versions are non-normative, as we do in ecma262.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running npm ci and npm run build, then inspect bin/ecmarkup.js and the provided command for rendering ecma262/spec.html from a checkout of ecma262. The work is done when each PR renders the specification using that PR's build, confirms the build succeeds, and addresses whether non-normative output needs a warning.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js, typescript
Domain
build-system, ci-cd
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.