chore(common): address review comments

keymanapp · Oct 9, 2024 · 016a6f0 · 016a6f0
1 parent cccf3d5
commit 016a6f0
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 15 deletions.
diff --git a/android/build.sh b/android/build.sh
@@ -14,11 +14,11 @@ THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
 
 builder_describe \
   "Build Keyman Engine for Android, Keyman for Android, and FirstVoices Android app." \
+  "@/resources/tools/check-markdown  test:help" \
   clean \
   configure \
   build \
   test \
-  "@/resources/tools/check-markdown  test:help" \
   "publish                                  Publishes symbols to Sentry and the APKs to the Play Store." \
   --ci+ \
   --upload-sentry+ \

diff --git a/developer/src/build.sh b/developer/src/build.sh
@@ -11,11 +11,11 @@ THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
 
 builder_describe \
   "Keyman Developer" \
+  "@/resources/tools/check-markdown  test:help" \
   clean \
   configure \
   build \
   test \
-  "@/resources/tools/check-markdown  test:help" \
   "api                          Analyze API and prepare API documentation" \
   "publish                      Prepare files for distribution, publish symbols, publish or pack npm packages, and build installer" \
   "install                      Install built programs locally" \

diff --git a/ios/build.sh b/ios/build.sh
@@ -1,23 +1,18 @@
 #!/usr/bin/env bash
-
 ## START STANDARD BUILD SCRIPT INCLUDE
 # adjust relative paths as necessary
 THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
 . "${THIS_SCRIPT%/*}/../resources/build/builder.inc.sh"
 ## END STANDARD BUILD SCRIPT INCLUDE
 
-# Include our resource functions; they're pretty useful!
 . "$KEYMAN_ROOT/resources/shellHelperFunctions.sh"
 
-# Please note that this build script (understandably) assumes that it is running on Mac OS X.
-# verify_on_mac
-
 builder_describe "Builds Keyman Engine and the Keyman app for use on iOS devices - iPhone and iPad." \
+  "@/resources/tools/check-markdown  test:help" \
   "clean" \
   "configure" \
   "build" \
   "test" \
-  "@/resources/tools/check-markdown  test:help" \
   ":engine                      Builds KeymanEngine.xcframework, usable by our main app and by third-party apps" \
   ":app=keyman                  Builds the Keyman app for iOS platforms" \
   ":help                        Online documentation" \

diff --git a/mac/build.sh b/mac/build.sh
@@ -5,7 +5,6 @@ THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
 . "${THIS_SCRIPT%/*}/../resources/build/builder.inc.sh"
 ## END STANDARD BUILD SCRIPT INCLUDE
 
-# Include our resource functions; they're pretty useful!
 . "$KEYMAN_ROOT/resources/shellHelperFunctions.sh"
 . "$KEYMAN_ROOT/resources/build/build-help.inc.sh"
 . "$KEYMAN_ROOT/mac/mac-utils.inc.sh"
@@ -25,9 +24,6 @@ builder_describe "Builds Keyman for macOS." \
   ":testapp    Keyman4Mac (test harness)" \
   "--quick,-q  Bypasses notarization for $(builder_term install)"
 
-# Please note that this build script (understandably) assumes that it is running on Mac OS X.
-# verify_on_mac
-
 builder_parse "$@"
 
 # Default is release build of Engine and (code-signed) Input Method

diff --git a/resources/tools/check-markdown/src/index.ts b/resources/tools/check-markdown/src/index.ts
@@ -25,15 +25,15 @@ function run() {
 
   const files = findFiles(root);
   const links = parseFiles(root, files);
-  const result = checkLinks(root, links);
+  const checkLinksSucceeded = checkLinks(root, links);
 
   for(const file of links) {
     if(file.messages.length) {
-      reportMessages(root, result && verbose /* only give verbose output if no errors */, file);
+      reportMessages(root, checkLinksSucceeded && verbose /* only give verbose output if no errors */, file);
     }
   }
 
-  process.exit(result ? 0 : 1);
+  process.exit(checkLinksSucceeded ? 0 : 1);
 }{
 
 }