diff --git a/README.md b/README.md index 81820354..60bd5b78 100644 --- a/README.md +++ b/README.md @@ -1,566 +1,130 @@ -# The Fuck [![Version][version-badge]][version-link] [![Build Status][workflow-badge]][workflow-link] [![Coverage][coverage-badge]][coverage-link] [![MIT License][license-badge]](LICENSE.md) +# Report for Assignment 1 - Group 82 -*The Fuck* is a magnificent app, inspired by a [@liamosaur](https://twitter.com/liamosaur/) -[tweet](https://twitter.com/liamosaur/status/506975850596536320), -that corrects errors in previous console commands. +## Project Information +- **Name:** TheFuck - Magnificent app which corrects your previous console command +- **URL:** https://github.com/dimalarcon/SEP2024-Group82-thefuck +- **Programming Language:** Python -Is *The Fuck* too slow? [Try the experimental instant mode!](#experimental-instant-mode) +## Code Metrics -[![gif with examples][examples-link]][examples-link] +- **Number of lines of code:** 547801 (54.7 KLOC) +- **Tool used to measure the number of lines of code:** lizard -More examples: +![Lizard-KLOC-Screenshot-output-command](/screenshots/lizard-kloc(21-06-2024_16-39-00).png) -```bash -➜ apt-get install vim -E: Could not open lock file /var/lib/dpkg/lock - open (13: Permission denied) -E: Unable to lock the administration directory (/var/lib/dpkg/), are you root? +## Coverage Measurement -➜ fuck -sudo apt-get install vim [enter/↑/↓/ctrl+c] -[sudo] password for nvbn: -Reading package lists... Done -... -``` +- **Existing tool used to measure the coverage:** coverage.py +- **Coverage result:** 94% -```bash -➜ git push -fatal: The current branch master has no upstream branch. -To push the current branch and set the remote as upstream, use +![Coverage.py-Coverage-Measurement](/screenshots/coverage-py-2(2024-06-21_17-09-11).png) +![Coverage.py-Coverage-Measurement](/screenshots/coverage-py-1(21-06-2024_17-06-39).png) - git push --set-upstream origin master +## Tasks +### Luca De Nobili -➜ fuck -git push --set-upstream origin master [enter/↑/↓/ctrl+c] -Counting objects: 9, done. -... -``` +### Function 1 (property): in thefuck/types.py -```bash -➜ puthon -No command 'puthon' found, did you mean: - Command 'python' from package 'python-minimal' (main) - Command 'python' from package 'python3' (main) -zsh: command not found: puthon +#### 1. Function Instrumentation -➜ fuck -python [enter/↑/↓/ctrl+c] -Python 3.4.2 (default, Oct 8 2014, 13:08:17) -... -``` +- **Before instrumentation:** -```bash -➜ git brnch -git: 'brnch' is not a git command. See 'git --help'. +![Function1-BeforeInstrumentation](/screenshots/function_script_parts_before_instrumentation.png) -Did you mean this? - branch +- **After instrumentation:** -➜ fuck -git branch [enter/↑/↓/ctrl+c] -* master -``` +![Function1-AfterInstrumentation](/screenshots/initial_branch_coverage_script_parts.png) -```bash -➜ lein rpl -'rpl' is not a task. See 'lein help'. +#### 2. Coverage Improvement -Did you mean this? - repl +- **Coverage before adding new tests to the corresponding test file: /tests/test_types.py** -➜ fuck -lein repl [enter/↑/↓/ctrl+c] -nREPL server started on port 54848 on host 127.0.0.1 - nrepl://127.0.0.1:54848 -REPL-y 0.3.1 -... -``` +![Function1-CoverageBeforeImprov](/screenshots/initial_branch_coverage_script_parts.png) -If you're not afraid of blindly running corrected commands, the -`require_confirmation` [settings](#settings) option can be disabled: - -```bash -➜ apt-get install vim -E: Could not open lock file /var/lib/dpkg/lock - open (13: Permission denied) -E: Unable to lock the administration directory (/var/lib/dpkg/), are you root? - -➜ fuck -sudo apt-get install vim -[sudo] password for nvbn: -Reading package lists... Done -... -``` - -## Contents - -1. [Requirements](#requirements) -2. [Installations](#installation) -3. [Updating](#updating) -4. [How it works](#how-it-works) -5. [Creating your own rules](#creating-your-own-rules) -6. [Settings](#settings) -7. [Third party packages with rules](#third-party-packages-with-rules) -8. [Experimental instant mode](#experimental-instant-mode) -9. [Developing](#developing) -10. [License](#license-mit) - -## Requirements - -- python (3.5+) -- pip -- python-dev - -##### [Back to Contents](#contents) - -## Installation - -On macOS or Linux, you can install *The Fuck* via [Homebrew][homebrew]: - -```bash -brew install thefuck -``` - -On Ubuntu / Mint, install *The Fuck* with the following commands: -```bash -sudo apt update -sudo apt install python3-dev python3-pip python3-setuptools -pip3 install thefuck --user -``` - -On FreeBSD, install *The Fuck* with the following commands: -```bash -pkg install thefuck -``` - -On ChromeOS, install *The Fuck* using [chromebrew](https://github.com/skycocker/chromebrew) with the following command: -```bash -crew install thefuck -``` - -On Arch based systems, install *The Fuck* with the following command: -``` -sudo pacman -S thefuck -``` - -On other systems, install *The Fuck* by using `pip`: - -```bash -pip install thefuck -``` - -[Alternatively, you may use an OS package manager (OS X, Ubuntu, Arch).](https://github.com/nvbn/thefuck/wiki/Installation) - -# -It is recommended that you place this command in your `.bash_profile`, -`.bashrc`, `.zshrc` or other startup script: - -```bash -eval $(thefuck --alias) -# You can use whatever you want as an alias, like for Mondays: -eval $(thefuck --alias FUCK) -``` - -[Or in your shell config (Bash, Zsh, Fish, Powershell, tcsh).](https://github.com/nvbn/thefuck/wiki/Shell-aliases) - -Changes are only available in a new shell session. To make changes immediately -available, run `source ~/.bashrc` (or your shell config file like `.zshrc`). - -To run fixed commands without confirmation, use the `--yeah` option (or just `-y` for short, or `--hard` if you're especially frustrated): - -```bash -fuck --yeah -``` - -To fix commands recursively until succeeding, use the `-r` option: - -```bash -fuck -r -``` - -##### [Back to Contents](#contents) - -## Updating - -```bash -pip3 install thefuck --upgrade -``` - -**Note: Alias functionality was changed in v1.34 of *The Fuck*** - -## Uninstall - -To remove *The Fuck*, reverse the installation process: -- erase or comment *thefuck* alias line from your Bash, Zsh, Fish, Powershell, tcsh, ... shell config -- use your package manager (brew, pip3, pkg, crew, pip) to uninstall the binaries - -## How it works - -*The Fuck* attempts to match the previous command with a rule. If a match is -found, a new command is created using the matched rule and executed. The -following rules are enabled by default: - -* `adb_unknown_command` – fixes misspelled commands like `adb logcta`; -* `ag_literal` – adds `-Q` to `ag` when suggested; -* `aws_cli` – fixes misspelled commands like `aws dynamdb scan`; -* `az_cli` – fixes misspelled commands like `az providers`; -* `cargo` – runs `cargo build` instead of `cargo`; -* `cargo_no_command` – fixes wrong commands like `cargo buid`; -* `cat_dir` – replaces `cat` with `ls` when you try to `cat` a directory; -* `cd_correction` – spellchecks and corrects failed cd commands; -* `cd_cs` – changes `cs` to `cd`; -* `cd_mkdir` – creates directories before cd'ing into them; -* `cd_parent` – changes `cd..` to `cd ..`; -* `chmod_x` – adds execution bit; -* `choco_install` – appends common suffixes for chocolatey packages; -* `composer_not_command` – fixes composer command name; -* `conda_mistype` – fixes conda commands; -* `cp_create_destination` – creates a new directory when you attempt to `cp` or `mv` to a non-existent one -* `cp_omitting_directory` – adds `-a` when you `cp` directory; -* `cpp11` – adds missing `-std=c++11` to `g++` or `clang++`; -* `dirty_untar` – fixes `tar x` command that untarred in the current directory; -* `dirty_unzip` – fixes `unzip` command that unzipped in the current directory; -* `django_south_ghost` – adds `--delete-ghost-migrations` to failed because ghosts django south migration; -* `django_south_merge` – adds `--merge` to inconsistent django south migration; -* `docker_login` – executes a `docker login` and repeats the previous command; -* `docker_not_command` – fixes wrong docker commands like `docker tags`; -* `docker_image_being_used_by_container` ‐ removes the container that is using the image before removing the image; -* `dry` – fixes repetitions like `git git push`; -* `fab_command_not_found` – fixes misspelled fabric commands; -* `fix_alt_space` – replaces Alt+Space with Space character; -* `fix_file` – opens a file with an error in your `$EDITOR`; -* `gem_unknown_command` – fixes wrong `gem` commands; -* `git_add` – fixes *"pathspec 'foo' did not match any file(s) known to git."*; -* `git_add_force` – adds `--force` to `git add ...` when paths are .gitignore'd; -* `git_bisect_usage` – fixes `git bisect strt`, `git bisect goood`, `git bisect rset`, etc. when bisecting; -* `git_branch_delete` – changes `git branch -d` to `git branch -D`; -* `git_branch_delete_checked_out` – changes `git branch -d` to `git checkout master && git branch -D` when trying to delete a checked out branch; -* `git_branch_exists` – offers `git branch -d foo`, `git branch -D foo` or `git checkout foo` when creating a branch that already exists; -* `git_branch_list` – catches `git branch list` in place of `git branch` and removes created branch; -* `git_branch_0flag` – fixes commands such as `git branch 0v` and `git branch 0r` removing the created branch; -* `git_checkout` – fixes branch name or creates new branch; -* `git_clone_git_clone` – replaces `git clone git clone ...` with `git clone ...` -* `git_clone_missing` – adds `git clone` to URLs that appear to link to a git repository. -* `git_commit_add` – offers `git commit -a ...` or `git commit -p ...` after previous commit if it failed because nothing was staged; -* `git_commit_amend` – offers `git commit --amend` after previous commit; -* `git_commit_reset` – offers `git reset HEAD~` after previous commit; -* `git_diff_no_index` – adds `--no-index` to previous `git diff` on untracked files; -* `git_diff_staged` – adds `--staged` to previous `git diff` with unexpected output; -* `git_fix_stash` – fixes `git stash` commands (misspelled subcommand and missing `save`); -* `git_flag_after_filename` – fixes `fatal: bad flag '...' after filename` -* `git_help_aliased` – fixes `git help ` commands replacing with the aliased command; -* `git_hook_bypass` – adds `--no-verify` flag previous to `git am`, `git commit`, or `git push` command; -* `git_lfs_mistype` – fixes mistyped `git lfs ` commands; -* `git_main_master` – fixes incorrect branch name between `main` and `master` -* `git_merge` – adds remote to branch names; -* `git_merge_unrelated` – adds `--allow-unrelated-histories` when required -* `git_not_command` – fixes wrong git commands like `git brnch`; -* `git_pull` – sets upstream before executing previous `git pull`; -* `git_pull_clone` – clones instead of pulling when the repo does not exist; -* `git_pull_uncommitted_changes` – stashes changes before pulling and pops them afterwards; -* `git_push` – adds `--set-upstream origin $branch` to previous failed `git push`; -* `git_push_different_branch_names` – fixes pushes when local branch name does not match remote branch name; -* `git_push_pull` – runs `git pull` when `push` was rejected; -* `git_push_without_commits` – creates an initial commit if you forget and only `git add .`, when setting up a new project; -* `git_rebase_no_changes` – runs `git rebase --skip` instead of `git rebase --continue` when there are no changes; -* `git_remote_delete` – replaces `git remote delete remote_name` with `git remote remove remote_name`; -* `git_rm_local_modifications` – adds `-f` or `--cached` when you try to `rm` a locally modified file; -* `git_rm_recursive` – adds `-r` when you try to `rm` a directory; -* `git_rm_staged` – adds `-f` or `--cached` when you try to `rm` a file with staged changes -* `git_rebase_merge_dir` – offers `git rebase (--continue | --abort | --skip)` or removing the `.git/rebase-merge` dir when a rebase is in progress; -* `git_remote_seturl_add` – runs `git remote add` when `git remote set_url` on nonexistent remote; -* `git_stash` – stashes your local modifications before rebasing or switching branch; -* `git_stash_pop` – adds your local modifications before popping stash, then resets; -* `git_tag_force` – adds `--force` to `git tag ` when the tag already exists; -* `git_two_dashes` – adds a missing dash to commands like `git commit -amend` or `git rebase -continue`; -* `go_run` – appends `.go` extension when compiling/running Go programs; -* `go_unknown_command` – fixes wrong `go` commands, for example `go bulid`; -* `gradle_no_task` – fixes not found or ambiguous `gradle` task; -* `gradle_wrapper` – replaces `gradle` with `./gradlew`; -* `grep_arguments_order` – fixes `grep` arguments order for situations like `grep -lir . test`; -* `grep_recursive` – adds `-r` when you try to `grep` directory; -* `grunt_task_not_found` – fixes misspelled `grunt` commands; -* `gulp_not_task` – fixes misspelled `gulp` tasks; -* `has_exists_script` – prepends `./` when script/binary exists; -* `heroku_multiple_apps` – adds `--app ` to `heroku` commands like `heroku pg`; -* `heroku_not_command` – fixes wrong `heroku` commands like `heroku log`; -* `history` – tries to replace command with the most similar command from history; -* `hostscli` – tries to fix `hostscli` usage; -* `ifconfig_device_not_found` – fixes wrong device names like `wlan0` to `wlp2s0`; -* `java` – removes `.java` extension when running Java programs; -* `javac` – appends missing `.java` when compiling Java files; -* `lein_not_task` – fixes wrong `lein` tasks like `lein rpl`; -* `long_form_help` – changes `-h` to `--help` when the short form version is not supported -* `ln_no_hard_link` – catches hard link creation on directories, suggest symbolic link; -* `ln_s_order` – fixes `ln -s` arguments order; -* `ls_all` – adds `-A` to `ls` when output is empty; -* `ls_lah` – adds `-lah` to `ls`; -* `man` – changes manual section; -* `man_no_space` – fixes man commands without spaces, for example `mandiff`; -* `mercurial` – fixes wrong `hg` commands; -* `missing_space_before_subcommand` – fixes command with missing space like `npminstall`; -* `mkdir_p` – adds `-p` when you try to create a directory without a parent; -* `mvn_no_command` – adds `clean package` to `mvn`; -* `mvn_unknown_lifecycle_phase` – fixes misspelled life cycle phases with `mvn`; -* `npm_missing_script` – fixes `npm` custom script name in `npm run-script