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

Add script to compile usage of experimental APIs #51341

Merged
merged 3 commits into from
Jun 10, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
48 changes: 48 additions & 0 deletions bin/list-experimental-api-matches.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
#!/bin/sh

# POSIX: prefer standard grep over rg. Git is assumed present (ls-files), but
# could be replaced with find.
grep_experimental_apis() {
git ls-files packages/* lib \
| grep -E '\.(js|ts|jsx|tsx|php)$' \
| grep -v __tests__ \
| xargs grep -Eo '__experimental\w+'
}

# For each line as `<filepath>:<match>`, rewrite as `<package> <match>`.
namespace() {
awk -F: '
{ print module($1), $2 }
function module(path) {
n = split(path, parts, "/")
if (parts[1] == "lib") return "lib"
return parts[1] "/" parts[2]
}'
}

# Like uniq, but applied across packages: if `__experimentalFoo` appears in
# packages A and B, only keep the occurrence under A.
compact() {
sort | uniq | awk '{
if (known_api[$2]) next
known_api[$2] = 1
print
}'
}

# Output a heading for each package and a link for each experimental API.
format() {
awk '{
if (prev_dir != $1) {
if (NR > 1) print ""
printf "## `%s`\n", $1
prev_dir = $1
}
printf "[`%s`](/WordPress/gutenberg/search?q=%s)\n", $2, $2
}'
}

grep_experimental_apis \
| namespace \
| compact \
| format