Merge branch 'v6'

Author: mo8it

.all-contributorsrc

@@ -1,18 +1,23 @@
-*.swp
+# Cargo
 target/
-**/*.rs.bk
+Cargo.lock
+!/Cargo.lock
+
+# State file
+.rustlings-state.txt
+
+# oranda
+public/
+.netlify
+
+# OS
 .DS_Store
-*.pdb
-exercises/22_clippy/Cargo.toml
-exercises/22_clippy/Cargo.lock
-rust-project.json
+.direnv/
+
+# Editor
+*.swp
 .idea
-.vscode/*
-!.vscode/extensions.json
 *.iml
-*.o
-public/
-.direnv/
 
-# Local Netlify folder
-.netlify
+# Ignore file for editors like Helix
+.ignore

.devcontainer/devcontainer.json

@@ -0,0 +1,7 @@
+[files]
+extend-exclude = [
+  "CHANGELOG.md",
+]
+
+[default.extend-words]
+"ratatui" = "ratatui"

.gitattributes

@@ -1,4 +1,72 @@
+<a name="6.0.0"></a>
+
+## 6.0.0 (2024-07-03)
+
+This release is the result of a complete rewrite to deliver a ton of new features and improvements ✨
+The most important changes are highlighted below.
+
+### Installation
+
+The installation has been simplified a lot!
+To install Rustlings after installing Rust, all what you need to do now is running the following command:
+
+```bash
+cargo install rustlings
+```
+
+Yes, this means that Rustlings is now on [crates.io](https://crates.io/crates/rustlings) 🎉
+
+You can read about the motivations of this change in [this issue](https://github.com/rust-lang/rustlings/issues/1919).
+
+### UI/UX
+
+- The UI is now responsive when the terminal is resized.
+- The progress bar was moved to the bottom so that you can always see your progress and the current exercise to work on.
+- The current exercise path is now a terminal link. It will open the exercise file in your default editor when you click on it.
+- A small prompt is now always shown at the bottom. It allows you to choose an action by entering a character. For example, entering `h` will show you the hint of the current exercise.
+- The comment "I AM NOT DONE!" doesn't exist anymore. Instead of needing to remove it to go to the next exercise, you need to enter `n` in the terminal.
+
+### List mode
+
+A list mode was added using [Ratatui](https://ratatui.rs).
+You can enter it by entering `l` in the watch mode.
+It offers the following features:
+
+- Browse all exercises and see their state (pending/done).
+- Filter exercises based on their state (pending/done).
+- Continue at another exercise. This allows you to skip some exercises or go back to previous ones.
+- Reset an exercise so you can start over and revert your changes.
+
+### Solutions
+
+After finishing an exercise, a solution file will be available and Rustlings will show you its path in green.
+This allows you to compare your solution with an idiomatic solution and maybe learn about other ways to solve a problem.
+
+While writing the solutions, all exercises have been polished 🌟
+For example, every exercise now contains `TODO` comments to highlight what the user needs to change and where.
+
+### LSP support out of the box
+
+Instead of creating a `project.json` file using `rustlings lsp`, Rustlings now works with a `Cargo.toml` file out of the box.
+No actions are needed to activate the language server `rust-analyzer`.
+
+This should avoid issues related to the language server or to running exercises, especially the ones with Clippy.
+
+### Clippy
+
+Clippy lints are now shown on all exercises, not only the Clippy exercises 📎
+Make Clippy your friend from early on 🥰
+
+### Third party exercises
+
+Rustlings now supports third-party exercises!
+
+Do you want to create your own set of Rustlings exercises to focus on some specific topic?
+Or do you want to translate the original Rustlings exercises?
+Then follow the link to the guide about [third-party exercises](THIRD_PARTY_EXERCISES.md)!
+
 <a name="5.6.1"></a>
+
 ## 5.6.1 (2023-09-18)
 
 #### Changed
@@ -15,6 +83,7 @@
 - `enums3`: Fixed formatting with `rustfmt`.
 
 <a name="5.6.0"></a>
+
 ## 5.6.0 (2023-09-04)
 
 #### Added
@@ -30,7 +99,7 @@
 - Swapped the order of threads and smart pointer exercises.
 - Rewrote the CLI to use `clap` - it's matured much since we switched to `argh` :)
 - `structs3`: Switched from i32 to u32.
-- `move_semantics`: Switched 1-4 to tests, and rewrote them to be way simpler, while still teaching about the same 
+- `move_semantics`: Switched 1-4 to tests, and rewrote them to be way simpler, while still teaching about the same
   concepts.
 
 #### Fixed
@@ -55,13 +124,15 @@
 - Improved CI workflows, we're now testing on multiple platforms at once.
 
 <a name="5.5.1"></a>
+
 ## 5.5.1 (2023-05-17)
 
 #### Fixed
 
 - Reverted `rust-project.json` path generation due to an upstream `rust-analyzer` fix.
 
 <a name="5.5.0"></a>
+
 ## 5.5.0 (2023-05-17)
 
 #### Added
@@ -97,6 +168,7 @@
 - Split quick installation section into two code blocks
 
 <a name="5.4.1"></a>
+
 ## 5.4.1 (2023-03-10)
 
 #### Changed

.gitignore

@@ -1,129 +1,61 @@
-## Contributing to Rustlings
+# Contributing to Rustlings
 
-First off, thanks for taking the time to contribute!! ❤️
+First off, thanks for taking the time to contribute! ❤️
 
-### Quick Reference
+## Quick Reference
 
-I want to...
+I want to …
 
-_add an exercise! ➡️ [read this](#addex) and then [open a Pull Request](#prs)_
+- _report a bug!_ ➡️ [open an issue](#issues)
+- _fix a bug!_ ➡️ [open a pull request](#pull-requests)
+- _implement a new feature!_ ➡️ [open an issue to discuss it first, then a pull request](#issues)
+- _add an exercise!_ ➡️ [read this](#adding-an-exercise)
+- _update an outdated exercise!_ ➡️ [open a pull request](#pull-requests)
 
-_update an outdated exercise! ➡️ [open a Pull Request](#prs)_
-
-_report a bug! ➡️ [open an Issue](#issues)_
-
-_fix a bug! ➡️ [open a Pull Request](#prs)_
-
-_implement a new feature! ➡️ [open an Issue to discuss it first, then a Pull Request](#issues)_
-
-<a name="#src"></a>
-### Working on the source code
-
-`rustlings` is basically a glorified `rustc` wrapper. Therefore the source code
-isn't really that complicated since the bulk of the work is done by `rustc`.
-
-<a name="addex"></a>
-### Adding an exercise
-
-The first step is to add the exercise! Name the file `exercises/yourTopic/yourTopicN.rs`, make sure to
-put in some helpful links, and link to sections of the book in `exercises/yourTopic/README.md`.
-
-Next make sure it runs with `rustlings`. The exercise metadata is stored in `info.toml`, under the `exercises` array. The order of the `exercises` array determines the order the exercises are run by `rustlings verify` and `rustlings watch`.
-
-Add the metadata for your exercise in the correct order in the `exercises` array. If you are unsure of the correct ordering, add it at the bottom and ask in your pull request. The exercise metadata should contain the following:
-```diff
-  ...
-+ [[exercises]]
-+ name = "yourTopicN"
-+ path = "exercises/yourTopic/yourTopicN.rs"
-+ mode = "compile"
-+ hint = """
-+ Some kind of useful hint for your exercise."""
-  ...
-```
-
-The `mode` attribute decides whether Rustlings will only compile your exercise, or compile and test it. If you have tests to verify in your exercise, choose `test`, otherwise `compile`. If you're working on a Clippy exercise, use `mode = "clippy"`.
-
-That's all! Feel free to put up a pull request.
-
-<a name="issues"></a>
-### Issues
+## Issues
 
 You can open an issue [here](https://github.com/rust-lang/rustlings/issues/new).
 If you're reporting a bug, please include the output of the following commands:
 
-- `rustc --version`
+- `cargo --version`
 - `rustlings --version`
 - `ls -la`
 - Your OS name and version
 
-<a name="prs"></a>
-### Pull Requests
-
-Opening a pull request is as easy as forking the repository and committing your
-changes. There's a couple of things to watch out for:
-
-#### Write correct commit messages
-
-We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
-specification.
-This means that you have to format your commit messages in a specific way. Say
-you're working on adding a new exercise called `foobar1.rs`. You could write
-the following commit message:
-
-```
-feat: add foobar1.rs exercise
-```
+## Pull Requests
 
-If you're just fixing a bug, please use the `fix` type:
+You are welcome to open a pull request, but unless it is small and trivial, **please open an issue to discuss your idea first** 🙏🏼
 
-```
-fix(verify): make sure verify doesn't self-destruct
-```
+Opening a pull request is as easy as forking the repository and committing your changes.
+If you need any help with it or face any Git related problems, don't hesitate to ask for help 🤗
 
-The scope within the brackets is optional, but should be any of these:
+It may take time to review your pull request.
+Please be patient 😇
 
-- `installation` (for the installation script)
-- `cli` (for general CLI changes)
-- `verify` (for the verification source file)
-- `watch` (for the watch functionality source)
-- `run` (for the run functionality source)
-- `EXERCISENAME` (if you're changing a specific exercise, or set of exercises,
-  substitute them here)
+When updating an exercise, check if its solution needs to be updated.
 
-When the commit also happens to close an existing issue, link it in the message
-body:
+## Adding An Exercise
 
-```
-fix: update foobar
+- Name the file `exercises/yourTopic/yourTopicN.rs`.
+- Make sure to put in some helpful links, and link to sections of The Book in `exercises/yourTopic/README.md`.
+- In the exercise, add a `// TODO: …` comment where user changes are required.
+- Add a solution at `solutions/yourTopic/yourTopicN.rs` with comments explaining it.
+- Add the [metadata for your exercise](#exercise-metadata) in the `rustlings-macros/info.toml` file.
+- Make sure your exercise runs with `rustlings run yourTopicN`.
+- [Open a pull request](#pull-requests).
 
-closes #101029908
-```
+### Exercise Metadata
 
-If you're doing simple changes, like updating a book link, use `chore`:
+The exercise metadata should contain the following:
 
+```toml
+[[exercises]]
+name = "yourTopicN"
+dir = "yourTopic"
+hint = """
+A useful (multi-line) hint for your exercise.
+Include links to a section in The Book or a documentation page."""
 ```
-chore: update exercise1.rs book link
-```
-
-If you're updating documentation, use `docs`:
-
-```
-docs: add more information to Readme
-```
-
-If, and only if, you're absolutely sure you want to make a breaking change
-(please discuss this beforehand!), add an exclamation mark to the type and
-explain the breaking change in the message body:
-
-```
-fix!: completely change verification
-
-BREAKING CHANGE: This has to be done because lorem ipsum dolor
-```
-
-#### Pull Request Workflow
 
-Once you open a Pull Request, it may be reviewed or labeled (or both) until
-the maintainers accept your change. Please be patient, it may take some time
-for this to happen!
+If your exercise doesn't contain any test, add `test = false` to the exercise metadata.
+But adding tests is recommended.