Fixup encoding per PR comments

Nick Pape · Nick Pape · commit 2368b5495923 · 2018-06-27T17:51:06.000-07:00
diff --git a/apps/api-documenter/src/markdown/MarkdownDocumenter.ts b/apps/api-documenter/src/markdown/MarkdownDocumenter.ts
@@ -6,7 +6,7 @@ import * as path from 'path';
 import {
   PackageName,
   FileSystem,
-  NewlineConversion
+  NewlineKind
 } from '@microsoft/node-core-library';
 import {
   IApiClass,
@@ -601,7 +601,7 @@ export class MarkdownDocumenter {
     });
 
     FileSystem.writeFile(filename, content, {
-      convertLineEndings: NewlineConversion.CrLf
+      convertLineEndings: NewlineKind.CrLf
     });
   }
 
diff --git a/apps/api-documenter/src/yaml/YamlDocumenter.ts b/apps/api-documenter/src/yaml/YamlDocumenter.ts
@@ -10,7 +10,7 @@ import {
   JsonSchema,
   PackageName,
   FileSystem,
-  NewlineConversion
+  NewlineKind
 } from '@microsoft/node-core-library';
 import {
   MarkupElement,
@@ -419,7 +419,7 @@ export class YamlDocumenter {
     }
 
     FileSystem.writeFile(filePath, stringified, {
-      convertLineEndings: NewlineConversion.CrLf,
+      convertLineEndings: NewlineKind.CrLf,
       ensureFolder: true
     });
 
diff --git a/apps/api-extractor/src/generators/dtsRollup/DtsRollupGenerator.ts b/apps/api-extractor/src/generators/dtsRollup/DtsRollupGenerator.ts
@@ -4,7 +4,7 @@
 /* tslint:disable:no-bitwise */
 
 import * as ts from 'typescript';
-import { FileSystem, NewlineConversion } from '@microsoft/node-core-library';
+import { FileSystem, NewlineKind } from '@microsoft/node-core-library';
 
 import { ExtractorContext } from '../../ExtractorContext';
 import { IndentedWriter } from '../../utils/IndentedWriter';
@@ -116,7 +116,7 @@ export class DtsRollupGenerator {
     this._generateTypingsFileContent(indentedWriter, dtsKind);
 
     FileSystem.writeFile(dtsFilename, indentedWriter.toString(), {
-      convertLineEndings: NewlineConversion.CrLf,
+      convertLineEndings: NewlineKind.CrLf,
       ensureFolder: true
     });
   }
diff --git a/apps/rush-lib/src/api/ApprovedPackagesConfiguration.ts b/apps/rush-lib/src/api/ApprovedPackagesConfiguration.ts
@@ -3,7 +3,7 @@
 
 import * as path from 'path';
 import * as os from 'os';
-import { JsonFile, JsonSchema, FileSystem, NewlineConversion } from '@microsoft/node-core-library';
+import { JsonFile, JsonSchema, FileSystem, NewlineKind } from '@microsoft/node-core-library';
 
 import { Utilities } from '../utilities/Utilities';
 
@@ -162,7 +162,7 @@ export class ApprovedPackagesConfiguration {
       + '  They will be lost when the Rush tool resaves it.\n' + body;
 
     FileSystem.writeFile(this._jsonFilename, body, {
-      convertLineEndings: NewlineConversion.CrLf
+      convertLineEndings: NewlineKind.CrLf
     });
   }
 
diff --git a/apps/rush-lib/src/cli/actions/ScanAction.ts b/apps/rush-lib/src/cli/actions/ScanAction.ts
@@ -81,7 +81,7 @@ export class ScanAction extends BaseRushAction {
 
     for (const filename of glob.sync('{./*.{ts,js,tsx,jsx},./{src,lib}/**/*.{ts,js,tsx,jsx}}')) {
       try {
-        const contents: string = FileSystem.readFile(filename, { encoding: 'utf8' });
+        const contents: string = FileSystem.readFile(filename);
         const lines: string[] = contents.split('\n');
 
         for (const line of lines) {
diff --git a/common/reviews/api/node-core-library.api.ts b/common/reviews/api/node-core-library.api.ts
@@ -150,7 +150,7 @@ interface IProtectableMapParameters<K, V> {
 
 // @public
 interface IReadFileOptions {
-  convertLineEndings?: NewlineConversion;
+  convertLineEndings?: NewlineKind;
   encoding?: Encoding;
 }
 
@@ -161,7 +161,7 @@ interface IReadFolderOptions {
 
 // @public
 interface IWriteFileOptions {
-  convertLineEndings?: NewlineConversion;
+  convertLineEndings?: NewlineKind;
   encoding?: Encoding;
   ensureFolder?: boolean;
 }
@@ -203,13 +203,11 @@ class MapExtensions {
 }
 
 // @public
-enum NewlineConversion {
+enum NewlineKind {
   // (undocumented)
   CrLf = 0,
   // (undocumented)
-  Lf = 1,
-  // (undocumented)
-  None = 2
+  Lf = 1
 }
 
 // @public
diff --git a/libraries/node-core-library/src/FileSystem.ts b/libraries/node-core-library/src/FileSystem.ts
@@ -16,10 +16,16 @@ export const enum Encoding {
  * Enumeration controlling conversion of newline characters.
  * @public
  */
-export enum NewlineConversion {
-  CrLf,
-  Lf,
-  None
+export const enum NewlineKind {
+  /**
+   * Windows-style newlines
+   */
+  CrLf = '\r\n',
+
+  /**
+   * Unix-style newlines
+   */
+  Lf = '\n'
 }
 
 /**
@@ -47,9 +53,9 @@ export interface IWriteFileOptions {
 
   /**
    * If specified, will normalize line endings to the specified style of newline.
-   * Defaults to `NewlineConversion.None`.
+   * Defaults to `NewlineKind.None`.
    */
-  convertLineEndings?: NewlineConversion;
+  convertLineEndings?: NewlineKind;
 
   /**
    * If specified, will change the encoding of the file that will be written.
@@ -71,9 +77,9 @@ export interface IReadFileOptions {
 
   /**
    * If specified, will normalize line endings to the specified style of newline.
-   * Defaults to `NewlineConversion.None`.
+   * Defaults to `NewlineKind.None`.
    */
-  convertLineEndings?: NewlineConversion;
+  convertLineEndings?: NewlineKind;
 }
 
 /**
@@ -246,7 +252,7 @@ export class FileSystem {
   public static writeFile(filePath: string, contents: string, options?: IWriteFileOptions): void {
     options = {
       ensureFolder: false,
-      convertLineEndings: NewlineConversion.None,
+      convertLineEndings: undefined,
       encoding: Encoding.Utf8,
       ...options
     };
@@ -270,7 +276,7 @@ export class FileSystem {
   public static readFile(filePath: string, options?: IReadFileOptions): string {
     options = {
       encoding: Encoding.Utf8,
-      convertLineEndings: NewlineConversion.None,
+      convertLineEndings: undefined,
       ...options
     };
 
@@ -373,10 +379,10 @@ export class FileSystem {
    * @param text - The text to be normalized.
    * @param lineEndings - The style of line endings to use.
    */
-  private static _convertLineEndings(text: string, lineEndings: NewlineConversion | undefined): string {
-    if (lineEndings === NewlineConversion.CrLf) {
+  private static _convertLineEndings(text: string, lineEndings: NewlineKind | undefined): string {
+    if (lineEndings === NewlineKind.CrLf) {
       return Text.convertToCrLf(text);
-    } else if (lineEndings === NewlineConversion.Lf) {
+    } else if (lineEndings === NewlineKind.Lf) {
       return Text.convertToLf(text);
     }
     return text;
diff --git a/libraries/node-core-library/src/index.ts b/libraries/node-core-library/src/index.ts
@@ -53,7 +53,7 @@ export {
   IReadFileOptions,
   IMoveOptions,
   IDeleteFileOptions,
-  NewlineConversion
+  NewlineKind
 } from './FileSystem';
 export {
   FileWriter,
