open-telemetry/opentelemetry-specification

Replace Python yamllint with NPM yaml-lint

Open

#2,347 opened on Feb 15, 2022

View on GitHubContributor guide
 (1 comment) (3 reactions) (1 assignee)Makefile (987 forks)auto 404
Stalehelp wantedspec:miscellaneous

Repository metrics

Stars
 (4,267 stars)
PR merge metrics
 (PR metrics pending)

Description

Most of the linters are in Node, so changing yamllint with Node version simplifies local testing.

Downside: I don't know what feature-parity is between the linters.

$ npm install yaml-lint
$ npx yamllint '**/*.yaml' --ignore='node_modules/**'
✔ YAML Lint successful.

(Note: this depends on #2323)

Contributor guide

Research direction
Install npm yaml lint and update the linter configuration to replace the Python yamllint. Note that this depends on issue #2323, so ensure that is resolved first. Verify all YAML files pass linting with the new tool.
Tech stack
pythonnodejs
Domain
developer experiencetooling
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNPM
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80