Updates based on demo branch

ecraig12345 · ecraig12345 · commit 6211a14ece0d · 2019-11-12T15:00:43.000-08:00
diff --git a/apps/api-extractor/src/api/ExtractorConfig.ts b/apps/api-extractor/src/api/ExtractorConfig.ts
@@ -197,7 +197,10 @@ export class ExtractorConfig {
   /** {@inheritDoc IConfigTsdocMetadata.tsdocMetadataFilePath} */
   public readonly tsdocMetadataFilePath: string;
 
-  /** {@inheritDoc IConfigFile.newlineKind} */
+  /**
+   * Specifies what type of newlines API Extractor should use when writing output files.  By default, the output files
+   * will be written with Windows-style newlines.
+   */
   public readonly newlineKind: NewlineKind;
 
   /** {@inheritDoc IConfigFile.messages} */
@@ -661,10 +664,10 @@ export class ExtractorConfig {
 
       let newlineKind: NewlineKind;
       switch (configObject.newlineKind) {
-        case 'Lf':
+        case 'lf':
           newlineKind = NewlineKind.Lf;
           break;
-        case 'OsDefault':
+        case 'os':
           newlineKind = NewlineKind.OsDefault;
           break;
         default:
diff --git a/apps/api-extractor/src/api/IConfigFile.ts b/apps/api-extractor/src/api/IConfigFile.ts
@@ -368,9 +368,12 @@ export interface IConfigFile {
   tsdocMetadata?: IConfigTsdocMetadata;
 
   /**
-   * Specifies the type of newline to use in all generated files.
+   * Specifies what type of newlines API Extractor should use when writing output files.  By default, the output files
+   * will be written with Windows-style newlines.  To use POSIX-style newlines, specify "lf" instead.
+   * To use the OS's default newline kind, specify "os".
+   * @defaultValue 'crlf'
    */
-  newlineKind?: 'CrLf' | 'Lf' | 'OsDefault';
+  newlineKind?: 'crlf' | 'lf' | 'os';
 
   /**
    * {@inheritDoc IExtractorMessagesConfig}
diff --git a/apps/api-extractor/src/schemas/api-extractor-template.json b/apps/api-extractor/src/schemas/api-extractor-template.json
@@ -264,13 +264,13 @@
   },
 
   /**
-   * Specifies the type of newline to use in all generated files.
+   * Specifies what type of newlines API Extractor should use when writing output files.  By default, the output files
+   * will be written with Windows-style newlines.  To use POSIX-style newlines, specify "lf" instead.
+   * To use the OS's default newline kind, specify "os".
    *
-   * Supported values are "CrLf", "Lf", or "OsDefault".
-   *
-   * DEFAULT VALUE: "CrLf"
+   * DEFAULT VALUE: "crlf"
    */
-  // "newlineKind": "CrLf",
+  // "newlineKind": "crlf",
 
   /**
    * Configures how API Extractor reports error and warning messages produced during analysis.
diff --git a/apps/api-extractor/src/schemas/api-extractor.schema.json b/apps/api-extractor/src/schemas/api-extractor.schema.json
@@ -143,10 +143,10 @@
     },
 
     "newlineKind": {
-      "description": "Specifies the type of newline to use in all generated files.",
+      "description": "Specifies what type of newlines API Extractor should use when writing output files.  By default, the output files will be written with Windows-style newlines.  To use POSIX-style newlines, specify \"lf\" instead. To use the OS's default newline kind, specify \"os\".",
       "type": "string",
-      "enum": ["CrLf", "Lf", "OsDefault"],
-      "default": "CrLf"
+      "enum": ["crlf", "lf", "os"],
+      "default": "crlf"
     },
 
     "messages": {
diff --git a/common/reviews/api/api-extractor.api.md b/common/reviews/api/api-extractor.api.md
@@ -186,7 +186,7 @@ export interface IConfigFile {
     extends?: string;
     mainEntryPointFilePath: string;
     messages?: IExtractorMessagesConfig;
-    newlineKind?: 'CrLf' | 'Lf' | 'OsDefault';
+    newlineKind?: 'crlf' | 'lf' | 'os';
     projectFolder?: string;
     testMode?: boolean;
     // @beta
