Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Indentation Error with Sublime Text

I'm trying to use the auto-indentation feature in Sublime Text 3 for HTML. I've got some block comments in the html and selecting Edit>Line>Reindent works until it hits a block comment.

Try to reindent the example here:

<html>
<head>
<title>Testing Indent</title>
</head>
<body>
<table>
<tr>
<td>
Cell 1
</td>
</tr>
<tr>
Cell 2
<!--Block Comment Here
And a Little More Here
-->
</tr>
</table>
</body>
</html>

and it turns out like this:

<html>
<head>
    <title>Testing Indent</title>
</head>
<body>
    <table>
        <tr>
            <td>
                Cell 1
            </td>
        </tr>
        <tr>
            <td>
                Cell 2
<!--Block Comment Here
And a Little More Here
-->
</td>
</tr>
</table>
</body>
</html>

Any thoughts?

like image 355
Mike_Piercy Avatar asked Jul 07 '16 14:07

Mike_Piercy


People also ask

How do I fix an indentation error in Sublime Text?

To solve, click on the "Tab Size" at the bottom of the editor, and choose "Convert Indentation to Tabs". Show activity on this post. You start using a text editor that allows you to show indents, and you become consistent about using spaces instead of tabs, and you enforce that in your editor. Yeah.. you're right.

How do I change the indentation in Sublime Text?

Changing indentation for the current bufferIndentation settings are available from the View/Indentation menu. Selections made here are applied to the current buffer only.

How do I fix my indentation?

Go to Home and select Line and Paragraph Spacing > Line Spacing Options at the bottom of the menu. The Paragraph dialog box opens. On the Indents and Spacing tab, select the options you want, and click OK. The Paragraph dialog box options are described in Adjust indents and spacing.

What is indenting error?

The indentation error can occur when the spaces or tabs are not placed properly. There will not be an issue if the interpreter does not find any issues with the spaces or tabs. If there is an error due to indentation, it will come in between the execution and can be a show stopper.


1 Answers

I have logged the issue here: https://github.com/SublimeTextIssues/Core/issues/1271

The reason for this behavior is because Sublime Text, by default, is set to preserve the indentation of comments. To disable this:

  1. Install Package Control if it is not already installed
  2. Install PackageResourceViewer if it is not already installed:
    • Open the Command Palette
    • Select Package Control: Install Package
    • Select PackageResourceViewer
  3. Open the Command Palette
  4. Type PRV: O
  5. Select PackageResourceViewer: Open Resource
  6. Select Default
  7. Select Indentation Rules - Comments.tmPreferences
  8. Change the <true/> under <key>preserveIndent</key> to <false/>
  9. Save the file

Reindentation will now work correctly with comments.


I would also recommend to edit the HTML indentation rules to ignore comments, so that it doesn't change indentation based on tags in comments. i.e. otherwise

<html>
<head>
<title>Testing Indent</title>
</head>
<body>
<table>
<tr>
<td>
Cell 1
</td>
</tr>
<tr>
Cell 2
<!--
Block Comment Here
<td>
And a Little More Here
</td>
-->
</tr>
</table>
</body>
</html>

would become:

<html>
<head>
    <title>Testing Indent</title>
</head>
<body>
    <table>
        <tr>
            <td>
                Cell 1
            </td>
        </tr>
        <tr>
            Cell 2
            <!--
            Block Comment Here
            <td>
                And a Little More Here
            </td>
        -->
    </tr>
</table>
</body>
</html>

To do this:

  1. Open Command Palette
  2. Type PRV: O
  3. Select PackageResourceViewer: Open Resource
  4. Select HTML
  5. Select Miscellaneous.tmPreferences
  6. Change

    <key>scope</key>
    <string>text.html</string>
    

    to

    <key>scope</key>
    <string>text.html - comment</string>
    

    and

    |--&gt;
    

    to

    (?#|--&gt;)
    

    (this comments out the closing comment regex)

  7. Save it

However, when the next release of ST3 is available, it might be a good idea to then delete your overrides, in case it is fixed properly. This way, you will continue to get updates to these files, otherwise you will be stuck with the versions you have saved. To do this:

  1. Preferences -> Browse Packages
  2. Delete the HTML folder
  3. Go into the Default folder and delete the Indentation Rules - Comments.tmPreferences file

If the problem wasn't fixed in the next build, you can simply recreate these changes.

like image 129
Keith Hall Avatar answered Sep 28 '22 12:09

Keith Hall