@sebastienrousseau/dotfiles 0.2.440 → 0.2.453

package/Makefile

@@ -0,0 +1,79 @@
+#!/usr/bin/env make -f
+
+# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.453) - https://dotfiles.io
+# Copyright (c) Sebastien Rousseau 2022. All rights reserved
+# License: MIT
+
+.DEFAULT_GOAL := help
+
+homedir := ./installer
+language := en
+PNPM := $(shell command -v pnpm 2> /dev/null)
+HOMEDIR:= $(shell pwd)
+
+.PHONY: backup
+backup: # @HELP Backup your current dotfiles.
+backup: ## Backup your current dotfiles.
+ifdef PNPM
+	pnpm run backup
+else
+	sh $(HOMEDIR)/bin/dotfiles.sh backup
+endif
+
+.PHONY: installer
+installer: # @HELP Install the dotfiles on your system.
+installer: ## Install the dotfiles on your system.
+ifdef PNPM
+	pnpm run installer
+else
+	sh $(HOMEDIR)/bin/dotfiles installer
+endif
+
+.PHONY: copy
+copy: # @HELP Copy the dotfiles on your system.
+copy: ## Copy the dotfiles on your system.
+ifdef PNPM
+	pnpm run copy
+else
+	sh $(HOMEDIR)/bin/dotfiles copy
+endif
+
+.PHONY: download
+download: # @HELP Download the dotfiles on your system.
+download: ## Download the dotfiles on your system.
+ifdef PNPM
+	pnpm run download
+else
+	sh $(HOMEDIR)/bin/dotfiles download
+endif
+
+.PHONY: unpack
+unpack: # @HELP Unpack the dotfiles on your system.
+unpack: ## Unpack the dotfiles on your system.
+ifdef PNPM
+	pnpm run unpack
+else
+	sh $(HOMEDIR)/bin/dotfiles unpack
+endif
+
+.PHONY: clean
+clean: # @HELP Removes any previous setup directories. (site, theme source and theme folders)
+clean:
+ifdef PNPM
+	pnpm run clean
+else
+	sh $(HOMEDIR)/bin/dotfiles clean
+endif
+
+.PHONY: help
+help: # @HELP Display the help menu.
+help:
+ifdef PNPM
+	pnpm run help
+else
+	@grep -E '^.*: *# *@HELP' $(MAKEFILE_LIST)    \
+	| awk '                                   \
+			BEGIN {FS = ": *# *@HELP"};           \
+			{ printf "  %-30s %s\n"$$1$$2 };  \
+	'
+endif

package/README.md

@@ -1,109 +1,429 @@
-<p align="center">
-  <img src="Dotfiles.png" alt="Dotfiles Logo" title="Dotfiles Logo">
-</p>
+# Dotfiles v0.2.453
 
-[![NPM](https://nodei.co/npm/reedia-dotfiles.png)](https://nodei.co/npm/reedia-dotfiles/)
+[![Banner representing the Dotfiles Library][logo]][website]
 
-[![npm version](https://badge.fury.io/js/reedia-dotfiles.svg)](https://badge.fury.io/js/reedia-dotfiles)
-[![Build Status](https://travis-ci.org/reedia/dotfiles.svg?branch=master)](https://travis-ci.org/reedia/dotfiles)
-[![Packagist](https://img.shields.io/badge/license-MIT-blue.svg)](https://skeletonic.github.io/license)
+[![Codacy][codacy-grade]][codacy-url]
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![License][license]][license-url]
+[![Love][love]][website]
 
-# Dotfiles
+**[Website][website] • [Documentation][github]
+• [Report Bug][issues]
+• [Request Feature][issues]
+• [Contributing Guidelines][contributing]**
 
-## Mac OS X Dotfiles
+## 👋 Welcome to Dotfiles
 
-Simply designed to fit your shell life.
+Dotfiles are set of macOS / Linux and Windows configuration files.
 
-<a href="https://github.com/sebastienrousseau/dotfiles/releases/latest">Download Dotfiles</a>
+[![Getting Started][getting started]](#getting-started)
+[![Download Dotfiles v0.2.453][download_button]][download]
 
-## Table of contents
+### Simply designed to fit your shell life
 
-- [Dotfiles](#dotfiles)
-  - [Mac OS X Dotfiles](#mac-os-x-dotfiles)
-  - [Table of contents](#table-of-contents)
-  - [Getting Started](#getting-started)
-  - [What's in the box](#whats-in-the-box)
-  - [Contributing](#contributing)
-  - [Code of Conduct](#code-of-conduct)
-  - [Our Values](#our-values)
-  - [History](#history)
-  - [License](#license)
-  - [Acknowledgements](#acknowledgements)
+Dotfiles aggregates a collection of standalone configuration files (dotfiles)
+combined into a `shell` directory that can be used to customize your development
+environment across numerous computers and operating systems (macOS, Windows,
+Linux).
+
+The Dotfiles provides modular configuration files (aliases, functions and paths)
+built for speed, higher performance, with the aim of helping you have an easy
+and centralized way to configure your environment and applications.
+
+![divider][divider]
+
+## 💼 Documentation
+
+To read the documentation for Dotfiles, please visit:
+
+- [Dotfiles website][website]
+- [Dotfiles Docs GitHub repository][docs]
+
+![divider][divider]
 
 ## Getting Started
 
-A few options are available:
+### 🔧 Installation
+
+We are so delighted that you have decided to try Dotfiles, and are sure that you
+will find Dotfiles unique and helpful.
+
+Dotfiles seeks to bring you high quality and easy to use standalone and modular configuration files that can be used to customize your development environment
+across numerous computers and operating systems (macOS, Windows, Linux).
+
+We understand that you may want to install Dotfiles without reading long manuals
+and lengthy documentation. So we have tried to make the installation process as
+easy as possible.
+
+### 📦 Prerequisites
+
+However, we recommend that you read the below guidelines before installing
+Dotfiles. A range of installation methods are available, and we recommend that
+you choose the one that best suits your needs.
+
+![divider][divider]
+
+### ✔️ Requirements
+
+The following requirements are needed to install Dotfiles:
+
+- [**Bash**][bash] - a shell, or command language interpreter, for the GNU
+  operating system.
+- Or [**Zsh**][zsh] - a shell designed for interactive use, although it is also a
+  powerful scripting language.
+- [**Git**][git] - a free and open source distributed version control system
+  designed to handle everything from small to very large projects with speed and efficiency.
+- [**Curl**][curl] - a command line tool for transferring data with URL syntax.
+- [**Wget**][wget] - a free software package for retrieving files using HTTP,
+  HTTPS and FTP, the most widely-used Internet protocols.
+- [**Make**][make] - a tool which controls the generation of executables and other
+  non-source files of a program from the program's source files.
+- [**Shell**][shell] - a shell command line interpreter program for Unix-like
+  operating systems.
+- [**PnPM**][pnpm] - a package manager for JavaScript and Node.js. It is fast,
+  disk space efficient and reliable.
+
+### 1️⃣ Download Dotfiles
+
+You can download the latest version (v0.2.453) with the following options:
+
+- [**Manual download**][releases] - **The easiest way to install Dotfiles.**
+- [**Install with PnPM**](https://www.npmjs.com/package/@sebastienrousseau/dotfiles)
+  `pnpm i -g @sebastienrousseau/dotfiles`.
+- [**Install with Npm**](https://www.npmjs.com/package/@sebastienrousseau/dotfiles)
+  `npm install -g @sebastienrousseau/dotfiles`.
+- [**Install with Yarn**](https://yarnpkg.com/package/@sebastienrousseau/dotfiles)
+  `yarn global add @sebastienrousseau/dotfiles`.
+- **Clone the main repository** to get all source files including build scripts:
+  `git clone https://github.com/sebastienrousseau/dotfiles.git`. This will clone
+  the latest version of the Dotfiles repository.
+
+### 2️⃣ Back Up Your Existing Data
+
+Before installing Dotfiles, we strongly recommend that you back up your existing
+data. The Dotfiles installer will try to automatically backup any previous
+installation of known dotfiles into a backup directory
+`$HOME/.dotfiles/backup`.
+
+The backup files are the following:
+
+```bash
+.alias
+.bash_aliases
+.bash_profile
+.bash_prompt
+.bashrc
+.curlrc
+.dir_colors
+.exports
+.functions
+.gitattributes
+.gitconfig
+.gitignore
+.gitmessage
+.inputrc
+.npmrc
+.path
+.profile
+.tmux.conf
+.vimrc
+.wgetrc
+.yarnrc
+.zshenv
+.zshrc
+cacert.pem
+```
+
+After installation, you will find the backup files in the `~/dotfiles_backup`
+directory. It is always a good idea to backup as there might be situations in which you
+could be required to restore your previous installation.
+
+### 3️⃣ Try it out and let us know what you think
+
+To install the latest version of the dotfiles, run the following command:
+
+#### Using make (highly recommended)
+
+Simply run the following command in your terminal / shell:
+
+```bash
+make installer
+```
+
+or if you want to just check the options available, run the following command:
 
-- Download the latest [release](https://github.com/sebastienrousseau/dotfiles/releases/latest)
-- Or simply clone the main repository: `git clone https://github.com/sebastienrousseau/dotfiles.git`
+```bash
+make help
+```
 
-## What's in the box
+#### Using PnPM (recommended if you have PnPM installed)
 
-Within the release you'll find the following files and folders:
+PnPM is a key dependency of the dotfiles package. It will help you install the
+dotfiles rapidly and very efficiently.
 
+```bash
+pnpm installer
 ```
+
+### Post installation
+
+Following the installation, you can verify that the dotfiles package is installed
+in the following directory `$HOME/.dotfiles_backup`.
+
+Just quit your terminal and restart it. If the installation is successful, you
+should be able to see a new interface of your terminal and be able to start
+using the dotfiles aliases and other configurations.
+
+Please refer to the [documentation][docs] for more information.
+
+![divider][divider]
+
+### 4️⃣ What's included
+
+Dotfiles contains core elements that are used to configure your shell, and other components catered for your environment setup.
+
+Within the download you'll find all the Dotfiles source files grouped within the
+`shell` folder.
+
+You'll see something like this:
+
+```bash
 .
-├── .curlrc
-├── .eslintrc
-├── .gitignore
-├── .jshintrc
-├── .travis.yml
-├── .wgetrc
-├── CODE_OF_CONDUCT.md
-├── CONTRIBUTING.md
-├── Dotfiles.png
-├── ISSUE_TEMPLATE.md
-├── Icon
-├── LICENSE
+├── aliases
+│   ├── default
+│   │   ├── README.md
+│   │   └── default.aliases.sh    # Default aliases
+│   ├── gcloud
+│   │   ├── README.md
+│   │   └── gcloud.aliases.sh     # GCloud aliases
+│   ├── git
+│   │   ├── README.md
+│   │   └── git.aliases.wip       # Git aliases (WIP)
+│   ├── heroku
+│   │   ├── README.md
+│   │   └── heroku.aliases.sh     # Heroku aliases
+│   ├── jekyll
+│   │   ├── README.md
+│   │   └── jekyll.aliases.sh     # Jekyll aliases
+│   ├── pnpm
+│   │   ├── README.md
+│   │   └── pnpm.aliases.sh       # PnPM aliases
+│   ├── subversion
+│   │   ├── README.md
+│   │   └── subversion.aliases.sh # Subversion aliases
+│   ├── tmux
+│   │   ├── README.md
+│   │   └── tmux.aliases.sh       # Tmux aliases
+│   └── README.md
+├── configurations
+│   ├── bash
+│   │   └── bashrc                # Bash configurations
+│   ├── curl
+│   │   ├── cacert.pem            # CA Certificates
+│   │   └── curlrc                # Curl configurations
+│   ├── default
+│   │   ├── color.sh              # Color definitions
+│   │   ├── editor.sh             # Editor definitions
+│   │   └── prompt.sh             # Prompt definitions
+│   ├── inputrc
+│   │   └── inputrc               # Inputrc configurations
+│   ├── jshint
+│   │   └── jshintrc              # JSHint configurations
+│   ├── profile
+│   │   └── profile               # Profile configurations
+│   ├── tmux
+│   │   └── tmux                  # Tmux configurations
+│   ├── vim
+│   │   └── vimrc                 # Vim configurations
+│   ├── wget
+│   │   └── wgetrc                # Wget configurations
+│   ├── zsh
+│   │   └── zshrc                 # Zsh configurations
+│   └── README.md
+├── functions
+│   ├── README.md
+│   ├── cdls.sh                   # cdls function
+│   ├── changediskpwd.sh          # changediskpwd function
+│   ├── code.sh                   # code function
+│   ├── countdown.sh              # countdown function
+│   ├── curlheader.sh             # curlheader function
+│   ├── curltime.sh               # curltime function
+│   ├── encode64.sh               # encode64 function
+│   ├── environment.sh            # environment function
+│   ├── extract.sh                # extract function
+│   ├── filehead.sh               # filehead function
+│   ├── genpwd.sh                 # genpwd function
+│   ├── goto.sh                   # goto function
+│   ├── headers.sh                # headers function
+│   ├── hidehiddenfiles.sh        # hidehiddenfiles function
+│   ├── history-all.sh            # history-all function
+│   ├── hostinfo.sh               # hostinfo function
+│   ├── hstats.sh                 # hstats function
+│   ├── httpdebug.sh              # httpdebug function
+│   ├── keygen.sh                 # keygen function
+│   ├── last.sh                   # last function
+│   ├── logout.sh                 # logout function
+│   ├── lowercase.sh              # lowercase function
+│   ├── macos.sh                  # macos function
+│   ├── matrix.sh                 # matrix function
+│   ├── mcd.sh                    # mcd function
+│   ├── mount_read_only.sh        # mount_read_only function
+│   ├── myproc.sh                 # myproc function
+│   ├── prependpath.sh            # prependpath function
+│   ├── print.sh                  # print function
+│   ├── ql.sh                     # ql function
+│   ├── rd.sh                     # rd function
+│   ├── remove_disk.sh            # remove_disk function
+│   ├── ren.sh                    # ren function
+│   ├── rm.sh                     # rm function
+│   ├── rps.sh                    # rps function
+│   ├── showhiddenfiles.sh        # showhiddenfiles function
+│   ├── size.sh                   # size function
+│   ├── stopwatch.sh              # stopwatch function
+│   ├── trash.sh                  # trash function
+│   ├── tree.sh                   # tree function
+│   ├── uppercase.sh              # uppercase function
+│   ├── uuidgen.sh                # uuidgen function
+│   ├── view-source.sh            # view-source function
+│   ├── vscode.sh                 # vscode function
+│   ├── whoisport.sh              # whoisport function
+│   └── zipf.sh                   # zipf function
+├── paths
+│   ├── ant
+│   │   └── ant.paths.sh          # Ant paths
+│   ├── default
+│   │   └── default.paths.sh      # Default paths
+│   ├── homebrew
+│   │   └── homebrew.paths.sh     # Homebrew paths
+│   ├── java
+│   │   └── java.paths.sh         # Java paths
+│   ├── maven
+│   │   └── maven.paths.sh        # Maven paths
+│   ├── node
+│   │   └── node.paths.sh         # Node paths
+│   ├── nvm
+│   │   └── nvm.paths.sh          # Nvm paths
+│   ├── pnpm
+│   │   └── pnpm.paths.sh         # Pnpm paths
+│   ├── ruby
+│   │   └── ruby.paths.sh         # Ruby paths
+│   └── tmux
+│       └── tmux.paths.sh         # Tmux paths
 ├── README.md
-├── bash
-│   ├── .bash_aliases
-│   ├── .bash_exit
-│   ├── .bash_functions
-│   ├── .bash_load_completion
-│   ├── .bash_profile
-│   └── .bashrc
-├── homebrew
-│   ├── brew-cask.sh
-│   ├── brew-package.sh
-│   ├── brew-tap.sh
-│   └── install.sh
-├── zsh
-│   ├── configurations
-│   ├── functions
-├── installers
-└── package.json
+├── aliases.sh                    # aliases loader
+├── configurations.sh             # configurations loader
+├── exit.sh                       # exit loader
+├── functions.sh                  # functions loader
+├── history.sh                    # history loader
+└── paths.sh                      # paths loader
 
+32 directories, 95 files
 ```
 
-## Contributing
+## 🔗 Releases
 
-Please read carefully through our [Contributing Guidelines](https://github.com/sebastienrousseau/dotfiles/blob/master/CONTRIBUTING.md) for further details on the process for submitting pull requests to us.
+Releases are available on the [GitHub releases page][releases].
 
-## Code of Conduct
+![divider][divider]
 
-We are committed to preserving and fostering a diverse, welcoming community. Please read our [Code of Conduct](https://github.com/sebastienrousseau/dotfiles/blob/master/CODE_OF_CONDUCT.md).
+## 🚥 Semantic versioning policy
 
-## Our Values
+For transparency into our release cycle and in striving to maintain backward
+compatibility, `Dotfiles` follows [Semantic Versioning][semver-url]
+(SemVer) and [ESLint's Semantic Versioning Policy][eslint-semantic-url].
 
-1. We believe perfection must consider everything.
-2. We take our passion beyond Code into our daily practices.
-3. We are just obsessed about creating and delivering exceptional solutions.
+![divider][divider]
 
 ## History
 
-- See [Dotfiles Release](https://github.com/sebastienrousseau/dotfiles/releases) list.
+- See [Dotfiles Release](https://github.com/sebastienrousseau/dotfiles/releases)
+  list.
+
+## ✅ Changelog
+
+- [GitHub Releases](https://github.com/sebastienrousseau/dotfiles/releases)
+
+![divider][divider]
 
-## License
+## 📖 Code of Conduct
 
-This project is licensed under the MIT License - see the [LICENSE](https://github.com/sebastienrousseau/dotfiles/blob/master/LICENSE) file for details
+We are committed to preserving and fostering a diverse, welcoming community.
+Please read our [Code of Conduct](https://github.com/sebastienrousseau/dotfiles/blob/master/.github/CODE-OF-CONDUCT.md).
+
+![divider][divider]
+
+## ⭐️ Our Values
+
+- We believe perfection must consider everything.
+- We take our passion beyond code into our daily practices.
+- We are just obsessed about creating and delivering exceptional solutions.
+
+![divider][divider]
+
+## ❤️ Contributing
+
+Thank you for using Dotfiles! If you like the library, it would be
+great if you can give it a star ⭐ on [GitHub][github].
+
+There are also many ways in which you can participate in this project, for
+example:
+
+- [Submit bugs and feature requests](https://github.com/sebastienrousseau/dotfiles/issues/new), and help us verify as they are checked in,
+- Review [source code changes](https://github.com/sebastienrousseau/dotfiles/pulls), and help us improve our code quality,
+- Review the [documentation](https://github.com/sebastienrousseau/dotfiles/docs) and make pull requests for anything from typos to additional and new content.
+
+Please read carefully through our
+[Contributing Guidelines][contributing]
+for further details on the process for submitting pull requests to us.
+
+![divider][divider]
+
+## 🥂 License
+
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/sebastienrousseau/dotfiles/blob/master/LICENSE) file for details.
 
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Freedia%2Fdotfiles.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Freedia%2Fdotfiles?ref=badge_large)
 
-## Acknowledgements
+![divider][divider]
 
-[Dotfiles](https://dotfiles.io) is beautifully crafted by these people and a bunch of awesome [contributors](https://github.com/sebastienrousseau/dotfiles/graphs/contributors)
+## 🏢 Acknowledgements
+
+[Dotfiles][website] is beautifully crafted by these people and a
+bunch of awesome [contributors](https://github.com/sebastienrousseau/dotfiles/graphs/contributors)
 
 | [![Sebastien Rousseau](https://avatars0.githubusercontent.com/u/1394998?s=117)](http://sebastienrousseau.co.uk) | [![Graham Colgate](https://avatars0.githubusercontent.com/u/35816108?s=117)](https://github.com/gramtech) |
 | :-------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------: |
 | [Sebastien Rousseau](https://github.com/sebastienrousseau) | [Graham Colgate](https://github.com/gramtech) |
+
+[bash]: https://www.gnu.org/software/bash/
+[contributing]: https://github.com/sebastienrousseau/dotfiles/blob/master/.github/CONTRIBUTING.md
+[curl]: https://curl.se/
+[docs]: https://github.com/sebastienrousseau/dotfiles/docs
+[download]: https://github.com/sebastienrousseau/dotfiles/archive/refs/tags/v0.2.453.tar.gz
+[git]: https://git-scm.com/
+[github]: https://github.com/sebastienrousseau/dotfiles
+[issues]: https://github.com/sebastienrousseau/dotfiles/issues
+[make]: https://www.gnu.org/software/make/
+[pnpm]: https://pnpm.io
+[releases]: https://github.com/sebastienrousseau/dotfiles/releases
+[shell]: https://www.gnu.org/software/shell/
+[website]: https://dotfiles.io
+[wget]: https://www.gnu.org/software/wget/
+[zsh]: https://www.zsh.org/
+
+[logo]: https://github.com/sebastienrousseau/dotfiles/raw/master/assets/dotfiles.svg
+[download_button]: https://github.com/sebastienrousseau/dotfiles/raw/master/assets/button-secondary.svg
+[getting started]: https://github.com/sebastienrousseau/dotfiles/raw/master/assets/button-primary.svg
+[codacy-grade]: https://img.shields.io/codacy/grade/634cfc4de08e492ebcbb341631066241?style=for-the-badge
+[codacy-url]:https://www.codacy.com/gh/sebastienrousseau/dotfiles/dashboard
+[contributors-shield]: https://img.shields.io/github/contributors/sebastienrousseau/dotfiles.svg?style=for-the-badge
+[contributors-url]: https://github.com/sebastienrousseau/dotfiles/graphs/contributors
+[divider]: https://raw.githubusercontent.com/sebastienrousseau/dotfiles/master/assets/divider.svg "divider"
+[forks-shield]: https://img.shields.io/github/forks/sebastienrousseau/dotfiles.svg?style=for-the-badge
+[forks-url]: https://github.com/sebastienrousseau/dotfiles/network/members
+[license-url]: https://opensource.org/licenses/MIT
+[license]: https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge\&color=ff69b4
+[love]: https://github.com/sebastienrousseau/dotfiles/raw/master/assets/made-with-love.svg
+[semver-url]: http://semver.org/
+[eslint-semantic-url]: https://github.com/eslint/eslint#semantic-versioning-policy