Add .docs to .gitignore

packages/gasket-plugin-docs/CHANGELOG.md

@@ -1,5 +1,7 @@
 # `@gasket/plugin-docs`
 
+- Add the default docs directory `.docs` to `.gitignore` on project creation.
+
 ### 6.37.0
 
 - Jest refactor ([#504])

packages/gasket-plugin-docs/lib/create.js

@@ -0,0 +1,5 @@
+const { defaultConfig } = require('./configure');
+
+module.exports = function create(_gasket, { gitignore }) {
+  gitignore?.add(defaultConfig.outputDir, 'Documentation');
+};

packages/gasket-plugin-docs/lib/index.js

@@ -1,3 +1,4 @@
+const create = require('./create');
 const configure = require('./configure');
 const getCommands = require('./get-commands');
 const metadata = require('./metadata');
@@ -7,6 +8,7 @@ module.exports = {
   name: require('../package').name,
   hooks: {
     configure,
+    create,
     getCommands,
     metadata,
     docsSetup

packages/gasket-plugin-docs/test/create.test.js

@@ -0,0 +1,17 @@
+const { hooks: { create } } = require('../lib/index');
+
+describe('the create hook', () => {
+  it('should add a gitignore entry for the .docs directory', () => {
+    const context = { gitignore: { add: jest.fn() } };
+
+    create({}, context);
+
+    expect(context.gitignore.add).toHaveBeenCalledWith('.docs', 'Documentation');
+  });
+
+  it('should handle when no `gitignore` is present in the create context', () => {
+    const context = {};
+
+    expect(() => create({}, context)).not.toThrow(Error);
+  });
+});

packages/gasket-plugin-docs/test/index.test.js

@@ -13,6 +13,7 @@ describe('Plugin', function () {
   it('has expected hooks', () => {
     const expected = [
       'configure',
+      'create',
       'getCommands',
       'metadata',
       'docsSetup'