|
1 | 1 | # Code Alignment for Visual Studio Code |
2 | | - |
3 | 2 | Port of the C# Code base to TypeScript |
4 | 3 |
|
5 | | -This is Version 1. The plan is to release early and release often, so it is missing many of the best features but the plan is for them to be added in time. |
| 4 | +Code alignment is the practice of formatting your code vertically to improve readability. |
| 5 | + |
| 6 | +Based on principles borrowed from mathematics and other disciplines, code alignment gives extra meaning to your code by lining up similar data in columns. This is something we do naturally when working with tables and spreadsheets, but unfortunately it doesn't get applied to code often enough. |
| 7 | + |
| 8 | +The usual excuses are, "It's too hard. It takes too long. They don't pay me enough." With this extension, these excuses are no longer valid. |
| 9 | + |
| 10 | +##Current State |
| 11 | +Many of Code alignment's best features are currently missing. The plan is to release early and release often, and to eventually reach parity. |
6 | 12 |
|
7 | 13 | Main code alignment repository: https://github.com/cpmcgrath/codealignment |
| 14 | + |
8 | 15 | Build Server: https://ci.appveyor.com/project/cpmcgrath/codealignment-vscode |
9 | 16 |
|
10 | 17 | ## How to use |
11 | | - |
12 | | -This is still in development. It is currently only exposed through a single test command. |
13 | | - |
14 | 18 | To use: |
15 | 19 | * Open a file with some lines |
16 | 20 | * Select the lines which you want to align (Or use Auto scope selection) |
17 | | -* Press F1 and type 'Code Alignment' to bring up options. |
18 | | - |
19 | | -### Future features |
20 | | -- [ ] Remember history |
21 | | -- [ ] Allow Alignments from Caret Position |
22 | | -- [ ] Allow Alignments to use Complex Regex |
23 | | -- [ ] Expose Align by Space - This is the biggest missing feature from Version 1 as it's the alignment I use 90% of the time. However, it needs complex regexes to work, otherwise I'd have to fill the code base with hacks. |
24 | | -- [ ] Allow Alignments to be chained |
25 | | -- [ ] Introduce the XML Automatic scope selection for XML-like content type |
26 | | -- [ ] Expose Options (including Shortcut functions) - In terms of scope for version 1, once I realised I didn't have to deliver this, it clarified exactly what the scope for version 1 was |
27 | | - |
28 | | -## Atom |
29 | | -Before a lot of the Future Features are implemented, I'd like to get the extension working for the Atom editor as well. The primary reason is I don't think I've got the repository structure correct yet, and having the 2 different plugins will make sure I've got it correct. |
| 21 | +* Press F1 and type 'Code Alignment' to bring up options. |
0 commit comments