tc39 / tc39/test262

YAML formatting restrictions

Open
#1,997 7 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
2.8k
Forks
564
Avg merge
3d 7h
Merged PRs (30d)
10

Description

We should restrict the YAML format for the test files frontmatter to improve interoperability.

Many test runners depend on quick but limited yaml parsers and it's ok to have style restrictions identified in the importing processes for Test262.

Some of them I can already tell from scratch:

  • no leading or trailing spaces from inline lists. e.g.: [ leading-space, foo, trailing-space ]
  • no leading or trailing blank lines from text blocks. e.g. the info tag cannot start with an empty line
  • lists should always be inline. Always wrapped with square brackets and comma-space divided words. e.g.:
  • no leading or trailing spaces for the block comment limiters. (See #2018)
features:
-  - var
-  - foo
-  - bar
+  [var, foo, bar]

There are might be more items we want to identify here. We should increase the list as necessary.

cc @caitp @gsathya @psmarshall

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

No specific files or tests are named. Start by reviewing the Test262 test-file frontmatter importing processes and the YAML examples in this issue; identify the complete restriction list and define done as an agreed set of enforceable formatting rules.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
testing-qa
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.