Adding base indentation for script block formatting and smart indent

jramsay · jramsay · commit 218a5ba0bb9f · 2016-06-17T13:02:15.000-07:00
diff --git a/src/harness/fourslash.ts b/src/harness/fourslash.ts
@@ -310,6 +310,7 @@ namespace FourSlash {
             }
 
             this.formatCodeOptions = {
+                BaseIndentSize: 0,
                 IndentSize: 4,
                 TabSize: 4,
                 NewLineCharacter: Harness.IO.newLine(),
diff --git a/src/server/editorServices.ts b/src/server/editorServices.ts
@@ -1389,6 +1389,7 @@ namespace ts.server {
 
         static getDefaultFormatCodeOptions(host: ServerHost): ts.FormatCodeOptions {
             return ts.clone({
+                BaseIndentSize: 0,
                 IndentSize: 4,
                 TabSize: 4,
                 NewLineCharacter: host.newLine || "\n",
diff --git a/src/server/protocol.d.ts b/src/server/protocol.d.ts
@@ -434,6 +434,9 @@ declare namespace ts.server.protocol {
         /** Number of spaces to indent during formatting. Default value is 4. */
         indentSize?: number;
 
+        /** Number of additional spaces to indent during formatting to preserve base indentation (ex. script block indentation). Default value is 0. */
+        baseIndentSize?: number;
+
         /** The new line character to be used. Default value is the OS line delimiter. */
         newLineCharacter?: string;
 
@@ -474,7 +477,7 @@ declare namespace ts.server.protocol {
         placeOpenBraceOnNewLineForControlBlocks?: boolean;
 
         /** Index operator */
-        [key: string]: string | number | boolean;
+        [key: string]: string | number | boolean | undefined;
     }
 
     /**
diff --git a/src/server/session.ts b/src/server/session.ts
@@ -674,6 +674,7 @@ namespace ts.server {
                         if (lineText.search("\\S") < 0) {
                             // TODO: get these options from host
                             const editorOptions: ts.EditorOptions = {
+                                BaseIndentSize: formatOptions.BaseIndentSize,
                                 IndentSize: formatOptions.IndentSize,
                                 TabSize: formatOptions.TabSize,
                                 NewLineCharacter: formatOptions.NewLineCharacter,
diff --git a/src/services/formatting/smartIndenter.ts b/src/services/formatting/smartIndenter.ts
@@ -10,24 +10,24 @@ namespace ts.formatting {
 
         export function getIndentation(position: number, sourceFile: SourceFile, options: EditorOptions): number {
             if (position > sourceFile.text.length) {
-                return 0; // past EOF
+                return getBaseIndentation(options); // past EOF
             }
 
             // no indentation when the indent style is set to none,
             // so we can return fast
             if (options.IndentStyle === IndentStyle.None) {
-                return 0;
+                return getBaseIndentation(options);
             }
 
             const precedingToken = findPrecedingToken(position, sourceFile);
             if (!precedingToken) {
-                return 0;
+                return getBaseIndentation(options);
             }
 
             // no indentation in string \regex\template literals
             const precedingTokenIsLiteral = isStringOrRegularExpressionOrTemplateLiteral(precedingToken.kind);
             if (precedingTokenIsLiteral && precedingToken.getStart(sourceFile) <= position && precedingToken.end > position) {
-                return 0;
+                return getBaseIndentation(options);
             }
 
             const lineAtPosition = sourceFile.getLineAndCharacterOfPosition(position).line;
@@ -96,13 +96,17 @@ namespace ts.formatting {
             }
 
             if (!current) {
-                // no parent was found - return 0 to be indented on the level of SourceFile
-                return 0;
+                // no parent was found - return the base indentation of the SourceFile
+                return getBaseIndentation(options);
             }
 
             return getIndentationForNodeWorker(current, currentStart, /*ignoreActualIndentationRange*/ undefined, indentationDelta, sourceFile, options);
         }
 
+        function getBaseIndentation(options: EditorOptions) {
+            return options.BaseIndentSize || 0;
+        }
+
         export function getIndentationForNode(n: Node, ignoreActualIndentationRange: TextRange, sourceFile: SourceFile, options: FormatCodeOptions): number {
             const start = sourceFile.getLineAndCharacterOfPosition(n.getStart(sourceFile));
             return getIndentationForNodeWorker(n, start, ignoreActualIndentationRange, /*indentationDelta*/ 0, sourceFile, options);
@@ -162,7 +166,7 @@ namespace ts.formatting {
                 parent = current.parent;
             }
 
-            return indentationDelta;
+            return indentationDelta + getBaseIndentation(options);
         }
 
 
diff --git a/src/services/services.ts b/src/services/services.ts
@@ -1244,6 +1244,7 @@ namespace ts {
     }
 
     export interface EditorOptions {
+        BaseIndentSize?: number;
         IndentSize: number;
         TabSize: number;
         NewLineCharacter: string;
@@ -1268,7 +1269,7 @@ namespace ts {
         InsertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces: boolean;
         PlaceOpenBraceOnNewLineForFunctions: boolean;
         PlaceOpenBraceOnNewLineForControlBlocks: boolean;
-        [s: string]: boolean | number | string;
+        [s: string]: boolean | number | string | undefined;
     }
 
     export interface DefinitionInfo {

Original file line number	Diff line number	Diff line change
`@@ -310,6 +310,7 @@ namespace FourSlash {`
`310`	`310`	`}`
`311`	`311`
`312`	`312`	`this.formatCodeOptions = {`
	`313`	`+ BaseIndentSize: 0,`
`313`	`314`	`IndentSize: 4,`
`314`	`315`	`TabSize: 4,`
`315`	`316`	`NewLineCharacter: Harness.IO.newLine(),`
Original file line number	Diff line number	Diff line change
`@@ -10,24 +10,24 @@ namespace ts.formatting {`
`10`	`10`
`11`	`11`	`export function getIndentation(position: number, sourceFile: SourceFile, options: EditorOptions): number {`
`12`	`12`	`if (position > sourceFile.text.length) {`
`13`		`- return 0; // past EOF`
	`13`	`+ return getBaseIndentation(options); // past EOF`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`// no indentation when the indent style is set to none,`
`17`	`17`	`// so we can return fast`
`18`	`18`	`if (options.IndentStyle === IndentStyle.None) {`
`19`		`- return 0;`
	`19`	`+ return getBaseIndentation(options);`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`const precedingToken = findPrecedingToken(position, sourceFile);`
`23`	`23`	`if (!precedingToken) {`
`24`		`- return 0;`
	`24`	`+ return getBaseIndentation(options);`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`// no indentation in string \regex\template literals`
`28`	`28`	`const precedingTokenIsLiteral = isStringOrRegularExpressionOrTemplateLiteral(precedingToken.kind);`
`29`	`29`	`if (precedingTokenIsLiteral && precedingToken.getStart(sourceFile) <= position && precedingToken.end > position) {`
`30`		`- return 0;`
	`30`	`+ return getBaseIndentation(options);`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`const lineAtPosition = sourceFile.getLineAndCharacterOfPosition(position).line;`
`@@ -96,13 +96,17 @@ namespace ts.formatting {`
`96`	`96`	`}`
`97`	`97`
`98`	`98`	`if (!current) {`
`99`		`- // no parent was found - return 0 to be indented on the level of SourceFile`
`100`		`- return 0;`
	`99`	`+ // no parent was found - return the base indentation of the SourceFile`
	`100`	`+ return getBaseIndentation(options);`
`101`	`101`	`}`
`102`	`102`
`103`	`103`	`return getIndentationForNodeWorker(current, currentStart, /ignoreActualIndentationRange/ undefined, indentationDelta, sourceFile, options);`
`104`	`104`	`}`
`105`	`105`
	`106`	`+ function getBaseIndentation(options: EditorOptions) {`
	`107`	`+ return options.BaseIndentSize \|\| 0;`
	`108`	`+ }`
	`109`	`+`
`106`	`110`	`export function getIndentationForNode(n: Node, ignoreActualIndentationRange: TextRange, sourceFile: SourceFile, options: FormatCodeOptions): number {`
`107`	`111`	`const start = sourceFile.getLineAndCharacterOfPosition(n.getStart(sourceFile));`
`108`	`112`	`return getIndentationForNodeWorker(n, start, ignoreActualIndentationRange, /indentationDelta/ 0, sourceFile, options);`
`@@ -162,7 +166,7 @@ namespace ts.formatting {`
`162`	`166`	`parent = current.parent;`
`163`	`167`	`}`
`164`	`168`
`165`		`- return indentationDelta;`
	`169`	`+ return indentationDelta + getBaseIndentation(options);`
`166`	`170`	`}`
`167`	`171`
`168`	`172`
Original file line number	Diff line number	Diff line change
`@@ -1244,6 +1244,7 @@ namespace ts {`
`1244`	`1244`	`}`
`1245`	`1245`
`1246`	`1246`	`export interface EditorOptions {`
	`1247`	`+ BaseIndentSize?: number;`
`1247`	`1248`	`IndentSize: number;`
`1248`	`1249`	`TabSize: number;`
`1249`	`1250`	`NewLineCharacter: string;`
`@@ -1268,7 +1269,7 @@ namespace ts {`
`1268`	`1269`	`InsertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces: boolean;`
`1269`	`1270`	`PlaceOpenBraceOnNewLineForFunctions: boolean;`
`1270`	`1271`	`PlaceOpenBraceOnNewLineForControlBlocks: boolean;`
`1271`		`- [s: string]: boolean \| number \| string;`
	`1272`	`+ [s: string]: boolean \| number \| string \| undefined;`
`1272`	`1273`	`}`
`1273`	`1274`
`1274`	`1275`	`export interface DefinitionInfo {`