From edf614f364d75da52ae36ba19495eae0b703a081 Mon Sep 17 00:00:00 2001 From: sagie gur ari Date: Tue, 30 Nov 2021 18:35:42 +0000 Subject: [PATCH] changelog and few vscode documentation changes --- CHANGELOG.md | 1 + README.md | 19 +++++++------------ docs/_includes/content.md | 17 +++++------------ docs/_includes/nav.md | 2 ++ docs/vscode-example/tasks.json | 29 ++++++++++------------------- 5 files changed, 25 insertions(+), 43 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index dd483039..5e326e83 100755 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ * Fix: crate installation version check now also supports running the binary with --version arg #612 * Enhancement: support alternate cargo install commands #608 +* Documentation: VS code editor integration #604 (thanks @grbd) ### v0.35.6 (2021-11-01) diff --git a/README.md b/README.md index 0d8dc618..ca47746f 100644 --- a/README.md +++ b/README.md @@ -113,6 +113,8 @@ * [Badge](#badge) * [Roadmap](#roadmap) * [Editor Support](#editor-support) + * [vim](#editor-support-vim) + * [vs-code](#editor-support-vs-code) * [Contributing](.github/CONTRIBUTING.md) * [Release History](https://github.com/sagiegurari/cargo-make/blob/master/CHANGELOG.md) * [License](#license) @@ -3491,13 +3493,16 @@ You can view the future development items list in the [github project issues](ht ## Editor Support + ### Vim -* Vim: [vim-cargo-make](https://github.com/nastevens/vim-cargo-make) +* [vim-cargo-make](https://github.com/nastevens/vim-cargo-make) +* [vim-duckscript](https://github.com/nastevens/vim-duckscript) + ### VSCode -For debugging purposes there are some example .vscode files located within the [docs/vscode-example](./docs/vscode-example) directory +For debugging purposes there are some example .vscode files located within the [docs/vscode-example](./docs/vscode-example/) directory You may also need: @@ -3507,16 +3512,6 @@ You may also need: * VSCode Extension - "Task Explorer" * VSCode Extension - "crates" -### Rust Format - -After making changes to the code, rustfmt can be used to automatically reformat the code within the repository -``` -# To install -rustup component add rustfmt -# To run on the cargo project -cargo fmt -``` - ## Contributing See [contributing guide](.github/CONTRIBUTING.md) diff --git a/docs/_includes/content.md b/docs/_includes/content.md index 41dd3015..1a39e024 100755 --- a/docs/_includes/content.md +++ b/docs/_includes/content.md @@ -3373,13 +3373,16 @@ You can view the future development items list in the [github project issues](ht ## Editor Support + ### Vim -* Vim: [vim-cargo-make](https://github.com/nastevens/vim-cargo-make) +* [vim-cargo-make](https://github.com/nastevens/vim-cargo-make) +* [vim-duckscript](https://github.com/nastevens/vim-duckscript) + ### VSCode -For debugging purposes there are some example .vscode files located within the [docs/vscode-example](./docs/vscode-example) directory +For debugging purposes there are some example .vscode files located within the [docs/vscode-example](./docs/vscode-example/) directory You may also need: @@ -3389,16 +3392,6 @@ You may also need: * VSCode Extension - "Task Explorer" * VSCode Extension - "crates" -### Rust Format - -After making changes to the code, rustfmt can be used to automatically reformat the code within the repository -``` -# To install -rustup component add rustfmt -# To run on the cargo project -cargo fmt -``` - ## Contributing See [contributing guide](https://github.com/sagiegurari/cargo-make/blob/master/.github/CONTRIBUTING.md) diff --git a/docs/_includes/nav.md b/docs/_includes/nav.md index 1999d0e3..06114680 100755 --- a/docs/_includes/nav.md +++ b/docs/_includes/nav.md @@ -102,6 +102,8 @@ * [Badge](#badge) * [Roadmap](#roadmap) * [Editor Support](#editor-support) + * [vim](#editor-support-vim) + * [vs-code](#editor-support-vs-code) * [Contributing](https://github.com/sagiegurari/cargo-make/blob/master/.github/CONTRIBUTING.md) * [Release History](https://github.com/sagiegurari/cargo-make/blob/master/CHANGELOG.md) * [License](#license) diff --git a/docs/vscode-example/tasks.json b/docs/vscode-example/tasks.json index 21db2f6a..db9b9895 100644 --- a/docs/vscode-example/tasks.json +++ b/docs/vscode-example/tasks.json @@ -2,8 +2,8 @@ "version": "2.0.0", "tasks": [ { - "label": "build debug", - "detail": "Build in debug mode", + "label": "Build", + "detail": "Build the rust project", "type": "process", "group": "build", "command": "cargo", @@ -13,18 +13,7 @@ ] }, { - "label": "build release", - "detail": "Build in release mode", - "type": "process", - "group": "build", - "command": "cargo", - "args": [ - "make", - "build-release" - ] - }, - { - "label": "clean", + "label": "Clean", "detail": "Clean the target build directory", "type": "process", "group": "build", @@ -35,24 +24,26 @@ ] }, { - "label": "rust format", + "label": "Format", "detail": "Auto format the code", "type": "process", "group": "build", "command": "cargo", "args": [ - "fmt" + "make", + "format-flow" ] }, { - "label": "run the tests", + "label": "Test", "detail": "Run the tests", "type": "process", "group": "build", "command": "cargo", "args": [ - "test" + "make", + "test-flow" ] }, ], -} \ No newline at end of file +}