Merge pull request #745 from Shopify/prettier-config-test

Add tests to prettier config items
Shopify · Sep 11, 2018 · 8c575ef · 8c575ef
2 parents 9906033 + 012d0cd
commit 8c575ef
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 5 deletions.
diff --git a/packages/slate-tools/slate-tools.schema.js b/packages/slate-tools/slate-tools.schema.js
@@ -26,11 +26,11 @@ module.exports = {
   'prettier.bin': path.resolve(__dirname, 'node_modules/.bin/prettier'),
 
   // Path to .prettierrc file
-  'prettier.rc': (config) =>
+  'prettier.config': (config) =>
     path.resolve(config.get('paths.theme'), '.prettierrc'),
 
   // Path to .prettierignore file
-  'prettier.ignore': (config) =>
+  'prettier.ignorePath': (config) =>
     path.resolve(config.get('paths.theme'), '.prettierignore'),
 
   // Path to self-signed SSL certificate which is used when developing

diff --git a/packages/slate-tools/tools/prettier/__tests__/index.test.js b/packages/slate-tools/tools/prettier/__tests__/index.test.js
@@ -2,21 +2,48 @@ jest.mock('child_process', () => ({exec: jest.fn()}));
 
 const {exec} = require.requireMock('child_process');
 
-describe('eslint()', () => {
+describe('Prettier()', () => {
   beforeEach(() => {
     exec.mockClear();
   });
 
-  test('executes the Prettier bin found in slate-tools/node_modules', () => {
+  test(`executes the Prettier bin from the path specified in the 'prettier.bin' config`, () => {
     const {prettier} = require('../index');
     const SlateConfig = require('@shopify/slate-config');
     const config = new SlateConfig(require('../../../slate-tools.schema'));
 
     prettier();
+
     expect(exec).toHaveBeenCalledTimes(1);
     expect(exec).toHaveBeenCalledWith(
       expect.stringContaining(config.get('prettier.bin')),
       expect.anything(),
     );
   });
+
+  test(`executes Prettier with the --config flag set to 'prettier.config' config`, () => {
+    const {prettier} = require('../index');
+    const SlateConfig = require('@shopify/slate-config');
+    const config = new SlateConfig(require('../../../slate-tools.schema'));
+
+    prettier();
+
+    expect(exec).toHaveBeenCalledWith(
+      expect.stringContaining(`--config ${config.get('prettier.config')}`),
+      expect.anything(),
+    );
+  });
+
+  test(`executes Prettier with the --ignore-path flag set to 'prettier.ignorePath' config`, () => {
+    const {prettier} = require('../index');
+    const SlateConfig = require('@shopify/slate-config');
+    const config = new SlateConfig(require('../../../slate-tools.schema'));
+    prettier();
+    expect(exec).toHaveBeenCalledWith(
+      expect.stringContaining(
+        `--ignore-path ${config.get('prettier.ignorePath')}`,
+      ),
+      expect.anything(),
+    );
+  });
 });
diff --git a/packages/slate-tools/tools/prettier/index.js b/packages/slate-tools/tools/prettier/index.js
@@ -1,3 +1,4 @@
+const fs = require('fs');
 const {exec} = require('child_process');
 const {promisify} = require('util');
 const SlateConfig = require('@shopify/slate-config');
@@ -6,6 +7,10 @@ const config = new SlateConfig(require('../../slate-tools.schema'));
 
 async function prettier({scripts, styles, json} = {}) {
   const executable = config.get('prettier.bin');
+  const prettierConfig = `--config ${config.get('prettier.config')}`;
+  const ignorePath = fs.existsSync(config.get('prettier.ignorePath'))
+    ? `--ignore-path ${config.get('prettier.ignorePath')}`
+    : '';
   const extensions = [
     ...(scripts ? ['js'] : []),
     ...(styles ? ['css', 'scss', 'sass'] : []),
@@ -17,7 +22,11 @@ async function prettier({scripts, styles, json} = {}) {
       : `./**/*.${extensions.join(',')}`;
 
   try {
-    await promisify(exec)(`${JSON.stringify(executable)} "${glob}" --write`);
+    await promisify(exec)(
+      `${JSON.stringify(
+        executable,
+      )} "${glob}" --write ${prettierConfig} ${ignorePath}`,
+    );
   } catch (error) {
     if (typeof error.stdout !== 'string') {
       throw error;