Add experimental support to build using Bikeshed

The new --bikeshed flag enables Bikeshed mode. The wattsi2bikeshed.js
script converts the source from Wattsi to Bikeshed syntax.

The hardest part of this is ensuring that cross-references still resolve
to the same thing. Wattsi's <span> and <i> for autolinks are converted
to <a>, but changes to HTML itself will likely be needed for some cases
where the data-x="" (with hyphens) is unambiguous but where Bikeshed's
linking text (with spaces) is ambiguous and would require a for=""
attribute.

What doesn't work:

  - Some cross-references as per above.
  - Some manual changes to HTML are still needed:
    https://github.com/whatwg/html/tree/bikeshed-experiment
  - Existing IDs aren't always preserved.
  - Simplification of HTML into Bikeshed shorthands like {{Node}}.
  - subdfn, which has no equivalent in Bikeshed.
  - Variants like the dev edition aren't properly supported.

Author: foolip

.gitignore

@@ -4,6 +4,7 @@ html/
 output/
 mdn/.id-list
 mdn/developer.mozilla.org/
+node_modules/
 highlighter/
 
 

build.sh

@@ -15,6 +15,7 @@ declare -r WATTSI_LATEST=140
 # Shared state variables throughout this script
 LOCAL_WATTSI=true
 WATTSI_RESULT=0
+USE_BIKESHED=false
 DO_UPDATE=true
 DO_LINT=true
 DO_HIGHLIGHT=true
@@ -85,14 +86,16 @@ function main {
     exit 0
   fi
 
-  checkWattsi
-  ensureHighlighterInstalled
+  if [[ $USE_BIKESHED != "true" ]]; then
+    checkWattsi
+    ensureHighlighterInstalled
 
-  doLint
+    doLint
 
-  updateRemoteDataFiles
+    updateRemoteDataFiles
 
-  startHighlightServer
+    startHighlightServer
+  fi
 
   processSource "source" "default"
 
@@ -146,6 +149,7 @@ function processCommandLineArgs {
         echo "  $0 help   Show this usage statement."
         echo
         echo "Build options:"
+        echo "  -b|--bikeshed     Use Bikeshed instead of Wattsi. (experimental)"
         echo "  -d|--docker       Use Docker to build in a container."
         echo "  -r|--remote       Use the build server."
         echo "  -s|--serve        After building, serve the results on http://localhost:$SERVE_PORT."
@@ -176,6 +180,10 @@ function processCommandLineArgs {
         DO_HIGHLIGHT=false
         SINGLE_PAGE_ONLY=true
         ;;
+      -b|--bikeshed)
+        USE_BIKESHED=true
+        SINGLE_PAGE_ONLY=true
+        ;;
       -d|--docker)
         USE_DOCKER=true
         ;;
@@ -656,34 +664,48 @@ function processSource {
   cp -p  entities/out/entities-dtd.url "$HTML_CACHE"
   runRustTools <"$HTML_SOURCE/$source_location" >"$HTML_TEMP/source-whatwg-complete"
 
-  runWattsi "$HTML_TEMP/source-whatwg-complete" "$HTML_TEMP/wattsi-output"
-  if [[ $WATTSI_RESULT == "0" ]]; then
-    if [[ $LOCAL_WATTSI != "true" ]]; then
-      "$QUIET" || grep -v '^$' "$HTML_TEMP/wattsi-output.txt" # trim blank lines
-    fi
+  if [[ $USE_BIKESHED == "true" ]]; then
+    clearDir "$HTML_TEMP/bikeshed-output"
+
+    node wattsi2bikeshed.js "$HTML_TEMP/source-whatwg-complete" "$HTML_TEMP/source-whatwg-complete.bs"
+
+    local bikeshed_args=( --force )
+    $DO_UPDATE || bikeshed_args+=( --no-update )
+    bikeshed "${bikeshed_args[@]}" spec "$HTML_TEMP/source-whatwg-complete.bs" "$HTML_TEMP/bikeshed-output/index.html" --md-Text-Macro="SHA $HTML_SHA" --md-Text-Macro="COMMIT-SHA $HTML_SHA"
   else
-    if [[ $LOCAL_WATTSI != "true" ]]; then
-      "$QUIET" || grep -v '^$' "$HTML_TEMP/wattsi-output.txt" # trim blank lines
-    fi
-    if [[ $WATTSI_RESULT == "65" ]]; then
-      echo
-      echo "There were errors. Running again to show the original line numbers."
-      echo
-      runWattsi "$HTML_SOURCE/$source_location" "$HTML_TEMP/wattsi-raw-source-output"
+    runWattsi "$HTML_TEMP/source-whatwg-complete" "$HTML_TEMP/wattsi-output"
+    if [[ $WATTSI_RESULT == "0" ]]; then
+      if [[ $LOCAL_WATTSI != "true" ]]; then
+        "$QUIET" || grep -v '^$' "$HTML_TEMP/wattsi-output.txt" # trim blank lines
+      fi
+    else
       if [[ $LOCAL_WATTSI != "true" ]]; then
-        grep -v '^$' "$HTML_TEMP/wattsi-output.txt" # trim blank lines
+        "$QUIET" || grep -v '^$' "$HTML_TEMP/wattsi-output.txt" # trim blank lines
+      fi
+      if [[ $WATTSI_RESULT == "65" ]]; then
+        echo
+        echo "There were errors. Running again to show the original line numbers."
+        echo
+        runWattsi "$HTML_SOURCE/$source_location" "$HTML_TEMP/wattsi-raw-source-output"
+        if [[ $LOCAL_WATTSI != "true" ]]; then
+          grep -v '^$' "$HTML_TEMP/wattsi-output.txt" # trim blank lines
+        fi
       fi
+      echo
+      echo "There were errors. Stopping."
+      exit "$WATTSI_RESULT"
     fi
-    echo
-    echo "There were errors. Stopping."
-    exit "$WATTSI_RESULT"
   fi
 
   # Keep the list of files copied from $HTML_SOURCE in sync with `doServerBuild`
 
   if [[ $build_type == "default" ]]; then
     # Singlepage HTML
-    runRustTools --singlepage-post <"$HTML_TEMP/wattsi-output/index-html" >"$HTML_OUTPUT/index.html"
+    if [[ $USE_BIKESHED == "true" ]]; then
+      mv "$HTML_TEMP/bikeshed-output/index.html" "$HTML_OUTPUT/index.html"
+    else
+      runRustTools --singlepage-post <"$HTML_TEMP/wattsi-output/index-html" >"$HTML_OUTPUT/index.html"
+    fi
 
     if [[ $SINGLE_PAGE_ONLY == "false" ]]; then
       # Singlepage Commit Snapshot
@@ -699,7 +721,9 @@ function processSource {
     fi
 
     cp -p  entities/out/entities.json "$HTML_OUTPUT"
-    cp -p "$HTML_TEMP/wattsi-output/xrefs.json" "$HTML_OUTPUT"
+    if [[ $USE_BIKESHED == "false" ]]; then
+      cp -p "$HTML_TEMP/wattsi-output/xrefs.json" "$HTML_OUTPUT"
+    fi
 
     clearDir "$HTML_TEMP"