fix: Always add a new line at the end of (#1316)

streetsidesoftware · Sep 17, 2021 · 62b7894 · 62b7894
1 parent 23cf6fd
commit 62b7894
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 1 deletion.
diff --git a/packages/client/src/settings/__snapshots__/configFileReadWrite.test.ts.snap b/packages/client/src/settings/__snapshots__/configFileReadWrite.test.ts.snap
@@ -70,6 +70,19 @@ exports[`Validate configFileReadWrite update package.json 1`] = `
 "
 `;
 
+exports[`Validate configFileReadWrite write cspell.config.json 1`] = `
+"// This is a Json file with comments.
+{
+    // Version should be 0.2
+    \\"version\\": \\"0.2\\",
+    // Custom terms should be here.
+    \\"words\\": [],
+    // Words to be ignored
+    \\"ignoreWords\\": []
+}
+"
+`;
+
 exports[`Validate configFileReadWrite write cspell.config.yaml 1`] = `
 "version: \\"0.2\\"
 words: []

diff --git a/packages/client/src/settings/configFileReadWrite.test.ts b/packages/client/src/settings/configFileReadWrite.test.ts
@@ -41,6 +41,7 @@ describe('Validate configFileReadWrite', () => {
     test.each`
         filename                | initialContent
         ${'cspell.json'}        | ${undefined}
+        ${'cspell.config.json'} | ${toJson(parseJsonc('{}'))}
         ${'cspell.jsonc'}       | ${undefined}
         ${'cspell.config.yaml'} | ${undefined}
         ${'package.json'}       | ${toJson(samplePackageJson)}

diff --git a/packages/client/src/settings/configFileReadWrite.ts b/packages/client/src/settings/configFileReadWrite.ts
@@ -194,7 +194,9 @@ class ConfigFileReaderWriterJson extends AbstractConfigFileReaderWriter {
 
     async write(cfg: CSpellSettings): Promise<void> {
         await this.mkdir();
-        return fs.writeFile(this.uri.fsPath, stringifyJson(cfg));
+        const json = stringifyJson(cfg);
+        const content = json[json.length - 1] !== '\n' ? json + '\n' : json;
+        return fs.writeFile(this.uri.fsPath, content);
     }
 
     async _read(): Promise<CSpellSettings> {