Fix(prettier): It should replace existing overrides for the same patt…

…ern instead of adding a new item
sapegin · Jun 18, 2020 · 3df42c0 · 3df42c0
1 parent 2ccf4d1
commit 3df42c0
Show file tree

Hide file tree

Showing 3 changed files with 96 additions and 18 deletions.
diff --git a/packages/mrm-task-prettier/__snapshots__/index.spec.js.snap b/packages/mrm-task-prettier/__snapshots__/index.spec.js.snap
@@ -56,6 +56,26 @@ exports[`should infer options from EditorConfig 1`] = `
 }"
 `;
 
+exports[`should replace existing overrides for the same pattern 1`] = `
+"{
+  \\"useTabs\\": true,
+  \\"overrides\\": [
+    {
+      \\"files\\": \\"*.js\\",
+      \\"options\\": {
+        \\"useTabs\\": false
+      }
+    },
+    {
+      \\"files\\": \\"*.md\\",
+      \\"options\\": {
+        \\"printWidth\\": 42
+      }
+    }
+  ]
+}"
+`;
+
 exports[`should use a custom indent 1`] = `
 "{
   \\"useTabs\\": true,

diff --git a/packages/mrm-task-prettier/index.js b/packages/mrm-task-prettier/index.js
@@ -59,6 +59,17 @@ function getPattern(pkg) {
 	return `**/*.{${exts.join(',')}}`;
 }
 
+// Remove options that have the same values as Prettier defaults
+function removeDefaultOptions(options) {
+	const newOptions = { ...options };
+	for (const option in newOptions) {
+		if (newOptions[option] === defaultPrettierOptions[option]) {
+			delete newOptions[option];
+		}
+	}
+	return newOptions;
+}
+
 module.exports = function task({
 	indent,
 	prettierPattern,
@@ -74,28 +85,37 @@ module.exports = function task({
 	const pkg = packageJson();
 
 	const overrides = prettierOverrides || defaultOverrides;
-	const options = Object.assign(
-		{},
-		prettierOptions
-			? {}
-			: {
-					useTabs: indent === 'tab',
-			  },
-		editorconfigOptions,
-		prettierOptions,
-		overrides && { overrides }
+	const options = removeDefaultOptions(
+		Object.assign(
+			{},
+			prettierOptions
+				? {}
+				: {
+						useTabs: indent === 'tab',
+				  },
+			editorconfigOptions,
+			prettierOptions
+		)
 	);
 
-	// Remove options that have the same values as Prettier defaults
-	for (const option in options) {
-		if (options[option] === defaultPrettierOptions[option]) {
-			delete options[option];
-		}
-	}
-
 	// .prettierrc
-	json('.prettierrc')
+	const prettierrc = json('.prettierrc');
+
+	// Get existing overrides and remove the ones we're going to add
+	const overridePatterns = overrides.map(override => override.files);
+	const oldOverrides = prettierrc
+		.get('overrides', [])
+		.filter(override => !overridePatterns.includes(override.files));
+
+	// Merge existing overrides with new ones
+	const newOverrides = [...oldOverrides, ...overrides];
+
+	// Update options and save
+	prettierrc
 		.merge(options)
+		// unset/set to make sure overrides are always placed after options
+		.unset('overrides')
+		.set('overrides', newOverrides)
 		.save();
 
 	const pattern =

diff --git a/packages/mrm-task-prettier/index.spec.js b/packages/mrm-task-prettier/index.spec.js
@@ -91,6 +91,44 @@ it('should use custom overrides', async () => {
 	expect(vol.toJSON()['/.prettierrc']).toMatchSnapshot();
 });
 
+it('should replace existing overrides for the same pattern', async () => {
+	vol.fromJSON({
+		'/.prettierrc': stringify({
+			overrides: [
+				{
+					files: '*.js',
+					options: {
+						useTabs: false,
+					},
+				},
+				{
+					files: '*.md',
+					options: {
+						useTabs: false,
+						printWidth: 30,
+					},
+				},
+			],
+		}),
+		'/package.json': packageJson,
+	});
+
+	task(
+		await getTaskOptions(task, false, {
+			prettierOverrides: [
+				{
+					files: '*.md',
+					options: {
+						printWidth: 42,
+					},
+				},
+			],
+		})
+	);
+
+	expect(vol.toJSON()['/.prettierrc']).toMatchSnapshot();
+});
+
 it('should infer options from EditorConfig', async () => {
 	vol.fromJSON({
 		'/.editorconfig': '[*]\nindent_style = space\nindent_size = 2',