ni / ni/javascript-styleguide

Format of the example ESLint configuration files

Open
#90 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
JavaScript
Stars
9
Forks
11
PR merge metrics
No merged PRs in 30d

Description

I was setting up linting for a Node.js environment and was confused by the format of the example configuration files. They are presented as JSON with no module export yet have the syntax of JavaScript. We should pick one syntax.

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

Inspect the example ESLint configuration files and compare their JSON presentation with the JavaScript syntax they currently use. Choose one consistent configuration syntax for the Node.js setup, update the examples, and verify that the resulting format is unambiguous.

Written by the indexing model from the issue text.

Assessment

Tech stack
eslint, javascript, node.js
Domain
documentation, tooling
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.