Skip to content

Deprecated functionality

🛠️ Guide · ⬅ Home

Recent changes (most recent changes first)

This document lists functionality which was removed, why, and when.

Release v0.41.0

Continuing naming fixes to be consistent across the library.

Function name ordering (noun-verb)

  • isSubstring -> stringFound
  • hasHook -> hookExists
  • alignLeft -> textAlignLeft
  • alignRight -> textAlignRight
  • clearLine -> consoleLineFill
  • debugOpenFiles -> filesOpenStatus
  • findUncaughtAssertions -> bashFindUncaughtAssertions
  • hasColors -> consoleHasColors
  • hasConsoleAnimation -> consoleHasAnimation
  • insideDocker -> dockerInside
  • isAbsolutePath -> pathIsAbsolute
  • makeShellFilesExecutable -> bashMakeExecutable
  • echoBar -> consoleLine
  • yesterdayDate -> dateYesterday
  • todayDate -> dateToday
  • tomorrowDate -> dateTomorrow
  • beginsWith -> stringBegins
  • extensionLists -> fileExtensionLists
  • whichHook -> hookFind
  • whichExists -> executableExists
  • lineFill -> consoleHeadingLine
  • boxedHeading -> consoleHeadingBoxed
  • plainLength -> consolePlainLength
  • mapReturn -> returnMap
  • maximumFieldLength -> fileFieldMaximum
  • maximumLineLength -> fileLineMaximum
  • stripAnsi -> consoleToPlain

Removed

  • cachedShaPipe -> shaPipe --cache
  • testTools -> testSuite (just call directly)

Renamed

  • junitTestCaseFailed -> junitTestCaseFailure

Many functions were "made first class" by removing the initial underscore:

  • __throwEnvironment -> throwEnvironment
  • __catchEnvironment -> catchEnvironment
  • __throwArgument -> throwArgument
  • __catchArgument -> catchArgument
  • __throw -> returnThrow
  • __catch -> catchReturn
  • __catchCode-> catchCode
  • __execute-> execute
  • __echo -> executeEcho
  • _choose -> booleanChoose

Naming convention fixes:

  • isAbsolutePath -> pathIsAbsolute
  • bashDocumentation_Extract -> bashDocumentationExtract
  • nextMinorVersion -> versionNextMinor
  • newRelease -> releaseNew

Using "return code" in our naming:

  • exitString -> returnCodeString

Release v0.40.4

  • usageArgumentFoo "$handler" -> validate "$handler" Foo - validate is new system and used universally (old functions are deprecated)
  • catchEnvironment -> catchReturn for internal functions (maintains return code consistently)

Release v0.40.0

Removed underscores from external functions:

  • markdown_removeUnfinishedSections -> markdownRemoveUnfinishedSections
  • markdown_FormatList -> markdownFormatList
  • simpleMarkdownToConsole -> markdownToConsole

Release v0.39.0

Function name ordering (noun-verb):

  • isAbsolutePath -> pathIsAbsolute
  • nextMinorVersion -> versionNextMinor
  • NextMinorVersion -> VersionNextMinor
  • newRelease -> releaseNew
  • NewRelease -> ReleaseNew

Remove underscores from external API functions

  • bashDocumentation_Extract -> bashDocumentationExtract
  • __throwEnvironment -> throwEnvironment
  • __catchEnvironment -> catchEnvironment
  • __throwArgument -> throwArgument
  • __catchArgument -> catchArgument
  • __throw -> returnThrow
  • __catch -> catchReturn
  • __catchCode -> catchCode
  • __environment -> catchEnvironment "returnMessage"
  • __execute -> execute
  • __echo -> executeEcho
  • _choose -> booleanChoose

Internal renaming

Words match the intention of the code block better:

  • IDENTICAL _return -> IDENTICAL returnMessage
  • _IDENTICAL_ exitString -> _IDENTICAL_ returnString
  • exitString -> returnCodeString
  • returnCatchEnvironment -> catchEnvironment
  • returnCatchArgument -> catchArgument
  • returnThrowEnvironment -> throwEnvironment
  • returnThrowArgument -> throwArgument
  • returnCatchCode -> catchCode
  • returnCatch -> catchReturn

Release v0.38.3

Argument comments changed from Exit Code: to Return Code: - to match better semantics of the code.

  • Exit Code: -> # Return Code: - 'return code' is more appropriate for functions

Release v0.37.2

  • Renamed interactiveBashSource -> approveBashSource
  • Renamed approvedFiles -> approvedBashSources
  • Usage of __catch instead of __catchEnvironment for internal functions

Release v0.37.0

  • Lots of function renaming to have more functions in the form nounVerb
  • Eliminated internal functions for first class ones _clean -> returnClean, _undo -> returnUndo

Release v0.34.0

  • iTerm2Colors module now TermColors as it handles all colors

Older changes (in order of version)

  • build-setup.sh - Previous version of install-bin-build.sh. Deprecated 2023.

Release v0.3.12

  • failed -> buildFailed - Too generic a name

Release v0.6.0

  • markdown_FormatList - markdown_FormatList - spelling doesn`t like it when we are cute

Release v0.6.1

  • usageWhich - usageRequireBinary usage - Reworked usage functions

Release v0.7.0

  • usageWrapper and usageWhich, usageEnvironment going the way of the dinosaur

Release v0.7.9

  • awsHasEnvironment -> awsHasEnvironment - aws prefix consistency
  • isAWSKeyUpToDate -> awsIsKeyUpToDate

Release v0.7.10

  • bin/build/pipeline files are all deprecated

Release v0.7.13

  • map.sh - Previous name for map.sh. Deprecated 2023. Prefer the shorter name.
  • copyFileChanged --map deprecated. Use copyFileChanged --map instead.
  • copyFileChanged --map --escalate deprecated. Use copyFileChanged --map --escalate
  • copyFileChanged --escalate deprecated. copyFileChanged --escalate
  • yesNo -> parseBoolean. Better name.

Release v0.8.4

  • copyFile -> copyFile

Release v0.10.0

  • wrapLines -> wrapLines (merged) = trimSpace -> trimSpace (merged)

Release v0.10.4

  • crontabApplicationUpdate -> crontabApplicationUpdate (more accurate name)
  • usageArgumentMissing (unused/consistency)
  • usageArgumentUnknown (unused/consistency)

Release v0.11.1

  • usageArgumentString -> usageArgumentString (consistent type name after usageArgument is a design feature)

  • usageArgumentString -> usageArgumentEmptyString (support blank arguments)

  • environmentFileShow -> environmentFileShow (naming consistency)

  • environmentFileApplicationMake -> environmentFileApplicationMake (naming consistency)
  • environmentApplicationVariables -> environmentApplicationVariables (naming consistency)

  • environmentApplicationLoad -> environmentApplicationLoad (naming consistency)

  • dotEnvConfigure deprecated. Use environmentFileLoad .env --optional .env.local

Release v0.11.2

  • outputTrigger -> outputTrigger (now part of library)

Release v0.11.4

  • Deprecated tokens ops.sh __ops

Release v0.11.6

  • bashSanitize bashSanitize (naming consistency)
  • bashLintFiles bashLintFiles (naming consistency)
  • bashLint bashLint (naming consistency)

Release v0.11.7

Release v0.11.8

  • Deprecated tokens __try

Release v0.11.9

  • awsRegionValid awsRegionValid

Release v0.11.10

  • __execute __execute

Release v0.11.14

  • tarCreate tarCreate

Release v0.12.2

  • awsSecurityGroupIPModify --register awsSecurityGroupIPModify --register

Release v0.14.3

  • bin/build/pipeline binaries are all deprecated.

Release v0.14.6

apt calls are deprecated for new generic package functions:

  • packageInstalledList -> packageInstalledList (naming consistency)
  • packageInstall -> packageInstall
  • packageUninstall packageUninstall
  • packageUpdate packageUpdate
  • packageWhich packageWhich
  • packageWhichUninstall packageWhichUninstall
  • packageNeedRestartFlag packageNeedRestartFlag

Release v0.15.1

Single decoration function:

  • decorate code -> decorate code
  • decorate error -> decorate error
  • decorate orange -> decorate orange
  • decorate bold-orange -> decorate bold-orange
  • decorate blue -> decorate blue
  • decorate bold-blue -> decorate bold-blue
  • decorate red -> decorate red
  • decorate bold-red -> decorate bold-red
  • decorate green -> decorate green
  • decorate bold-green -> decorate bold-green
  • decorate cyan -> decorate cyan
  • decorate bold-cyan -> decorate bold-cyan
  • decorate yellow -> decorate yellow
  • decorate magenta -> decorate magenta
  • decorate black -> decorate black
  • decorate bold-black -> decorate bold-black
  • decorate bold-white -> decorate bold-white
  • decorate white -> decorate white
  • decorate bold-magenta -> decorate bold-magenta
  • decorate underline -> decorate underline
  • decorate bold -> decorate bold
  • decorate no-bold -> decorate no-bold
  • decorate no-underline -> decorate no-underline
  • decorate info -> decorate info
  • decorate warning -> decorate warning
  • decorate success -> decorate success
  • decorate decoration -> decorate decoration
  • decorate subtle -> decorate subtle
  • decorate label -> decorate label
  • decorate value -> decorate value

Release v0.17.0

  • --env is changed for most functions which use it; changed to --env-file to match other applications.
  • confirmYesNo defaultValue changed to confirmYesNo --yes or confirmYesNo --no respectively - uses better argument parser

Release v0.17.6

  • _integer -> isPositiveInteger (more natural naming, short enough)
  • confirmYesNo --yes -> confirmYesNo --yes (support flags properly)
  • confirmYesNo --yes -> confirmYesNo --yes
  • confirmYesNo --no -> confirmYesNo --no
  • confirmYesNo --no -> confirmYesNo --no

Release v0.18.5

  • isBoolean -> isBoolean (more natural naming, short enough)

Release v0.18.6

  • decorate reset -> decorate reset

🛠️ Guide · ⬅ Home