|
| 1 | +#!/bin/bash |
| 2 | + |
| 3 | +API_VERSION=$1 |
| 4 | +DOCS_PATH=docs/surfaces/admin |
| 5 | +SRC_PATH=src/surfaces/admin |
| 6 | +COMPONENTS_DEFINITIONS=src/surfaces/admin/components.d.ts |
| 7 | +COMPONENTS_TS=src/surfaces/admin/components.ts |
| 8 | +SHOPIFY_DEV_PATH="../../../shopify-dev" |
| 9 | +DOT_DEV_DOCS_JSON="$SHOPIFY_DEV_PATH/db/data/docs/templated_apis/app_bridge/generated_docs_data.json" |
| 10 | +GENERATED_DOCS_JSON="./$DOCS_PATH/generated/generated_docs_data.json" |
| 11 | + |
| 12 | +fail_and_exit() { |
| 13 | + echo "** Failed to generate docs" |
| 14 | + echo "See https://vault.shopify.io/page/Extension-Docs~SkgE.md" |
| 15 | + exit $1 |
| 16 | +} |
| 17 | + |
| 18 | +run_sed() { |
| 19 | + if [[ "$OSTYPE" == "darwin"* ]]; then |
| 20 | + # macOS |
| 21 | + sed -i '' "$1" "$2" |
| 22 | + else |
| 23 | + # Linux and other Unix-like systems |
| 24 | + sed -i "$1" "$2" |
| 25 | + fi |
| 26 | +} |
| 27 | + |
| 28 | +if [ -z $API_VERSION ] |
| 29 | +then |
| 30 | + API_VERSION="unstable" |
| 31 | + echo "Building docs for 'unstable' admin UI extensions API. You can add a calver version argument (e.g. 'yarn docs:admin 2023-07') to generate the docs for a stable version." |
| 32 | +else |
| 33 | + echo "Building docs for '$API_VERSION' admin UI extensions API." |
| 34 | + echo "When generating docs for a stable version, 'unstable' docs are not regenerated. This avoids overwriting other unstable changes that are not included in this version." |
| 35 | + echo "If you need to update the 'unstable' version, run this command again without the '$API_VERSION' parameter." |
| 36 | +fi |
| 37 | + |
| 38 | +# Read tsconfig.ab.docs.json and extract include/exclude patterns |
| 39 | +# Find all .doc.ts files in SRC_PATH |
| 40 | +FIND_CMD="find ./$SRC_PATH -name '*.doc.ts'" |
| 41 | + |
| 42 | +# Store original files for restoration |
| 43 | +declare -a MODIFIED_FILES |
| 44 | + |
| 45 | +echo "Replacing JSX/tsx references..." |
| 46 | +while IFS= read -r file; do |
| 47 | + if grep -q "JSX\|\.tsx" "$file"; then |
| 48 | + cp "$file" "$file.bak" |
| 49 | + MODIFIED_FILES+=("$file") |
| 50 | + run_sed 's/JSX/HTML/g' "$file" |
| 51 | + run_sed 's/\.tsx/\.html/g' "$file" |
| 52 | + fi |
| 53 | +done < <(eval "$FIND_CMD") |
| 54 | + |
| 55 | + |
| 56 | +COMPILE_DOCS="yarn tsc --project $DOCS_PATH/tsconfig.ab.docs.json --moduleResolution node --target esNext --module CommonJS && yarn generate-docs --overridePath ./$DOCS_PATH/typeOverride.json --input ./$DOCS_PATH/reference ./$SRC_PATH --typesInput ./$SRC_PATH --output ./$DOCS_PATH/generated" |
| 57 | +# COMPILE_STATIC_PAGES="yarn tsc $DOCS_PATH/staticPages/*.doc.ts --moduleResolution node --target esNext --module CommonJS && yarn generate-docs --isLandingPage --input ./$DOCS_PATH/staticPages --output ./$DOCS_PATH/generated" |
| 58 | + |
| 59 | +# Rename components.d.ts to components.ts so it can be picked up be the compiler |
| 60 | +cp $COMPONENTS_DEFINITIONS $COMPONENTS_TS |
| 61 | +# Remove references to HTMLElement |
| 62 | +run_sed "s/typeof globalThis.HTMLElement/any/" $COMPONENTS_TS |
| 63 | + |
| 64 | +eval $COMPILE_DOCS |
| 65 | +build_exit=$? |
| 66 | + |
| 67 | +# Restore original files |
| 68 | +for file in "${MODIFIED_FILES[@]}"; do |
| 69 | + if [ -f "$file.bak" ]; then |
| 70 | + mv "$file.bak" "$file" |
| 71 | + fi |
| 72 | +done |
| 73 | + |
| 74 | +# Remove .doc.js files |
| 75 | +find ./ -name '*.doc*.js' -exec rm -r {} \; |
| 76 | +# Remove components.ts as it's no longer needed |
| 77 | +rm $COMPONENTS_TS |
| 78 | + |
| 79 | +if [ $build_exit -ne 0 ]; then |
| 80 | + fail_and_exit $build_exit |
| 81 | +fi |
| 82 | + |
| 83 | +# Make sure https://shopify.dev URLs are relative so they work in Spin. |
| 84 | +# See https://github.com/Shopify/generate-docs/issues/181 |
| 85 | +run_sed 's/https:\/\/shopify.dev//gi' ./$DOCS_PATH/generated/generated_docs_data.json |
| 86 | + |
| 87 | + |
| 88 | +sed_exit=$? |
| 89 | +if [ $sed_exit -ne 0 ]; then |
| 90 | + fail_and_exit $sed_exit |
| 91 | +fi |
| 92 | + |
| 93 | +if [ -d $SHOPIFY_DEV_PATH ]; then |
| 94 | + mkdir -p $SHOPIFY_DEV_PATH/db/data/docs/templated_apis/app_bridge |
| 95 | + |
| 96 | + jq 'map(select(.category != "Experimental Components"))' $DOT_DEV_DOCS_JSON > temp1.json |
| 97 | + |
| 98 | + jq 'map(.category = "Experimental Components")' $GENERATED_DOCS_JSON > temp2.json |
| 99 | + |
| 100 | + jq -s '.[0] + .[1]' temp1.json temp2.json > $DOT_DEV_DOCS_JSON |
| 101 | + |
| 102 | + rm temp1.json temp2.json |
| 103 | + |
| 104 | + rsync -a --delete ./$DOCS_PATH/screenshots/ $SHOPIFY_DEV_PATH/app/assets/images/templated-apis-screenshots/admin-extensions/$API_VERSION |
| 105 | + |
| 106 | + if [ -n "$SPIN_SHOPIFY_DEV_SERVICE_FQDN" ]; then |
| 107 | + echo "Docs: https://$SPIN_SHOPIFY_DEV_SERVICE_FQDN/docs/api/admin-extensions" |
| 108 | + else |
| 109 | + echo "Docs: https://shopify-dev.myshopify.io/docs/api/admin-extensions" |
| 110 | + fi |
| 111 | +else |
| 112 | + echo "Not copying docs to shopify-dev because it was not found at $SHOPIFY_DEV_PATH." |
| 113 | +fi |
0 commit comments