Merge branch '5.0-dev'

Author: manyinsects

.github/workflows/rust.yml

@@ -0,0 +1,20 @@
+name: Rustlings Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Build
+      run: cargo build --verbose
+    - name: Run tests
+      run: cargo test --verbose

.gitignore

@@ -9,3 +9,4 @@ rust-project.json
 .idea
 .vscode
 *.iml
+*.o

CONTRIBUTING.md

@@ -21,15 +21,15 @@ _implement a new feature! ➡️ [open an Issue to discuss it first, then a Pull
 
 `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`.
-`src/main.rs` contains a simple `clap` CLI that loads from `src/verify.rs` and `src/run.rs`.
+`src/main.rs` contains a simple `argh` CLI that connects to most of the other source files.
 
 <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`.
+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
@@ -43,7 +43,7 @@ Add the metadata for your exercise in the correct order in the `exercises` array
   ...
 ```
 
-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`.
+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.
 
@@ -67,19 +67,19 @@ 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-beta.4/)
-specification, because it makes it easier to generate changelogs automatically.
+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
+feat: add foobar1.rs exercise
 ```
 
 If you're just fixing a bug, please use the `fix` type:
 
 ```
-fix(verify): Make sure verify doesn't self-destruct
+fix(verify): make sure verify doesn't self-destruct
 ```
 
 The scope within the brackets is optional, but should be any of these:
@@ -96,36 +96,35 @@ When the commit also happens to close an existing issue, link it in the message
 body:
 
 ```
-fix: Update foobar
+fix: update foobar
 
 closes #101029908
 ```
 
 If you're doing simple changes, like updating a book link, use `chore`:
 
 ```
-chore: Update exercise1.rs book link
+chore: update exercise1.rs book link
 ```
 
 If you're updating documentation, use `docs`:
 
 ```
-docs: Add more information to Readme
+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
+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. Then, [bors](https://github.com/bors) will
-run the test suite with your changes and if it's successful, automatically
-merge it in!
+the maintainers accept your change. Please be patient, it may take some time
+for this to happen!

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 name = "rustlings"
 version = "4.8.0"
-authors = ["mokou <mokou@fastmail.com>", "Carol (Nichols || Goulding) <carol.nichols@gmail.com>"]
+authors = ["Liv <mokou@fastmail.com>", "Carol (Nichols || Goulding) <carol.nichols@gmail.com>"]
 edition = "2021"
 
 [dependencies]
@@ -24,6 +24,3 @@ path = "src/main.rs"
 assert_cmd = "0.11.0"
 predicates = "1.0.1"
 glob = "0.3.0"
-
-[features]
-exercises = []

Cargo.toml

@@ -44,9 +44,9 @@ Start-BitsTransfer -Source https://raw.githubusercontent.com/rust-lang/rustlings
 
 To install Rustlings. Same as on MacOS/Linux, you will have access to the `rustlings` command after it.
 
-When you get a permission denied message then you have to exclude the directory where you placed the rustlings in your virus-scanner
+If you get a permission denied message, you might have to exclude the directory where you cloned Rustlings in your antivirus.
 
-## Browser:
+## Browser
 
 [Run on Repl.it](https://repl.it/github/rust-lang/rustlings)
 
@@ -150,24 +150,6 @@ cargo uninstall rustlings
 
 Now you should be done!
 
-## Completion
-
-Rustlings isn't done; there are a couple of sections that are very experimental and don't have proper documentation. These include:
-
-- Errors (`exercises/errors/`)
-- Option (`exercises/option/`)
-- Result (`exercises/result/`)
-- Move Semantics (could still be improved, `exercises/move_semantics/`)
-
-Additionally, we could use exercises on a couple of topics:
-
-- Structs
-- Better ownership stuff
-- `impl`
-- ??? probably more
-
-If you are interested in improving or adding new ones, please feel free to contribute! Read on for more information :)
-
 ## Contributing
 
 See [CONTRIBUTING.md](./CONTRIBUTING.md).