Skip to content

Commit

Permalink
Add script to compile usage of experimental APIs (#51341)
Browse files Browse the repository at this point in the history
  • Loading branch information
mcsf committed Jun 10, 2023
1 parent d921d2a commit 7c3ea72
Showing 1 changed file with 65 additions and 0 deletions.
65 changes: 65 additions & 0 deletions bin/list-experimental-api-matches.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
#!/bin/sh

# Generate a Markdown-formatted list of experimental APIs found across our
# packages and lib, providing GitHub search links for each match.
#
# Experimental APIs must be regularly audited, particularly in the context of
# major WordPress releases. This script allows release leads to generate a list
# to share in release issues.
#
# @see example audit issue for WordPress 6.2:
# https://github.com/WordPress/gutenberg/issues/47196

# Exit if any command fails.
set -e

# Change to the root directory.
cd "$(dirname "$0")"
cd ..

# 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

1 comment on commit 7c3ea72

@github-actions
Copy link

Choose a reason for hiding this comment

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

Flaky tests detected in 7c3ea72.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5229857159
📝 Reported issues:

Please sign in to comment.