Make the clearInvalidConfig option false by default

readme.md

@@ -187,9 +187,9 @@ You would usually not need this, but could be useful if you want to interact wit
 #### clearInvalidConfig
 
 Type: `boolean`\
-Default: `true`
+Default: `false`
 
-The config is cleared if reading the config file causes a `SyntaxError`. This is a good default, as the config file is not intended to be hand-edited, so it usually means the config is corrupt and there's nothing the user can do about it anyway. However, if you let the user edit the config file directly, mistakes might happen and it could be more useful to throw an error when the config is invalid instead of clearing. Disabling this option will make it throw a `SyntaxError` on invalid config instead of clearing.
+The config is cleared if reading the config file causes a `SyntaxError`. This is a good behavior for unimportant data, as the config file is not intended to be hand-edited, so it usually means the config is corrupt and there's nothing the user can do about it anyway. However, if you let the user edit the config file directly, mistakes might happen and it could be more useful to throw an error when the config is invalid instead of clearing.
 
 #### serialize
 

source/index.ts

@@ -56,7 +56,7 @@ class Conf<T extends Record<string, any> = Record<string, unknown>> implements I
 			configName: 'config',
 			fileExtension: 'json',
 			projectSuffix: 'nodejs',
-			clearInvalidConfig: true,
+			clearInvalidConfig: false,
 			accessPropertiesByDotNotation: true,
 			...partialOptions
 		};

source/types.ts

@@ -131,9 +131,9 @@ export interface Options<T> {
 	fileExtension?: string;
 
 	/**
-	The config is cleared if reading the config file causes a `SyntaxError`. This is a good default, as the config file is not intended to be hand-edited, so it usually means the config is corrupt and there's nothing the user can do about it anyway. However, if you let the user edit the config file directly, mistakes might happen and it could be more useful to throw an error when the config is invalid instead of clearing. Disabling this option will make it throw a `SyntaxError` on invalid config instead of clearing.
+	The config is cleared if reading the config file causes a `SyntaxError`. This is a good behavior for unimportant data, as the config file is not intended to be hand-edited, so it usually means the config is corrupt and there's nothing the user can do about it anyway. However, if you let the user edit the config file directly, mistakes might happen and it could be more useful to throw an error when the config is invalid instead of clearing.
 
-	@default true
+	@default false
 	*/
 	clearInvalidConfig?: boolean;
 

test/index.ts

@@ -406,7 +406,11 @@ test('fallback to cwd if `module.filename` is `null`', t => {
 });
 
 test('encryption', t => {
-	const config = new Conf({cwd: tempy.directory(), encryptionKey: 'abc123'});
+	const config = new Conf({
+		cwd: tempy.directory(),
+		encryptionKey: 'abc123'
+	});
+
 	t.is(config.get('foo'), undefined);
 	t.is(config.get('foo', '🐴'), '🐴');
 	config.set('foo', fixture);
@@ -429,13 +433,23 @@ test('encryption - upgrade', t => {
 test('encryption - corrupt file', t => {
 	const cwd = tempy.directory();
 
-	const before = new Conf({cwd, encryptionKey: 'abc123'});
+	const before = new Conf({
+		cwd,
+		encryptionKey: 'abc123',
+		clearInvalidConfig: true
+	});
+
 	before.set('foo', fixture);
 	t.is(before.get('foo'), fixture);
 
 	fs.appendFileSync(path.join(cwd, 'config.json'), 'corrupt file');
 
-	const after = new Conf({cwd, encryptionKey: 'abc123'});
+	const after = new Conf({
+		cwd,
+		encryptionKey: 'abc123',
+		clearInvalidConfig: true
+	});
+
 	t.is(after.get('foo'), undefined);
 });