microsoft / microsoft/fluentui

tools: format/order particular type of files automatically

Open
#19,561 17 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Area: Build System Resolution: Soft Close
Dominant language
TypeScript
Stars
20.3k
Forks
2.9k
Avg merge
2d 9h
Merged PRs (30d)
46

Description

nx is properly re-ordering/formatting tsconfig.json.base#paths, nx.json, workspace.json after any kind of generator is invoked that creates/updates/removes a package to maintain consistency and to reduce merge conflicts.

We should extend this behaviour and introduce similar automation to our particular needs.

Candidates (we will update this list as needed):

  • any package.json (scripts,dependencies) should be sorted to follow npm/yarn ordering when modified manually or by generator
  • ADD ANOTHER ONE

How should this work:

  • ideally during pre or push commit hook in the background
  • CI should fail on any kind of violations to not get out of sync if some power user will use --no-verify while running git commands

nit: This dependency should go on line 28 to maintain alphabetical order.

Originally posted by @khmakoto in https://github.com/microsoft/fluentui/pull/19517#discussion_r697619992

Contributor guide

No contributing guide indexed for this repository

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

Start by reviewing the existing nx formatting and ordering behavior for tsconfig.json.base#paths, nx.json, and workspace.json. Then inspect how package.json files are changed by generators and how pre-commit or push hooks and CI checks are configured. Done means the listed file types are consistently ordered or formatted and CI detects violations, with the candidate list clarified.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
ci-cd, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.