winglang/wing

Use formatter and linter for JSON, JS, etc

Open

#279 opened on Oct 17, 2022

View on GitHub
 (3 comments) (0 reactions) (0 assignees)TypeScript (214 forks)github user discovery
good first issue👷‍♀️ contributor-experience

Repository metrics

Stars
 (5,385 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

I noticed the lack of formatting and linting rules. Specially, the file libs/tree-sitter-wing/grammar.js is not subject to any rules. A prettier config file would be appreciated, otherwise my editor will format with my personal styles when saving, changing the whole file. That may happen to lots of contributors as well.

I suggest using an editorconfig config file (ensures indentation style, end of files, lines at eof, etc), along with a prettier config file.

Related to https://github.com/monadahq/winglang/issues/272.

Contributor guide

Research direction
Check the existing project root for any formatting config files like .editorconfig or prettier config. If missing, create .editorconfig and prettier config (e.g., .prettierrc) with sensible defaults. Ensure the config applies to the file libs/tree sitter wing/grammar.js and other files. Consider adding a lint script in package.json.
Tech stack
javascripttypescript
Domain
developer experiencetooling
Issue type
Chore
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95