Skip to content

Edited Indentation Options #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Edited Indentation Options #49

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 91 additions & 9 deletions docs/reference/metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,37 +175,77 @@ Indentation options control aspects of the auto-indentation mechanism.
`increaseIndentPattern`
: *Regex.*
If it matches on the current line,
the next line will be indented one level further.
lines after current line will be indented one level further.

If in `.tmPreferences`:

```xml
<key>increaseIndentPattern</key>
<string>insert regex here</string>
<string><![CDATA[^\s*increase$]]></string>
```

Then in `view`:

```
line1
line2
increase
after increase1
after increase2
```

`decreaseIndentPattern`
: *Regex.*
If it matches on the current line,
the next line will be unindented one level.
current line and lines after current line will be unindented one level.

If in `.tmPreferences`:

```xml
<key>decreaseIndentPattern</key>
<string>insert regex here</string>
<string><![CDATA[^\s*decrease$]]></string>
```

Then in `view`:

```
line1
line2
decrease
after decrease1
after decrease2
```

`bracketIndentNextLinePattern`
: *Regex.*
If it matches on the current line,
only the next line will be indented one level further.
only the next non-whitespace line will be indented one level further.

If in `.tmPreferences`:

```xml
<key>bracketIndentNextLinePattern</key>
<string>insert regex here</string>
<string><![CDATA[^\s*bracket$]]></string>
```

Then in `view`:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not convinced "view" needs to be backtick-quoted here. It might be better to say something like "Then, in a buffer for which this tmPreferences file is active", though I agree that is a bit of a verbose mouthful.


```
line1
line2
line3
bracket

first non-whitespace line after bracket
after bracket2
after bracket3
```

`disableIndentNextLinePattern`
: *Regex.*
If it matches on the current line,
the next line will not be indented further.
Deprecated in ST3, use unIndentedLinePattern instead.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not deprecated as far as I understand, unIndentedLinePattern means the line doesn't affect the indentation calculation of other lines, but disableIndentNextLinePattern specifically disables just the bracketIndentNextLinePattern indentation. This is so that an if statement for example without a curly brace will indent the next line, but that indentation will be cancelled when typing {.


```xml
<key>disableIndentNextLinePattern</key>
Expand All @@ -214,15 +254,57 @@ Indentation options control aspects of the auto-indentation mechanism.

`unIndentedLinePattern`
: *Regex.*
If the `increaseIndentPattern` and/or `decreaseIndentPattern` *Regex.* also matches on the current line.
The auto-indenter will ignore
lines matching this regex
when computing the next line's indentation level.
the effects made by `increaseIndentPattern` and/or `decreaseIndentPattern`
when computing the indentation level of lines after current line.

If in `.tmPreferences`:

```xml
<key>increaseIndentPattern</key>
<string><![CDATA[^\s*[A-z]+]]></string>
<key>unIndentedLinePattern</key>
<string>insert regex here</string>
<string><![CDATA[^\s*unindented$]]></string>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess for the examples below to work, the $ anchor would have to be removed?

```

Then in `view`:

```xml
lineone only match increaseIndentPattern's Regex effects made
after lineone1
after lineone2
linetwo only match increaseIndentPattern's Regex effects made
after linetwo1
after linetwo2
unindented both match increaseIndentPattern and unIndentedLinePattern's Regex effects ignored
after unindented1
after unindented2
```

If in `.tmPreferences`:

```xml
<key>decreaseIndentPattern</key>
<string><![CDATA[^\s*[A-z]+]]></string>
<key>unIndentedLinePattern</key>
<string><![CDATA[^\s*unindented$]]></string>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here presumably

```

Then in `view`:

```xml
0START0
lineone only match decreaseIndentPattern's Regex effects made
after lineone1
after lineone2
linetwo only match decreaseIndentPattern's Regex effects made
after linetwo1
after linetwo2
unindented both match decreaseIndentPattern and unIndentedLinePattern's Regex effects ignored
after unindented1
after unindented2
```

### Completions Options

Expand Down