ni / ni/javascript-styleguide

Consider updating Angular configuration to match file patterns automatically

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

Nobody has claimed this yet.

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

Description

In research for #126 we noticed that our JS and TS rulesets can automatically target *.js and *.ts files but the Angular one requires client repos to specify overrides for *.js, *.ts, and *.html in their eslintrc. We should evaluate whether the Angular ruleset can and should behave like the others. (Counterargument: when exploring other styleguides, we saw examples where they provided configs that didn't specify file patterns to match).

If we decide to do this, it should include updating the docs for the Angular config to remove the need to specify overrides.

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 are named; start by comparing the Angular ruleset with the JavaScript and TypeScript rulesets, then inspect the Angular configuration guidance for client eslintrc overrides. Done means deciding whether automatic file patterns are appropriate, implementing that decision if accepted, and updating the Angular documentation accordingly.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, eslint, javascript, typescript
Domain
documentation, tooling
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.