🚧 working on new install script

Author: jcaillon

.github/workflows/self-test-installation.yaml

@@ -4,16 +4,16 @@ name: Self test install / extend
 on:
   # Triggers the workflow on push or pull request events but only for the "main" branch
   push:
-    branches: [ "main" ]
+    branches: ["main"]
     paths:
-      - 'tests.d/self-install/**'
-      - 'commands.d/self-install.sh'
-      - 'commands.d/self-extend.sh'
+      - "tests.d/self-install/**"
+      - "commands.d/self-install.sh"
+      - "commands.d/self-extend.sh"
   pull_request:
     paths:
-      - 'tests.d/self-install/**'
-      - 'commands.d/self-install.sh'
-      - 'commands.d/self-extend.sh'
+      - "tests.d/self-install/**"
+      - "commands.d/self-install.sh"
+      - "commands.d/self-extend.sh"
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -50,4 +50,4 @@ jobs:
             -e RUNNING_IN_DOCKER=true \
             -e BRANCH_NAME=${BRANCH_NAME} \
             noyacode/minideb-bash5.0 \
-            ./tests.d/self-install/test self test -C
+            ./tests.d/self-install/test self test -c

.github/workflows/self-test.yaml

@@ -4,12 +4,12 @@ name: Self test
 on:
   # Triggers the workflow on push or pull request events but only for the "main" branch
   push:
-    branches: [ "main" ]
+    branches: ["main"]
     paths-ignore:
-      - 'docs/**'
+      - "docs/**"
   pull_request:
     paths-ignore:
-      - 'docs/**'
+      - "docs/**"
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -39,7 +39,7 @@ jobs:
         run: |
           bash --version
           chmod +x valet
-          ./valet self test -C
+          ./valet self test -c
 
       # Runs tests with bash 5
       - name: Run valet self test on bash5
@@ -49,4 +49,4 @@ jobs:
             -v $PWD:/app \
             -w /app \
             noyacode/minideb-bash5.0 \
-            bash --version; VALET_CONFIG_ENABLE_COLORS=true VALET_CONFIG_DISABLE_PROGRESS=true ./valet self test -C
+            bash --version; VALET_CONFIG_ENABLE_COLORS=true VALET_CONFIG_DISABLE_PROGRESS=true ./valet self test -c

commands.d/bash-bootstrap.sh

@@ -139,11 +139,11 @@ description: |-
 
   ## 6. Incoming features
 
-  # TODO: FEATURES TO IMPLEMENT:
-  #
-  # - add builtin "z" to jump to frequently used directories
-  # - auto source .env and .envrc files in the current directory
-  # - Provide a good and fast default prompt if atuin is not installed
+  TODO: FEATURES TO IMPLEMENT:
+
+  - add builtin "z" to jump to frequently used directories
+  - auto source .env and .envrc files in the current directory
+  - Provide a good and fast default prompt if atuin is not installed
 
 options:
 - name: --bash-scripts-directory <directory>

commands.d/self-add-command.sh

@@ -33,7 +33,8 @@ examples:
 COMMAND_YAML
 function selfAddCommand() {
   local commandName
-  command::parseArguments "$@"; eval "${REPLY}"
+  command::parseArguments "$@"
+  eval "${REPLY}"
   command::checkParsedResults
 
   local templateFlavor="default"
@@ -47,7 +48,7 @@ function selfAddCommand() {
   # check if we are working for an extension
   core::getExtensionsDirectory
   if [[ ${PWD} != "${REPLY}"* && ! -d "commands.d" ]]; then
-    log::warning "The current directory is not under the valet user directory ⌜${REPLY}⌝."
+    log::warning "The current directory is not under the valet extensions directory ⌜${REPLY}⌝."
     if ! interactive::confirm "It does not look like the current directory ⌜${PWD}⌝ is a valet extension, do you want to proceed anyway?"; then
       log::info "Aborting the creation of the command."
       log::info "You should first create an extension with ⌜valet self extend⌝ and then cd into the created directory."

commands.d/self-add-library.sh

@@ -33,7 +33,8 @@ examples:
 COMMAND_YAML
 function selfAddLibrary() {
   local libraryName
-  command::parseArguments "$@"; eval "${REPLY}"
+  command::parseArguments "$@"
+  eval "${REPLY}"
   command::checkParsedResults
 
   local templateFlavor="default"
@@ -47,7 +48,7 @@ function selfAddLibrary() {
   # check if we are working for an extension
   core::getExtensionsDirectory
   if [[ ${PWD} != "${REPLY}"* && ! -d "libraries.d" ]]; then
-    log::warning "The current directory is not under the valet user directory ⌜${REPLY}⌝."
+    log::warning "The current directory is not under the valet extensions directory ⌜${REPLY}⌝."
     if ! interactive::confirm "It does not look like the current directory ⌜${PWD}⌝ is a valet extension, do you want to proceed anyway?"; then
       log::info "Aborting the creation of the library."
       log::info "You should first create an extension with ⌜valet self extend⌝ and then cd into the created directory."

commands.d/self-build.sh

@@ -13,9 +13,9 @@
 command: self build
 function: selfBuild
 author: github.com/jcaillon
-shortDescription: Index all the commands and libraries present in the valet user directory and installation directory.
+shortDescription: Index all the commands and libraries present in the valet extensions directory and installation directory.
 description: |-
-  Index all the command and libraries present in the valet user directory and installation directory.
+  Index all the command and libraries present in the valet extensions directory and installation directory.
 
   This command can be used to re-build the menu / help / options / arguments in case you have modified, added or removed a Valet command definition.
 
@@ -25,7 +25,7 @@ description: |-
 
   - Makes a list of all the eligible files in which we could find command definitions.
   - For each file in this list, extract the command definitions.
-  - Build your commands file (in your valet user directory) from these definitions.
+  - Build your commands file (in your valet extensions directory) from these definitions.
   - Makes a list of all `libraries.d` directories found in the user directory.
 
   You can call this script directly in case calling ⌜valet self build⌝ is broken:
@@ -326,7 +326,7 @@ function extractCommandDefinitionsToVariables() {
   declareOtherCommandVariables
 
   if ((duplicatedCommands > 0)); then
-    core::fail "There are ${duplicatedCommands} duplicated commands, please remove them. Do you have a duplicated folder in your valet user directory?"
+    core::fail "There are ${duplicatedCommands} duplicated commands, please remove them. Do you have a duplicated folder in your valet extensions directory?"
   fi
 }
 

commands.d/self-document.sh

@@ -34,19 +34,20 @@ options:
 - name: -o, --output <directory path>
   description: |-
     The directory in which the documentation will be generated.
-    Defaults to the valet user directory.
+    Defaults to the valet extensions directory.
 - name: -C, --core-only
   description: |-
     Generate the documentation for the core functions only.
-    Will not generate for libraries present in the valet user directory.
+    Will not generate for libraries present in the valet extensions directory.
 examples:
 - name: self document
   description: |-
     Generate the documentation for all the library functions of Valet and output to the default directory.
 COMMAND_YAML
 function selfDocument() {
   local output coreOnly
-  command::parseArguments "$@"; eval "${REPLY}"
+  command::parseArguments "$@"
+  eval "${REPLY}"
   command::checkParsedResults
 
   # default output to the user directory
@@ -153,7 +154,7 @@ function selfDocument::getAllFunctionsDocumentation() {
     local line
     while IFS=$'\n' read -rd $'\n' line || [[ -n ${line:-} ]]; do
       if [[ ${reading} == "false" ]]; then
-        if [[ ${line} == "# ##"* && ${line} != *"(private)"*  && ${line} != *"(deprecated)"* ]]; then
+        if [[ ${line} == "# ##"* && ${line} != *"(private)"* && ${line} != *"(deprecated)"* ]]; then
           reading=true
         else
           continue
@@ -216,7 +217,7 @@ function selfDocument::convertFunctionDocumentationToMarkdown() {
     documentation="${documentation:${#line}+1}"
 
     if [[ "${line}" =~ ^("- \$"([^ :]+))[^_]+_[^_]+_:$ ]]; then
-      if (( parameterCount > 0 )); then
+      if ((parameterCount > 0)); then
         REPLY+=$'\n'
       else
         REPLY+="Inputs:"$'\n'$'\n'
@@ -433,4 +434,4 @@ function selfDocument_writeAllCommandsToMarkdown() {
   # add footer
   content+="> ${pageFooter}"
   fs::writeToFile "${outputFile}" content
-}
+}

commands.d/self-extend.sh

@@ -36,9 +36,9 @@ description: |-
 
   This command will either:
 
-  - Create and setup a new extension directory under the valet user directory,
+  - Create and setup a new extension directory under the valet extensions directory,
   - setup an existing directory as a valet extension,
-  - or download the given extension (repository) and install it in the Valet user directory.
+  - or download the given extension (repository) and install it in the valet extensions directory.
 
   For downloaded extensions, all GIT repositories are supported.
   For the specific cases of GitHub and GitLab repositories, this command will:
@@ -156,8 +156,8 @@ function selfExtend() {
 
   # rebuild the command cache
   log::info "Rebuilding the command cache."
-  command::deleteUserCommands
-  command::reloadUserCommands
+  command::deleteCommandsIndex
+  command::reloadCommandsIndex
 
   # rebuild the documentation
   log::info "Rebuilding the documentation."

commands.d/self-install.sh

@@ -44,12 +44,12 @@ description: |-
       in a bin directory already present in your PATH, or by adding the Valet
       directory to your PATH on shell startup.
 
-  - 4. Copy the showcase (command examples) in the valet user directory ~/.valet.d.
+  - 4. Copy the showcase (command examples) in the valet extensions directory ~/.valet.d.
 
   - 6. Run self setup command (in case of a new installation) or re-export the config.
 
   - 7. Try to update (fetch merge --ff-only) the git repositories and all
-      installed extensions in your valet user directory.
+      installed extensions in your valet extensions directory.
 
 options:
 - name: -u, --unattended
@@ -84,19 +84,19 @@ options:
   default: false
 - name: --no-showcase
   description: |-
-    Set to true to to not copy the showcase (command examples) to the valet user directory (~/.valet.d).
+    Set to true to to not copy the showcase (command examples) to the valet extensions directory (~/.valet.d).
 
     If you do not set this option, newer versions of the showcase will override the existing ones.
 
     In case of an update, if the showcase.d directory does not exist, the showcase will not be copied.
   default: false
 - name: -U, --skip-extensions
   description: |-
-    Set to true to not attempt to update the installed extensions under the valet user directory (~/.valet.d).
+    Set to true to not attempt to update the installed extensions under the valet extensions directory (~/.valet.d).
   default: false
 - name: -e, --only-extensions
   description: |-
-    Set to true to only update the installed extensions under the valet user directory (~/.valet.d).
+    Set to true to only update the installed extensions under the valet extensions directory (~/.valet.d).
   default: false
 - name: --skip-extensions-setup
   description: |-
@@ -332,14 +332,14 @@ function selfUpdate() {
   fi
 
   # remove the user commands to rebuild them
-  command::deleteUserCommands
+  command::deleteCommandsIndex
   if [[ ${firstInstallation} == "true" ]]; then
     # shellcheck source=../libraries.d/main
     source "${GLOBAL_INSTALLATION_DIRECTORY}/libraries.d/main"
     log::debug "Sourcing the core functions from valet."
     selfUpdate_sourceDependencies
   else
-    command::reloadUserCommands
+    command::reloadCommandsIndex
   fi
 
   if [[ ${createShim} == "true" ]]; then
@@ -744,7 +744,7 @@ if [[ ${GLOBAL_MAIN_INCLUDED:-} != "true" ]]; then
     *) REPLY="unknown" ;;
     esac
   }
-  function core::getExtensionsDirectory() { REPLY="${VALET_CONFIG_USER_VALET_DIRECTORY:-${HOME}/.valet.d}"; }
+  function core::getExtensionsDirectory() { REPLY="${VALET_CONFIG_EXTENSIONS_DIRECTORY:-${HOME}/.valet.d}"; }
   function core::getUserDataDirectory() { REPLY="${VALET_CONFIG_USER_DATA_DIRECTORY:-${XDG_DATA_HOME:-${HOME}/.local/share}/valet}"; }
   function interactive::confirm() {
     local \
@@ -776,7 +776,7 @@ if [[ ${GLOBAL_MAIN_INCLUDED:-} != "true" ]]; then
   function fs::readFile() { REPLY="$(<"${1}")"; }
   function progress::start() { :; }
   function progress::stop() { :; }
-  function command::deleteUserCommands() {
+  function command::deleteCommandsIndex() {
     core::getUserDataDirectory
     rm -f "${REPLY}/commands" 1>/dev/null || :
   }

commands.d/self-release.sh

@@ -55,7 +55,8 @@ options:
     Do not perform the release, just show what would be done.
 COMMAND_YAML
 function selfRelease() {
-  command::parseArguments "$@"; eval "${REPLY}"
+  command::parseArguments "$@"
+  eval "${REPLY}"
   command::checkParsedResults
 
   if [[ ${dryRun:-} == "true" ]]; then
@@ -245,7 +246,6 @@ function selfRelease::createRelease() {
       -d "${releasePayload}" \
       --- failOnError=true acceptableCodes='201,422'
 
-
     createdReleaseJson="${REPLY}"
 
     log::success "The new version has been released on GitHub."
@@ -349,9 +349,6 @@ function selfRelease::updateDocumentation() {
   exe::invoke cp -f "${GLOBAL_INSTALLATION_DIRECTORY}/extras/lib-valet.md" "${GLOBAL_INSTALLATION_DIRECTORY}/docs/static/lib-valet.md"
   exe::invoke cp -f "${GLOBAL_INSTALLATION_DIRECTORY}/extras/valet-commands.md" "${GLOBAL_INSTALLATION_DIRECTORY}/docs/static/valet-commands.md"
 
-  # copy the vscode recommended extensions
-  exe::invoke cp "${GLOBAL_INSTALLATION_DIRECTORY}/.vscode/extensions.json" "${GLOBAL_INSTALLATION_DIRECTORY}/extras/extensions.json"
-
   # export stats
   # shellcheck disable=SC2034
   local statsContent="nbFunctions: ${#SORTED_FUNCTION_NAMES[@]}"$'\n'