NEW @W-16891765@ Added end-of-file comment to config output.

Author: jfeingold35

messages/config-model.md

@@ -12,3 +12,6 @@ Empty object used because rule selection returned no rules
 
 # template.yaml.no-rules-selected
 Remove this empty object {} when you are ready to specify your first rule override
+
+# template.common.end-of-config
+END OF CODE ANALYZER CONFIGURATION

src/lib/models/ConfigModel.ts

@@ -114,7 +114,9 @@ abstract class YamlFormatter {
 			this.toYamlRuleOverrides() + '\n' +
 			'\n' +
 			this.toYamlComment(topLevelDescription.fieldDescriptions!.engines) + '\n' +
-			this.toYamlEngineOverrides() + '\n';
+			this.toYamlEngineOverrides() + '\n' +
+			'\n' +
+			this.toYamlSectionHeadingComment(getMessage(BundleName.ConfigModel, 'template.common.end-of-config')) + '\n';
 	}
 
 	private toYamlRuleOverrides(): string {

test/fixtures/comparison-files/lib/actions/ConfigAction.test.ts/header-comments/top-level-end.yml.goldfile

@@ -0,0 +1,3 @@
+# ======================================================================
+# END OF CODE ANALYZER CONFIGURATION
+# ======================================================================

…s/header-comments/top-level.yml.goldfile …er-comments/top-level-start.yml.goldfiletest/fixtures/comparison-files/lib/actions/ConfigAction.test.ts/header-comments/top-level.yml.goldfile renamed to test/fixtures/comparison-files/lib/actions/ConfigAction.test.ts/header-comments/top-level-start.yml.goldfile test/fixtures/comparison-files/lib/actions/ConfigAction.test.ts/header-comments/top-level.yml.goldfile renamed to test/fixtures/comparison-files/lib/actions/ConfigAction.test.ts/header-comments/top-level-start.yml.goldfile

@@ -42,13 +42,16 @@ describe('ConfigAction tests', () => {
 				};
 			});
 
-			it('Top-level overview-comment is correct', async () => {
+			it.each([
+				{position: 'start'},
+				{position: 'end'}
+			])('Top-level $position comment is correct', async ({position}) => {
 				// ==== TESTED BEHAVIOR ====
 				// Just select all rules for this test, since we don't care about the rules here.
 				const output = await runActionAndGetDisplayedConfig(dependencies, ['all']);
 
 				// ==== ASSERTIONS ====
-				const goldFileContents = await readGoldFile(path.join(PATH_TO_COMPARISON_DIR, 'header-comments', 'top-level.yml.goldfile'));
+				const goldFileContents = await readGoldFile(path.join(PATH_TO_COMPARISON_DIR, 'header-comments', `top-level-${position}.yml.goldfile`));
 				expect(output).toContain(goldFileContents);
 			});
 
@@ -167,7 +170,10 @@ describe('ConfigAction tests', () => {
 			});
 
 
-			it('Top-level overview-comment is correct', async () => {
+			it.each([
+				{position: 'start'},
+				{position: 'end'}
+			])('Top-level $position comment is correct', async ({position}) => {
 				// ==== SETUP ====
 				// Set the dummy config properties to null; it's fine for this test.
 				stubConfigFactory.setDummyConfigRoot('null');
@@ -178,7 +184,7 @@ describe('ConfigAction tests', () => {
 				const output = await runActionAndGetDisplayedConfig(dependencies, ['all']);
 
 				// ==== ASSERTIONS ====
-				const goldFileContents = await readGoldFile(path.join(PATH_TO_COMPARISON_DIR, 'header-comments', 'top-level.yml.goldfile'));
+				const goldFileContents = await readGoldFile(path.join(PATH_TO_COMPARISON_DIR, 'header-comments', `top-level-${position}.yml.goldfile`));
 				expect(output).toContain(goldFileContents);
 			});