Add script to compile usage of experimental APIs #51341
Conversation
mcsf
added
the
Gutenberg Plugin
|
Flaky tests detected in c7a4ebb. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5229008186
|
There was a problem hiding this comment.
Thanks for putting this together! It's working as expected in testing: it outputs each instance only once, in the first package it was found in.
I like that it specifies file types to look in and excludes tests, so we don't end up with things like __experimentalFoo in the list 😄
It's also great to not have ripgrep as a dependency.
There doesn't seem to be an obvious place in the repo docs to document this. This handbook entry on the editor tech lead tasks would be good to update and add a reference to this script, not sure if there's anywhere else where it would make sense to mention it?
|
Thanks for the review!
Good idea. I can't think of any other place, so I'll edit it in there. :) |
Context: #47196
What?
Add a shell script that generates a Markdown-formatted list of experimental APIs found across our packages and
lib. Here, "experimental API" means any string match for__experimental.... For each such match, output a link to a GitHub search page for that match.Why?
Experimental APIs must be regularly audited, particularly in the context of major WordPress releases. Typically, release leads would run their own scripts as shared in comments in #47196. This PR offers one such implementation.
This came about in conversation with @ntsekouras, who had shared a Bash script that had become more difficult to maintain. /cc @tellthemachines
How?
I wrote an alternative in POSIX sh (well, with the exception of
git ls-files, it's as POSIX as I can tell) that should perform better and be readily understandable, since it works by transforming a single stream rather than dealing with loops and state.This script's output differs from that found in the description of the audit issue, mostly because it traverses matches in a different order. This matters because the scripts ascribe experimental APIs to the first package in which they were found. This is particularly noticeable when comparing the APIs listed under
lib.Testing Instructions
Run
./bin/list-experimental-api-matches.shand inspect the results. Note that the output differs from that produced by previous scripts.Generated output
List of experimental APIs
lib__experimentalBorder__experimentalDefault__experimentalDuotone__experimentalEnableColorRandomizer__experimentalEnableGroupGridVariation__experimentalEnableListBlockV2__experimentalEnablePatternEnhancements__experimentalEnableQuoteBlockV2__experimentalEnableZoomedOutView__experimentalFeatures__experimentalFontFamily__experimentalFontStyle__experimentalFontWeight__experimentalInteractivityAPI__experimentalLayout__experimentalLetterSpacing__experimentalSelector__experimentalSettings__experimentalStyle__experimentalStyles__experimentalTextDecoration__experimentalTextTransformpackages/annotations__experimentalAddAnnotation__experimentalCreateOnChangeEditableValue__experimentalCreatePrepareEditableTree__experimentalGetAllAnnotationsForBlock__experimentalGetAnnotations__experimentalGetAnnotationsForBlock__experimentalGetAnnotationsForRichText__experimentalGetPropsForEditableTreeChangeHandler__experimentalGetPropsForEditableTreePreparation__experimentalRemoveAnnotation__experimentalRemoveAnnotationsBySource__experimentalUpdateAnnotationRangepackages/block-directory__experimentalIsFocusablepackages/block-editor__experimentalAlignmentMatrixControl__experimentalAppenderTagName__experimentalBlockAlignmentMatrixControl__experimentalBlockDirectory__experimentalBlockFullHeightAligmentControl__experimentalBlockPatternCategories__experimentalBlockPatternSetup__experimentalBlockPatterns__experimentalBlockPatternsList__experimentalBlockVariationPicker__experimentalBlockVariationTransforms__experimentalBorderBoxControl__experimentalBorderRadiusControl__experimentalBoxControl__experimentalCanUserUseUnfilteredHTML__experimentalCaptureToolbars__experimentalCloneSanitizedBlock__experimentalColorGradientControl__experimentalColorGradientSettingsDropdown__experimentalConvertBlockToStatic__experimentalDateFormatPicker__experimentalDefaultBlock__experimentalDefaultControls__experimentalDirectInsert__experimentalDisableBlockOverlay__experimentalDragComponent__experimentalDropdownContentWrapper__experimentalDuotoneControl__experimentalExposeControlsToChildren__experimentalFetchLinkSuggestions__experimentalFetchReusableBlocks__experimentalFetchRichUrlData__experimentalFilterValue__experimentalFirstVisibleItemClass__experimentalFontAppearanceControl__experimentalFontFamilyControl__experimentalGetAccessibleBlockLabel__experimentalGetActiveBlockIdByBlockNames__experimentalGetAllowedBlocks__experimentalGetAllowedPatterns__experimentalGetBlockAttributesNamesByRole__experimentalGetBlockLabel__experimentalGetBlockListSettingsForBlocks__experimentalGetBorderClassesAndStyles__experimentalGetColorClassesAndStyles__experimentalGetDirectInsertBlock__experimentalGetElementClassName__experimentalGetGapCSSValue__experimentalGetGlobalBlocksByName__experimentalGetGradientClass__experimentalGetGradientObjectByGradientValue__experimentalGetLastBlockAttributeChanges__experimentalGetMatchingVariation__experimentalGetParsedPattern__experimentalGetPatternTransformItems__experimentalGetPatternsByBlockTypes__experimentalGetReusableBlockTitle__experimentalGetSpacingClassesAndStyles__experimentalGlobalStylesBaseStyles__experimentalGrid__experimentalGroup__experimentalHStack__experimentalHandleURLSuggestions__experimentalHasContentRoleAttribute__experimentalHasSplitBorders__experimentalHeading__experimentalHideChildBlockControls__experimentalHint__experimentalImageEditor__experimentalImageSizeControl__experimentalImageURLInputUI__experimentalInitialIndex__experimentalInitialPosition__experimentalInsertionIndex__experimentalInspectorPopoverHeader__experimentalIsDefinedBorder__experimentalIsQuick__experimentalIsRenderedInSidebar__experimentalItem__experimentalItemGroup__experimentalLabel__experimentalLastVisibleItemClass__experimentalLayoutStyle__experimentalLetterSpacingControl__experimentalLibrary__experimentalLinkControl__experimentalLinkControlSearchInput__experimentalLinkControlSearchItem__experimentalLinkControlSearchResults__experimentalListView__experimentalMetadata__experimentalMinHeight__experimentalNavigatorBackButton__experimentalNavigatorButton__experimentalNavigatorProvider__experimentalNavigatorScreen__experimentalNumberControl__experimentalOnIndexChange__experimentalOnlyMediaLibrary__experimentalPadding__experimentalPanelColorGradientSettings__experimentalParentSelector__experimentalParseQuantityAndUnitFromRawValue__experimentalPopoverLegacyPositionToPlacement__experimentalPreferPatternsOnRoot__experimentalPreferredStyleVariations__experimentalPreviewOptions__experimentalPublishDateTimePicker__experimentalRecursionProvider__experimentalRenderControl__experimentalRenderSuggestions__experimentalResponsiveBlockControl__experimentalReusableBlocks__experimentalRichText__experimentalRole__experimentalSelectBlock__experimentalSetIsInserterOpened__experimentalShareWithChildBlocks__experimentalShouldInsertAtTheTop__experimentalShowInitialSuggestions__experimentalShowSelectedHint__experimentalSkipSerialization__experimentalSlashInserter__experimentalSpacer__experimentalSpacingSizesControl__experimentalStyleProvider__experimentalText__experimentalTextDecorationControl__experimentalTextTransformControl__experimentalToggleGroupControl__experimentalToggleGroupControlOption__experimentalToggleGroupControlOptionIcon__experimentalToolbar__experimentalToolbarContext__experimentalToolsPanel__experimentalToolsPanelContext__experimentalToolsPanelItem__experimentalTransferDataType__experimentalTreeGrid__experimentalTreeGridCell__experimentalTreeGridItem__experimentalTreeGridRow__experimentalTruncate__experimentalUndo__experimentalUnitControl__experimentalUpdateSelection__experimentalUpdateSettings__experimentalUseBlockOverlayActive__experimentalUseBlockPreview__experimentalUseBorderProps__experimentalUseColorProps__experimentalUseCustomSides__experimentalUseCustomUnits__experimentalUseDropZone__experimentalUseFixedWindowList__experimentalUseGradient__experimentalUseHasRecursion__experimentalUseMultipleOriginColorsAndGradients__experimentalUseResizeCanvas__experimentalUseSlotFills__experimentalVStack__experimentalVersion__experimentalView__experimentalZStack__experimentaluseLayoutClasses__experimentaluseLayoutStylespackages/block-library__experimentalConvert__experimentalDiscussionSettings__experimentalGetCoreBlocks__experimentalGetDefaultTemplatePartAreas__experimentalInputControl__experimentalIsEditingReusableBlock__experimentalOnEnter__experimentalRegisterExperimentalCoreBlocks__experimentalShowHowTo__experimentalShowTooltip__experimentalTooltipPropspackages/blocks__experimentalGetUnprocessedBlockTypes__experimentalReapplyBlockTypeFilters__experimentalRegisterBlockType__experimentalSanitizeBlockAttributespackages/commands__experimentalHideHeaderpackages/components__experimentalApplyValueToSides__experimentalAutoSelectFirstMatch__experimentalBorderControl__experimentalConfirmDialog__experimentalDimensionControl__experimentalDivider__experimentalElevation__experimentalExpandOnFocus__experimentalInputControlPrefixWrapper__experimentalInputControlSuffixWrapper__experimentalInvalid__experimentalIsEmptyBorder__experimentalNavigation__experimentalNavigationBackButton__experimentalNavigationGroup__experimentalNavigationItem__experimentalNavigationMenu__experimentalNavigatorToParentButton__experimentalPaletteEdit__experimentalRadio__experimentalRadioGroup__experimentalRenderItem__experimentalScrollable__experimentalSurface__experimentalTheme__experimentalToggleGroupControlOptionBase__experimentalUseDialog__experimentalUseDragging__experimentalUseFocusOutside__experimentalUseNavigator__experimentalUseSlot__experimentalValidateInputpackages/compose__experimentalWidthProviderpackages/core-data__experimentalBatch__experimentalFetchUrlData__experimentalGetCurrentGlobalStylesId__experimentalGetCurrentThemeBaseGlobalStyles__experimentalGetCurrentThemeGlobalStylesVariations__experimentalGetDirtyEntityRecords__experimentalGetEntitiesBeingSaved__experimentalGetEntityRecordNoResolver__experimentalGetTemplateForLink__experimentalNoFetch__experimentalReceiveCurrentGlobalStylesId__experimentalReceiveThemeBaseGlobalStyles__experimentalReceiveThemeGlobalStyleVariations__experimentalSaveSpecifiedEntityEdits__experimentalUseEntityRecord__experimentalUseEntityRecords__experimentalUseResourcePermissionspackages/customize-widgets__experimentalGetInsertionPointpackages/date__experimentalGetSettingspackages/dependency-extraction-webpack-plugin__experimentalInjectInteractivityRuntimepackages/e2e-test-utils__experimentalActivatePlugin__experimentalDeactivatePlugin__experimentalRestpackages/edit-post__experimentalFullscreenModeClose__experimentalGetPreviewDeviceType__experimentalMainDashboardButton__experimentalSetPreviewDeviceTypepackages/edit-site__experimentalAdditionalBlockPatternCategories__experimentalAdditionalBlockPatterns__experimentalDashboardLink__experimentalGetDefaultTemplateTypes__experimentalGetTemplateInfopackages/editor__experimentalCreatePageEntity__experimentalGetDefaultTemplateType__experimentalTearDownEditor__experimentalUserCanCreatePagespackages/reusable-blocks__experimentalConvertBlocksToReusable__experimentalDeleteReusableBlock__experimentalSetEditingReusableBlock