Rename APIs

Author: stevapple

.github/workflows/CI.yaml

@@ -23,8 +23,8 @@ jobs:
     - name: Test swiftbox install
       run: ./swiftbox.sh install
 
-    - name: Test swiftbox lookup
-      run: swiftbox lookup $MAINVER
+    - name: Test swiftbox check
+      run: swiftbox check $MAINVER
 
     - name: Test swiftbox get with sudo
       run: |
@@ -61,10 +61,10 @@ jobs:
         fi
         swiftc -v
 
-    - name: Test swiftbox clean
+    - name: Test swiftbox cleanup
       run: |
-        swiftbox clean
-        sudo swiftbox clean
+        swiftbox cleanup
+        sudo swiftbox cleanup
 
     - name: Test swiftbox remove
       run: |
@@ -131,8 +131,8 @@ jobs:
     - name: Test swiftbox install
       run: ./swiftbox.sh install
 
-    - name: Test swiftbox lookup
-      run: swiftbox lookup $MAINVER
+    - name: Test swiftbox check
+      run: swiftbox check $MAINVER
 
     - name: Install which
       run: sudo yum install which -y
@@ -162,10 +162,10 @@ jobs:
         swiftbox list
         sudo swiftbox list
 
-    - name: Test swiftbox clean
+    - name: Test swiftbox cleanup
       run: |
-        swiftbox clean
-        sudo swiftbox clean
+        swiftbox cleanup
+        sudo swiftbox cleanup
 
     - name: Test swiftbox remove
       run: sudo swiftbox remove $MAINVER
@@ -233,8 +233,8 @@ jobs:
     - name: Test swiftbox install
       run: ./swiftbox.sh install
 
-    - name: Test swiftbox lookup
-      run: swiftbox lookup $MAINVER
+    - name: Test swiftbox check
+      run: swiftbox check $MAINVER
 
     - name: Install which
       run: sudo yum install which -y
@@ -264,10 +264,10 @@ jobs:
         swiftbox list
         sudo swiftbox list
 
-    - name: Test swiftbox clean
+    - name: Test swiftbox cleanup
       run: |
-        swiftbox clean
-        sudo swiftbox clean
+        swiftbox cleanup
+        sudo swiftbox cleanup
 
     - name: Test swiftbox remove
       run: sudo swiftbox remove $MAINVER
@@ -312,8 +312,8 @@ jobs:
         chmod +x swiftbox.sh
         ./swiftbox.sh -v
 
-    - name: Test swiftbox lookup nightly
-      run: ./swiftbox.sh lookup nightly
+    - name: Test swiftbox check nightly
+      run: ./swiftbox.sh check nightly
 
     - name: Test swiftbox get nightly
       env:
@@ -349,8 +349,8 @@ jobs:
         chmod +x swiftbox.sh
         ./swiftbox.sh -v
 
-    - name: Test swiftbox lookup nightly
-      run: ./swiftbox.sh lookup nightly
+    - name: Test swiftbox check nightly
+      run: ./swiftbox.sh check nightly
 
     - name: Test swiftbox get nightly
       run: ./swiftbox.sh get nightly
@@ -389,8 +389,8 @@ jobs:
         chmod +x swiftbox.sh
         ./swiftbox.sh -v
 
-    - name: Test swiftbox lookup nightly
-      run: ./swiftbox.sh lookup nightly
+    - name: Test swiftbox check nightly
+      run: ./swiftbox.sh check nightly
 
     - name: Test swiftbox get nightly
       run: ./swiftbox.sh get nightly

.github/workflows/Tag.yaml

@@ -56,11 +56,11 @@ jobs:
         apt-get update
         apt-get install sudo curl -y
 
-    - name: Test swiftbox install and update
+    - name: Test swiftbox install and upgrade
       run: |
         sh -c "$(curl -fsSL https://raw.githubusercontent.com/stevapple/swiftbox/master/install.sh)"
         swiftbox -v
-        sudo swiftbox update
+        sudo swiftbox upgrade
 
     - name: Test swiftbox setup
       env:
@@ -79,11 +79,11 @@ jobs:
     - name: Install sudo
       run: yum install sudo -y
 
-    - name: Test swiftbox install and update
+    - name: Test swiftbox install and upgrade
       run: |
         sh -c "$(curl -fsSL https://raw.githubusercontent.com/stevapple/swiftbox/master/install.sh)"
         swiftbox -v
-        sudo swiftbox update
+        sudo swiftbox upgrade
 
     - name: Test swiftbox setup
       run: |
@@ -99,11 +99,11 @@ jobs:
     - name: Install sudo
       run: yum install sudo -y
 
-    - name: Test swiftbox install and update
+    - name: Test swiftbox install and upgrade
       run: |
         sh -c "$(curl -fsSL https://raw.githubusercontent.com/stevapple/swiftbox/master/install.sh)"
         swiftbox -v
-        sudo swiftbox update
+        sudo swiftbox upgrade
 
     - name: Test swiftbox setup
       run: |

README.md

@@ -21,7 +21,7 @@ chmod +x install.sh
 ./install.sh
 ```
 
-Or if you'd like to use it as a script (doesn't support `update` yet):
+Or if you'd like to use it as a script (doesn't support `upgrade` yet):
 
 ```bash
 # With wget
@@ -77,23 +77,23 @@ You may notice a `[user]` or `[global]` prefix in the output, which indicates th
 
 ```console
 $ swiftbox -v
-0.9
+0.11
 ```
 
 ### Check the availability of Swift versions
 
 ```console
-$ swiftbox lookup 5.2.4
+$ swiftbox check 5.2.4
 [global] Swift 5.2.4 is kept locally and set to default.
-$ swiftbox lookup 5.1
+$ swiftbox check 5.1
 Swift 5.1 is available for Ubuntu 18.04, you can get it with: swiftbox get 5.1
-$ swiftbox lookup nightly
+$ swiftbox check nightly
 Swift nightly build 2020-05-11-a is available for Amazon Linux 2, you can get it with: swiftbox get nightly
-$ swiftbox lookup 2.1
+$ swiftbox check 2.1
 Swift 2.1 does not exist or does not support your CentOS Linux version.
 ```
 
-### Manage Swift versions
+### Manage Swift toolchains
 
 Both release builds and the latest nightly build are available.
 
@@ -103,7 +103,7 @@ $ swiftbox get nightly
 $ swiftbox remove 5.0
 ```
 
-### Switch to a Swift version
+### Select a Swift version
 
 ```console
 $ swiftbox use 5.2.2
@@ -117,7 +117,7 @@ $ sudo swiftbox close
 [global] Swift 5.2.2 is now disabled.
 ```
 
-### Lookup installed Swift versions
+### List local toolchain versions
 
 The active one is marked with `*`.
 
@@ -131,15 +131,15 @@ $ swiftbox list
 ### Clear download cache
 
 ```console
-$ swiftbox clean
+$ swiftbox cleanup
 [user] Successfully cleaned the cache.
 ```
 
-### Update `swiftbox`
+### Upgrade `swiftbox`
 
-Update to the latest version if `swiftbox` is installed in `/usr/bin`.
+Upgrade to the latest version if `swiftbox` is installed in `/usr/bin`.
 
 ```console
-$ swiftbox update
-Successfully upgraded swiftbox from 0.9 to 0.10.6
+$ swiftbox upgrade
+Successfully upgraded swiftbox from 0.9 to 0.11
 ```

swiftbox.sh

@@ -2,7 +2,7 @@
 
 ## Set environment properties
 
-SWIFTBOX_VERSION="0.10.8"
+SWIFTBOX_VERSION="0.11"
 
 if [ `id -u` = 0 ]
 then
@@ -227,7 +227,7 @@ nightly-version() {
 
 ## Install Swift toolchains
 
-get-release() {
+fetch-release() {
     cd $WORKING_DIR
     FILE_NAME="swift-$NEW_VERSION-RELEASE-$SYSTEM_NAME$SYSTEM_VERSION"
     DOWNLOAD_URL="https://swift.org/builds/swift-$NEW_VERSION-release/$SYSTEM_NAME${SYSTEM_VERSION//./}/swift-$NEW_VERSION-RELEASE/$FILE_NAME.tar.gz"
@@ -240,7 +240,7 @@ get-release() {
     install-toolchain
 }
 
-get-snapshot() {
+fetch-snapshot() {
     cd $WORKING_DIR
     FILE_NAME="swift-DEVELOPMENT-SNAPSHOT-$NEW_VERSION-$SYSTEM_NAME$SYSTEM_VERSION"
     DOWNLOAD_URL="https://swift.org/builds/development/$SYSTEM_NAME${SYSTEM_VERSION//./}/swift-DEVELOPMENT-SNAPSHOT-$NEW_VERSION/$FILE_NAME.tar.gz"
@@ -272,7 +272,7 @@ install-toolchain() {
     if [ $? != 0 ]
     then
         echo "Signature check failed, please try again."
-        echo "If it always fails, clear the cache with: $0 clean"
+        echo "If it always fails, clear the cache with: $0 cleanup"
         exit 100
     fi
     tar -xzf download/$FILE_NAME.tar.gz -C temp
@@ -299,15 +299,15 @@ default-version() {
     fi
 }
 
-use-version() {
+select-version() {
     is-kept $1
     if [ $? = 0 ]
     then
         echo $1 > $WORKING_DIR/.swift-version
         ensure-env
         echo "$SCHEME Now using Swift $1"
     else
-        echo "$SCHEME Swift $1 has not been installed yet."
+        echo "$SCHEME Swift $1 has not been kept, you can get it with: $0 get $1"
         return 20
     fi
 }
@@ -346,7 +346,7 @@ then
 fi
 
 case $1 in
-lookup)
+check)
     if [ E$2 = E`default-version` ]
     then
         echo "$SCHEME Swift $2 is kept locally and set to default."
@@ -406,17 +406,17 @@ get)
         echo "$SCHEME Swift $NEW_VERSION is kept locally, you can enable it with: $0 use $NEW_VERSION"
         exit 33
     else
-        get-$TOOLCHAIN_TYPE $NEW_VERSION
-        GET_RESULT=$?
-        if [ $GET_RESULT != 0 ]
+        fetch-$TOOLCHAIN_TYPE $NEW_VERSION
+        FETCH_RESULT=$?
+        if [ $FETCH_RESULT != 0 ]
         then
-            exit $GET_RESULT
+            exit $FETCH_RESULT
         fi
         echo "$SCHEME Swift $NEW_VERSION is ready for use!"
         if [ ! -f .swift-version ]
         then
             echo "$SCHEME Automatically set Swift $NEW_VERSION as default."
-            use-version $NEW_VERSION
+            select-version $NEW_VERSION
         fi
     fi
 ;;
@@ -436,7 +436,7 @@ list)
     done
 ;;
 use)
-    use-version $2
+    select-version $2
     exit $?
 ;;
 remove)
@@ -448,16 +448,16 @@ close)
     disable-swift
     exit $?
 ;;
-clean)
+cleanup)
     ensure-env
     rm -rf $WORKING_DIR/temp/*
     rm -rf $WORKING_DIR/download/*
     echo "$SCHEME Successfully cleaned the cache."
 ;;
-update)
+upgrade)
     if [ $(realpath `dirname $0`) != $INSTALL_DIR ]
     then
-        echo "swiftbox is not installed to system, update is unavailable."
+        echo "swiftbox is not installed to system, upgrade is unavailable."
         echo "You can install it with: $0 install"
         exit 254
     fi