Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Report unmapped non-deprecated, standard keys #2222

Merged
merged 3 commits into from
Nov 13, 2024

Conversation

ddbeck
Copy link
Collaborator

@ddbeck ddbeck commented Nov 13, 2024

This adds a few things to the stats script:

  • a compatKeysUnmapped count
  • a currentBurndownSize count (standard, non-deprecated keys to go)
  • a --verbose flag, to get the list of currentBurndown keys
  • an export, so I can use this script's output to generate part of the releases (to come later)

If you want only the burndown list, then npx tsx ./scripts/stats.ts --verbose | jq --raw-output '.currentBurndown[]' pretty prints it (that probably deserves an entry in npm run, honestly).

Built atop #2211.

@github-actions github-actions bot added the tools and infrastructure Project internal tooling, such as linters, GitHub Actions, or repo settings label Nov 13, 2024
This adds a few things to the `stats` script:

- a `compatKeysUnmapped` count
- a `--verbose` flag, to get the list of `toBeMapped` keys
- an export, so I can use this script's output to generate part of the
  releases (to come later)

Built atop web-platform-dx#2211
scripts/stats.ts Outdated
const result = {
features: featureCount,
compatKeys: doneKeys.length,
compatKeysUnmapped: toDoKeys.length,
Copy link
Collaborator

@Elchi3 Elchi3 Nov 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, there are two numbers for unmapped keys here:
(1) toDoKeys.length
(2) toDoKeys.length + deprecatedNonStandardKeys.length

The current compatCoverage percentage takes into account (2) but compatKeysUnmapped doesn't. I think this is a bit confusing.

Maybe we want to expose something like this?

currentBurndown: toDoKeys.length
compatKeysUnmapped: toDoKeys.length + deprecatedNonStandardKeys.length

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this is a good idea. I've changed this a bit based on your comment:

  • compatKeys is what we have in the feature data
  • compatKeysUnmapped is toDoKeys.length + deprecatedNonStandardKeys.length
  • currentBurndownSize is the number of standard, non-deprecated keys left to map
  • currentBurndown is the array of standard, non-deprecated keys left to map

Copy link
Collaborator

@Elchi3 Elchi3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thank you Daniel! 👍

(Yay us for now being below 3000 keys left to map for standard, non-deprecated keys)

@Elchi3 Elchi3 merged commit 11a5c94 into web-platform-dx:main Nov 13, 2024
3 checks passed
@ddbeck ddbeck deleted the burndown-inline branch November 13, 2024 13:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tools and infrastructure Project internal tooling, such as linters, GitHub Actions, or repo settings
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants