Simple maintenance improvements (#1918)

* Use license file from gnu.org

Downloaded from:
https://www.gnu.org/licenses/gpl-3.0.txt

* Add missing final newline

* Fix link

* Fix shellcheck warnings

* Move donation header one level up

* Fix typos

* Stop mixing tabs and spaces

* Trim trailing whitespace

LICENSE

@@ -1,7 +1,7 @@
                     GNU GENERAL PUBLIC LICENSE
                        Version 3, 29 June 2007
 
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
@@ -631,8 +631,8 @@ to attach them to the start of each source file to most effectively
 state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
-    {one line to give the program's name and a brief idea of what it does.}
+    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) {year}  {name of author}
+    Copyright (C) <year>  <name of author>
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -645,14 +645,14 @@ the "copyright" line and a pointer to where the full notice is found.
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 
   If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
-    {project}  Copyright (C) {year}  {fullname}
+    <program>  Copyright (C) <year>  <name of author>
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.
@@ -664,11 +664,11 @@ might be different; for a GUI interface, you would use an "about box".
   You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
 For more information on this, and how to apply and follow the GNU GPL, see
-<http://www.gnu.org/licenses/>.
+<https://www.gnu.org/licenses/>.
 
   The GNU General Public License does not permit incorporating your program
 into proprietary programs.  If your program is a subroutine library, you
 may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

cmake/Cache.cmake

@@ -27,4 +27,3 @@ if(CACHE_BINARY)
 else()
   message(WARNING "${CACHE_OPTION} is enabled but was not found. Not using it")
 endif()
-

cmake/CompilerWarnings.cmake

@@ -1,6 +1,6 @@
 # from here:
 #
-# https://github.com/lefticus/cppbestpractices/blob/master/02-Use_the_Tools_Avai lable.md
+# https://github.com/lefticus/cppbestpractices/blob/master/02-Use_the_Tools_Available.md
 
 function(set_project_warnings project_name)
   option(WARNINGS_AS_ERRORS "Treat compiler warnings as errors" TRUE)

cmake/modules/MacOSXBundleInfo.plist.in

@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>CFBundleDevelopmentRegion</key>
- 	<string>English</string>
+	<string>English</string>
 	<key>CFBundleExecutable</key>
 	<string>flameshot</string>
 	<key>CFBundleGetInfoString</key>
@@ -37,10 +37,10 @@
 	<key>NSHighResolutionCapable</key>
 	<string>True</string>
 	<key>LSUIElement</key>
-    <string>1</string>
+	<string>1</string>
-    <key>NSPhotoLibraryAddUsageDescription</key>
+	<key>NSPhotoLibraryAddUsageDescription</key>
-    <string>Application requires access to save screenshots to your gallery</string>
+	<string>Application requires access to save screenshots to your gallery</string>
-    <key>NSSupportsAutomaticGraphicsSwitching</key>
+	<key>NSSupportsAutomaticGraphicsSwitching</key>
-    <true/>
+	<true/>
 </dict>
 </plist>

data/appdata/org.flameshot.Flameshot.metainfo.xml

@@ -38,5 +38,4 @@ SPDX-License-Identifier: CC0-1.0
   <url type="homepage">https://github.com/flameshot-org/flameshot</url>
   <update_contact>https://github.com/flameshot-org/flameshot/issues/new</update_contact>
   <launchable type="desktop-id">org.flameshot.Flameshot.desktop</launchable>
-
 </component>

data/shell-completion/flameshot

@@ -21,19 +21,19 @@ _flameshot() {
 			return 0
 			;;
 		screen)
-			COMPREPLY=( $(compgen -W "$screen_opts --help -h" -- ${cur}) )
+			COMPREPLY=( $(compgen -W "$screen_opts --help -h" -- "${cur}") )
 			return 0
 			;;
 		gui)
-			COMPREPLY=( $(compgen -W "$gui_opts --help -h" -- ${cur}) )
+			COMPREPLY=( $(compgen -W "$gui_opts --help -h" -- "${cur}") )
 			return 0
 			;;
 		full)
-			COMPREPLY=( $(compgen -W "$full_opts --help -h" -- ${cur}) )
+			COMPREPLY=( $(compgen -W "$full_opts --help -h" -- "${cur}") )
 			return 0
 			;;
 		config)
-			COMPREPLY=( $(compgen -W "$config_opts --help -h" -- ${cur}) )
+			COMPREPLY=( $(compgen -W "$config_opts --help -h" -- "${cur}") )
 			return 0
 			;;
 		-f|--filename|-p|--path)
@@ -41,7 +41,7 @@ _flameshot() {
 			return 0
 			;;
 		-s|--showhelp|-t|--trayicon)
-			COMPREPLY=( $(compgen -W "true false" -- ${cur}) )
+			COMPREPLY=( $(compgen -W "true false" -- "${cur}") )
 			return 0
 			;;
 		-d|--delay|-h|--help|-c|--clipboard|--version|-v|--number|-n)
@@ -54,23 +54,23 @@ _flameshot() {
 	# Options
 	case "${cur}" in
 		-*)
-			COMPREPLY=( $( compgen -W "--version --help -v -h" -- ${cur}) )
+			COMPREPLY=( $( compgen -W "--version --help -v -h" -- "${cur}") )
 			return 0
 			;;
 		--*)
-			COMPREPLY=( $( compgen -W "--version --help" -- ${cur}) )
+			COMPREPLY=( $( compgen -W "--version --help" -- "${cur}") )
 			return 0
 			;;
 		*)
-			COMPREPLY=( $( compgen -W "${cmd}" -- ${cur}) )
+			COMPREPLY=( $( compgen -W "${cmd}" -- "${cur}") )
 			return 0
 			;;
 	esac
 }
 
 if [[ -n ${ZSH_VERSION} ]]; then
-    autoload -U bashcompinit
+	autoload -U bashcompinit
-    bashcompinit
+	bashcompinit
 fi
 
 complete -F _flameshot flameshot

docs/CONTRIBUTING.md

@@ -42,7 +42,7 @@ For small fixes or incremental improvements simply fork the repo and follow the
 
 After reporting you should aim to answer questions or clarifications as this helps pinpoint the cause of the issue.
 
-### Donations
+## Donations
 
 I improve Flameshot in my free time because I want to create something good for everyone to use.
 If you want you can donate some bucks [here](https://www.paypal.me/lupoDharkael).

docs/ReleaseNotes_0.9.md

@@ -15,7 +15,7 @@ bugs and added new features in version 0.9.
   - Behind the scenes we configure flameshot to automatically run on xcb. This significantly improves the
     wayland experience. This resolves issues with multimonitor setups and copying to the clipboard
 
-- New option to allow the the clipboard image to be a jpeg instead of a png. This may reduce bandwidth when pasting the 
+- New option to allow the clipboard image to be a jpeg instead of a png. This may reduce bandwidth when pasting the
 image into chat or email clients
 
 - New global shortcut menu. All actions hotkeys are fully customizable.

docs/Releasing.md

@@ -10,11 +10,10 @@ These are the code changes that need to take place
 These are the steps for actually making the release
 - [ ] Download all binaries from CI run started from PR related to code changes shown above
 - [ ] Create sha256 for each binary and compare against sha256 shown in the CI to verify there was no corruption or inserted malware.
-- [ ] Create a new "New Release" in githhub and explain changes in release notes
+- [ ] Create a new "New Release" in github and explain changes in release notes
 - [ ] Upload all binaries and sha's
 - [ ] Update flatpak manifest for flathub: https://github.com/flathub/org.flameshot.Flameshot
 - [ ] Push snapcraft edge release to stable
 - [ ] If this is a major release coordinate with sign path on signed windows binaries
 - [ ] Update change log on [website](https://github.com/flameshot-org/flameshot-org.github.io/) data/changelog.md
 - [ ] Update version on [website](https://github.com/flameshot-org/flameshot-org.github.io/blob/master/_coverpage.md)
-

packaging/macos/create_keychain.sh

@@ -25,9 +25,9 @@ security default-keychain -s build.keychain
 security unlock-keychain -p "${APPLE_TEMP_CI_KEYCHAIN_PASS}" build.keychain
 
 # import certificate
-[ -r "${TEMP_CI_CERT_FILENAME}" ] && rm ${TEMP_CI_CERT_FILENAME}
+[ -r "${TEMP_CI_CERT_FILENAME}" ] && rm "${TEMP_CI_CERT_FILENAME}"
 echo "${APPLE_DEVELOPER_ID_APPLICATION_CERT_DATA}" | base64 --decode > "${TEMP_CI_CERT_FILENAME}"
 security import "${TEMP_CI_CERT_FILENAME}" -P "${APPLE_DEVELOPER_ID_APPLICATION_CERT_PASS}" -k build.keychain -T /usr/bin/codesign
-[ -r "${TEMP_CI_CERT_FILENAME}" ] && rm ${TEMP_CI_CERT_FILENAME}
+[ -r "${TEMP_CI_CERT_FILENAME}" ] && rm "${TEMP_CI_CERT_FILENAME}"
 security find-identity -v
 security set-key-partition-list -S apple-tool:,apple:,codesign: -s -k "${APPLE_TEMP_CI_KEYCHAIN_PASS}" build.keychain

packaging/macos/sign_qtapp.sh

@@ -21,7 +21,7 @@ if [[ "${APPLE_DEV_IDENTITY}" == "" ]]; then
 fi
 
 echo "--> Start application signing process"
-codesign --sign "${APPLE_DEV_IDENTITY}" --verbose --deep ${APP_NAME}.app
+codesign --sign "${APPLE_DEV_IDENTITY}" --verbose --deep "${APP_NAME}.app"
 
 echo "--> Start packaging process"
 "$(brew --prefix qt5)/bin/macdeployqt" "${APP_NAME}.app" -dmg -sign-for-notarization="${APPLE_DEV_IDENTITY}"

packaging/macos/update_package.sh

@@ -4,7 +4,7 @@ echo "Change the permision of .dmg file"
 hdiutil convert "flameshot.dmg" -format UDRW -o "flameshot_rw.dmg"
 
 echo "Mount it and save the device"
-DEVICE=$(hdiutil attach -readwrite -noverify "flameshot_rw.dmg" | egrep '^/dev/' | sed 1q | awk '{print $1}')
+DEVICE=$(hdiutil attach -readwrite -noverify "flameshot_rw.dmg" | grep -E '^/dev/' | sed 1q | awk '{print $1}')
 sleep 5
 
 echo "Create the sysmbolic link to application folder"

packaging/win-installer/LICENSE/GPL-3.0.txt

@@ -1,7 +1,7 @@
                     GNU GENERAL PUBLIC LICENSE
                        Version 3, 29 June 2007
 
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
@@ -631,8 +631,8 @@ to attach them to the start of each source file to most effectively
 state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
-    {one line to give the program's name and a brief idea of what it does.}
+    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) {year}  {name of author}
+    Copyright (C) <year>  <name of author>
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -645,14 +645,14 @@ the "copyright" line and a pointer to where the full notice is found.
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 
   If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
-    {project}  Copyright (C) {year}  {fullname}
+    <program>  Copyright (C) <year>  <name of author>
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.
@@ -664,11 +664,11 @@ might be different; for a GUI interface, you would use an "about box".
   You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
 For more information on this, and how to apply and follow the GNU GPL, see
-<http://www.gnu.org/licenses/>.
+<https://www.gnu.org/licenses/>.
 
   The GNU General Public License does not permit incorporating your program
 into proprietary programs.  If your program is a subroutine library, you
 may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

src/utils/filenamehandler.cpp

@@ -66,7 +66,7 @@ QString FileNameHandler::parseFilename(const QString& name)
  * - If `format` is not given, the suffix will remain untouched, unless `path`
  *   has no suffix, in which case it will be given the "png" suffix
  * - If the path generated by the previous steps points to an existing file,
- * 	 "_NUM" will be appended to its base name, where NUM is the first
+ *   "_NUM" will be appended to its base name, where NUM is the first
  * available number that produces a non-existent path (starting from 1).
  * @param path Possibly incomplete file name to transform
  * @param format Desired output file suffix (excluding an initial '.' character)

src/utils/valuehandler.h

@@ -51,7 +51,7 @@ public:
      * `check`, the fallback will be returned. Otherwise the value is processed
      * by `process` and then returned.
      *
-     * @note Cannot be overriden
+     * @note Cannot be overridden
      * @see fallback, process
      */
     QVariant value(const QVariant& val);
@@ -60,7 +60,7 @@ public:
      */
     virtual QVariant fallback();
     /**
-     * @brief Return the representaion of the value in the config file.
+     * @brief Return the representation of the value in the config file.
      *
      * Override this if you want to write the value in a different format than
      * the one provided by `QVariant`.

tests/path_option.sh

@@ -30,7 +30,7 @@ echo ">> Redundancy in the path will be removed"
 "$flameshot" screen -p /tmp/flameshot_path_test/subdir/..///redundancy_removed.png
 
 sleep 2
-echo ">> If the destionation is a directory, the file name is generated from strf from the config"
+echo ">> If the destination is a directory, the file name is generated from strf from the config"
 "$flameshot" screen -p ./
 
 sleep 2