feat(config-file): extended the defined prettier config from the config file

Author: travi

package-lock.json

@@ -85,5 +85,9 @@
     "rollup": "2.75.7",
     "rollup-plugin-auto-external": "2.0.0",
     "sinon": "14.0.0"
+  },
+  "dependencies": {
+    "@form8ion/config-file": "^1.0.1",
+    "@form8ion/core": "^1.8.0"
   }
 }

package.json

@@ -1,15 +1,35 @@
+import {fileTypes} from '@form8ion/core';
+import * as configFile from '@form8ion/config-file';
+
 import {assert} from 'chai';
 import any from '@travi/any';
+import sinon from 'sinon';
 
 import scaffold from './scaffolder';
 
 suite('scaffolder', () => {
+  let sandbox;
+
+  setup(() => {
+    sandbox = sinon.createSandbox();
+
+    sandbox.stub(configFile, 'write');
+  });
+
+  teardown(() => sandbox.restore());
+
   test('that prettier is scaffolded if config is provided', async () => {
     const scope = `@${any.word()}`;
+    const projectRoot = any.string();
+    const configPackageName = `${scope}/prettier-config`;
 
-    const {devDependencies} = await scaffold({config: {scope}});
+    const {devDependencies} = await scaffold({config: {scope}, projectRoot});
 
-    assert.deepEqual(devDependencies, ['prettier', `${scope}/prettier-config`]);
+    assert.deepEqual(devDependencies, ['prettier', configPackageName]);
+    assert.calledWith(
+      configFile.write,
+      {path: projectRoot, format: fileTypes.JSON, name: 'prettier', config: configPackageName}
+    );
   });
 
   test('that prettier is not scaffolded if no config is provided', async () => {

src/scaffolder-test.js

@@ -1,5 +1,12 @@
-export default function ({config}) {
+import {fileTypes} from '@form8ion/core';
+import {write} from '@form8ion/config-file';
+
+export default async function ({config, projectRoot}) {
   if (!config) return {};
 
-  return {devDependencies: ['prettier', `${config.scope}/prettier-config`]};
+  const configPackageName = `${config.scope}/prettier-config`;
+
+  await write({path: projectRoot, format: fileTypes.JSON, name: 'prettier', config: configPackageName});
+
+  return {devDependencies: ['prettier', configPackageName]};
 }

src/scaffolder.js

@@ -4,6 +4,7 @@ Feature: Scaffolder
     Given a prettier config is defined
     When the project is scaffolded
     Then the dependencies are defined
+    And the config file is created
 
   Scenario: no config provided
     Given no prettier config is defined

test/integration/features/scaffolder.feature

@@ -13,14 +13,16 @@ After(function () {
 });
 
 When('the project is scaffolded', async function () {
+  this.scaffoldRoot = process.cwd();
+
   // eslint-disable-next-line import/no-extraneous-dependencies,import/no-unresolved
   const {scaffold} = await import('@form8ion/prettier');
 
   stubbedFs({
     node_modules: stubbedNodeModules
   });
 
-  this.scaffoldResult = await scaffold({projectRoot: process.cwd(), ...this.scope && {config: {scope: this.scope}}});
+  this.scaffoldResult = await scaffold({projectRoot: this.scaffoldRoot, ...this.scope && {config: {scope: this.scope}}});
 });
 
 Then('prettier is not configured', async function () {

test/integration/features/step_definitions/common-steps.mjs

@@ -0,0 +1,8 @@
+import {promises as fs} from 'node:fs';
+
+import {Then} from '@cucumber/cucumber';
+import {assert} from 'chai';
+
+Then('the config file is created', async function () {
+  assert.equal(await fs.readFile(`${this.scaffoldRoot}/.prettierrc.json`, 'utf-8'), `"${this.scope}/prettier-config"`);
+});