diff --git a/README.md b/README.md new file mode 100644 index 0000000..7e45ec3 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# Arcanist: A VSCode Extension + +An extension for getting some of [Phabricator/Arcanist](https://phacility.com/phabricator/) +features integrated with Visual Studio Code. + + +## Features + +- Show arc-lint notes in editor +![arc lint](images/lint.png) +- Recognize Arcanist files as JSON + + +## Requirements + +This extension requires Arcanist to be installed and configured for the +directory you work in; `arc` and all your linters should be in the PATH for vscode +to be able to run them. \ +Only reasonably recent versions of Arcanist are supported. + + +## Known Issues + +* Lints do not update as you type - you must save a file for changes to take + effect. Lints also might drift when making large changes. +* Most lints only show up as 3-characters-squiggle, which is hard to see. + We suggest users install the `usernamehw.errorlens` extension. + + +## Disclaimers + +This extension is not affiliated with, nor is it supported by, +[Phacility](https://phacility.com/) or the Phabricator project. +All trademarks are property of their respective owners. diff --git a/RELATED b/RELATED index 57e3f02..fb5186c 100644 --- a/RELATED +++ b/RELATED @@ -1,21 +1,21 @@ Related: - https://marketplace.visualstudio.com/items?itemName=jdxcode.arcanist-vscode - Format file by arc-lint - Last update 11-2019 - https://marketplace.visualstudio.com/items?itemName=christianvuerings.vscode-phabricator - - 💬 Autocomplete users and projects - - 🗒️ List accepted diffs with build status - - 🔔 Notify about ready to land diffs + - Autocomplete users and projects + - List accepted diffs with build status + - Notify about ready to land diffs - Good as editor for arc-diff message - - 03-2020 + - Last update 07-2020 - has icon - https://marketplace.visualstudio.com/items?itemName=PranaySingh.phabview - generate diffusion link, copy to clipboard - - 02-2020 + - Last update 02-2020 - https://marketplace.visualstudio.com/items?itemName=mezzode.arc-browse - runs arc browse ? - - 02-2019 + - Last update 02-2019 - has icon - https://marketplace.visualstudio.com/items?itemName=matt-good.phabricator-links - converts `T1234`, etc., to a hyperlink - - 03-2018 + - Last update 03-2018 diff --git a/TODO b/TODO index de9086d..25cfcf6 100644 --- a/TODO +++ b/TODO @@ -1,20 +1,19 @@ TODO ==== - lint everything Long Term Desired Features ========================== - Fancy UIs for - - arc patch - - arc todo - - arc unit + - quick create task (arc todo) + - arc unit (show results in vscode-native way) - arc browse - arc paste (upload and download) - list open Differential in repo (for review) - get hovercard (content) for any object -- push notifications from website ? +- push notifications from website? - preview Remarkup - some magic to help the External Editor Link - arc lint: special-case some messages for better visibility (find more range/information.) - arc lint: support auto-fix (apply diff) - arc lint: `locations` field may be parsed into `relatedInformation`.