@form8ion/git 2.1.0 → 2.2.0

package/README.md

@@ -123,7 +123,7 @@ $ npm test
 
 [license-link]: LICENSE
 
-[license-badge]: https://img.shields.io/github/license/form8ion/git.svg
+[license-badge]: https://img.shields.io/github/license/form8ion/git.svg?logo=opensourceinitiative
 
 [npm-link]: https://www.npmjs.com/package/@form8ion/git
 

package/lib/index.js

@@ -1,6 +1,6 @@
 import simpleGit from 'simple-git';
 import { info } from '@travi/cli-messages';
-import { write, read } from '@form8ion/ignore-file';
+import { write, exists, read } from '@form8ion/ignore-file';
 import '@form8ion/core';
 import { promises } from 'node:fs';
 
@@ -8,8 +8,12 @@ function writeGitIgnore({projectRoot, ignores}) {
   return write({projectRoot, name: 'git', ignores});
 }
 
-function scaffoldIgnore ({projectRoot, files = [], directories = []}) {
-  return writeGitIgnore({projectRoot, ignores: [...directories, ...files]});
+function scaffoldIgnore ({projectRoot}) {
+  return writeGitIgnore({projectRoot, ignores: []});
+}
+
+function gitignoreExists({projectRoot} = {}) {
+  return exists({projectRoot, name: 'git'});
 }
 
 function readGitIgnore({projectRoot}) {
@@ -17,7 +21,11 @@ function readGitIgnore({projectRoot}) {
 }
 
 async function appendToIgnoreFile({projectRoot, ignores}) {
-  const existingIgnores = await readGitIgnore({projectRoot});
+  let existingIgnores = [];
+
+  if (await gitignoreExists({projectRoot})) {
+    existingIgnores = await readGitIgnore({projectRoot});
+  }
 
   await writeGitIgnore({projectRoot, ignores: [...existingIgnores, ...ignores]});
 }

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/ignore/writer.js","../src/ignore/scaffolder.js","../src/ignore/reader.js","../src/ignore/appender.js","../src/ignore/lifter.js","../src/scaffolder.js","../src/tester.js","../src/attributes/scaffolder.js","../src/lifter.js"],"sourcesContent":["import {write} from '@form8ion/ignore-file';\n\nexport default function writeGitIgnore({projectRoot, ignores}) {\n  return write({projectRoot, name: 'git', ignores});\n}\n","import write from './writer.js';\n\nexport default function ({projectRoot, files = [], directories = []}) {\n  return write({projectRoot, ignores: [...directories, ...files]});\n}\n","import {read} from '@form8ion/ignore-file';\n\nexport default function readGitIgnore({projectRoot}) {\n  return read({projectRoot, name: 'git'});\n}\n","import readGitIgnore from './reader.js';\nimport writeGitIgnore from './writer.js';\n\nexport default async function appendToIgnoreFile({projectRoot, ignores}) {\n  const existingIgnores = await readGitIgnore({projectRoot});\n\n  await writeGitIgnore({projectRoot, ignores: [...existingIgnores, ...ignores]});\n}\n","import {info} from '@travi/cli-messages';\n\nimport appendIgnores from './appender.js';\n\nexport default async function ({projectRoot, results: {vcsIgnore}}) {\n  if (vcsIgnore) {\n    info('Updating files and directories to be ignored from version control', {level: 'secondary'});\n\n    const {directories = [], files = []} = vcsIgnore;\n\n    await appendIgnores({projectRoot, ignores: [...directories, ...files]});\n  }\n\n  return {};\n}\n","import simpleGit from 'simple-git';\nimport {info} from '@travi/cli-messages';\n\nimport {scaffold as scaffoldIgnore} from './ignore/index.js';\n\nexport default async function ({projectRoot}) {\n  info('Initializing Git Repository');\n\n  const git = simpleGit({baseDir: projectRoot});\n\n  await Promise.all([\n    scaffoldIgnore({projectRoot}),\n    git.init()\n  ]);\n\n  return {};\n}\n","import simpleGit from 'simple-git';\n\nexport default function ({projectRoot}) {\n  const git = simpleGit({baseDir: projectRoot});\n\n  return git.checkIsRepo('root');\n}\n","import {promises as fs} from 'node:fs';\n\nexport default function ({projectRoot}) {\n  return fs.writeFile(`${projectRoot}/.gitattributes`, '* text=auto');\n}\n","import {scaffold as scaffoldAttributes} from './attributes/index.js';\nimport {lift as liftIgnore} from './ignore/index.js';\n\nexport default async function ({projectRoot, results}) {\n  await Promise.all([\n    scaffoldAttributes({projectRoot}),\n    liftIgnore({projectRoot, results})\n  ]);\n\n  return {};\n}\n"],"names":["write","appendIgnores","fs"],"mappings":";;;;;;AAEe,SAAS,cAAc,CAAC,CAAC,WAAW,EAAE,OAAO,CAAC,EAAE;AAC/D,EAAE,OAAO,KAAK,CAAC,CAAC,WAAW,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;AACnD;;ACFe,uBAAQ,EAAE,CAAC,WAAW,EAAE,KAAK,GAAG,EAAE,EAAE,WAAW,GAAG,EAAE,CAAC,EAAE;AACtE,EAAE,OAAOA,cAAK,CAAC,CAAC,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,WAAW,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;AAClE;;ACFe,SAAS,aAAa,CAAC,CAAC,WAAW,CAAC,EAAE;AACrD,EAAE,OAAO,IAAI,CAAC,CAAC,WAAW,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;AACzC;;ACDe,eAAe,kBAAkB,CAAC,CAAC,WAAW,EAAE,OAAO,CAAC,EAAE;AACzE,EAAE,MAAM,eAAe,GAAG,MAAM,aAAa,CAAC,CAAC,WAAW,CAAC,CAAC;;AAE5D,EAAE,MAAM,cAAc,CAAC,CAAC,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,eAAe,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC;AAChF;;ACHe,yBAAc,EAAE,CAAC,WAAW,EAAE,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE;AACpE,EAAE,IAAI,SAAS,EAAE;AACjB,IAAI,IAAI,CAAC,mEAAmE,EAAE,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;;AAEnG,IAAI,MAAM,CAAC,WAAW,GAAG,EAAE,EAAE,KAAK,GAAG,EAAE,CAAC,GAAG,SAAS;;AAEpD,IAAI,MAAMC,kBAAa,CAAC,CAAC,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,WAAW,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;AAC3E;;AAEA,EAAE,OAAO,EAAE;AACX;;ACTe,yBAAc,EAAE,CAAC,WAAW,CAAC,EAAE;AAC9C,EAAE,IAAI,CAAC,6BAA6B,CAAC;;AAErC,EAAE,MAAM,GAAG,GAAG,SAAS,CAAC,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;;AAE/C,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC;AACpB,IAAI,cAAc,CAAC,CAAC,WAAW,CAAC,CAAC;AACjC,IAAI,GAAG,CAAC,IAAI;AACZ,GAAG,CAAC;;AAEJ,EAAE,OAAO,EAAE;AACX;;ACde,eAAQ,EAAE,CAAC,WAAW,CAAC,EAAE;AACxC,EAAE,MAAM,GAAG,GAAG,SAAS,CAAC,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;;AAE/C,EAAE,OAAO,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC;AAChC;;ACJe,2BAAQ,EAAE,CAAC,WAAW,CAAC,EAAE;AACxC,EAAE,OAAOC,QAAE,CAAC,SAAS,CAAC,CAAC,EAAE,WAAW,CAAC,eAAe,CAAC,EAAE,aAAa,CAAC;AACrE;;ACDe,qBAAc,EAAE,CAAC,WAAW,EAAE,OAAO,CAAC,EAAE;AACvD,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC;AACpB,IAAI,kBAAkB,CAAC,CAAC,WAAW,CAAC,CAAC;AACrC,IAAI,UAAU,CAAC,CAAC,WAAW,EAAE,OAAO,CAAC;AACrC,GAAG,CAAC;;AAEJ,EAAE,OAAO,EAAE;AACX;;;;"}
+{"version":3,"file":"index.js","sources":["../src/ignore/writer.js","../src/ignore/scaffolder.js","../src/ignore/existence-checker.js","../src/ignore/reader.js","../src/ignore/appender.js","../src/ignore/lifter.js","../src/scaffolder.js","../src/tester.js","../src/attributes/scaffolder.js","../src/lifter.js"],"sourcesContent":["import {write} from '@form8ion/ignore-file';\n\nexport default function writeGitIgnore({projectRoot, ignores}) {\n  return write({projectRoot, name: 'git', ignores});\n}\n","import write from './writer.js';\n\nexport default function ({projectRoot}) {\n  return write({projectRoot, ignores: []});\n}\n","import {exists} from '@form8ion/ignore-file';\n\nexport default function gitignoreExists({projectRoot} = {}) {\n  return exists({projectRoot, name: 'git'});\n}\n","import {read} from '@form8ion/ignore-file';\n\nexport default function readGitIgnore({projectRoot}) {\n  return read({projectRoot, name: 'git'});\n}\n","import gitignoreExists from './existence-checker.js';\nimport readGitIgnore from './reader.js';\nimport writeGitIgnore from './writer.js';\n\nexport default async function appendToIgnoreFile({projectRoot, ignores}) {\n  let existingIgnores = [];\n\n  if (await gitignoreExists({projectRoot})) {\n    existingIgnores = await readGitIgnore({projectRoot});\n  }\n\n  await writeGitIgnore({projectRoot, ignores: [...existingIgnores, ...ignores]});\n}\n","import {info} from '@travi/cli-messages';\n\nimport appendIgnores from './appender.js';\n\nexport default async function ({projectRoot, results: {vcsIgnore}}) {\n  if (vcsIgnore) {\n    info('Updating files and directories to be ignored from version control', {level: 'secondary'});\n\n    const {directories = [], files = []} = vcsIgnore;\n\n    await appendIgnores({projectRoot, ignores: [...directories, ...files]});\n  }\n\n  return {};\n}\n","import simpleGit from 'simple-git';\nimport {info} from '@travi/cli-messages';\n\nimport {scaffold as scaffoldIgnore} from './ignore/index.js';\n\nexport default async function ({projectRoot}) {\n  info('Initializing Git Repository');\n\n  const git = simpleGit({baseDir: projectRoot});\n\n  await Promise.all([\n    scaffoldIgnore({projectRoot}),\n    git.init()\n  ]);\n\n  return {};\n}\n","import simpleGit from 'simple-git';\n\nexport default function ({projectRoot}) {\n  const git = simpleGit({baseDir: projectRoot});\n\n  return git.checkIsRepo('root');\n}\n","import {promises as fs} from 'node:fs';\n\nexport default function ({projectRoot}) {\n  return fs.writeFile(`${projectRoot}/.gitattributes`, '* text=auto');\n}\n","import {scaffold as scaffoldAttributes} from './attributes/index.js';\nimport {lift as liftIgnore} from './ignore/index.js';\n\nexport default async function ({projectRoot, results}) {\n  await Promise.all([\n    scaffoldAttributes({projectRoot}),\n    liftIgnore({projectRoot, results})\n  ]);\n\n  return {};\n}\n"],"names":["write","appendIgnores","fs"],"mappings":";;;;;;AAEe,SAAS,cAAc,CAAC,CAAC,WAAW,EAAE,OAAO,CAAC,EAAE;AAC/D,EAAE,OAAO,KAAK,CAAC,CAAC,WAAW,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;AACnD;;ACFe,uBAAQ,EAAE,CAAC,WAAW,CAAC,EAAE;AACxC,EAAE,OAAOA,cAAK,CAAC,CAAC,WAAW,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;AAC1C;;ACFe,SAAS,eAAe,CAAC,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE;AAC5D,EAAE,OAAO,MAAM,CAAC,CAAC,WAAW,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;AAC3C;;ACFe,SAAS,aAAa,CAAC,CAAC,WAAW,CAAC,EAAE;AACrD,EAAE,OAAO,IAAI,CAAC,CAAC,WAAW,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;AACzC;;ACAe,eAAe,kBAAkB,CAAC,CAAC,WAAW,EAAE,OAAO,CAAC,EAAE;AACzE,EAAE,IAAI,eAAe,GAAG,EAAE;;AAE1B,EAAE,IAAI,MAAM,eAAe,CAAC,CAAC,WAAW,CAAC,CAAC,EAAE;AAC5C,IAAI,eAAe,GAAG,MAAM,aAAa,CAAC,CAAC,WAAW,CAAC,CAAC;AACxD,EAAE;;AAEF,EAAE,MAAM,cAAc,CAAC,CAAC,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,eAAe,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC;AAChF;;ACRe,yBAAc,EAAE,CAAC,WAAW,EAAE,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE;AACpE,EAAE,IAAI,SAAS,EAAE;AACjB,IAAI,IAAI,CAAC,mEAAmE,EAAE,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;;AAEnG,IAAI,MAAM,CAAC,WAAW,GAAG,EAAE,EAAE,KAAK,GAAG,EAAE,CAAC,GAAG,SAAS;;AAEpD,IAAI,MAAMC,kBAAa,CAAC,CAAC,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,WAAW,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;AAC3E,EAAE;;AAEF,EAAE,OAAO,EAAE;AACX;;ACTe,yBAAc,EAAE,CAAC,WAAW,CAAC,EAAE;AAC9C,EAAE,IAAI,CAAC,6BAA6B,CAAC;;AAErC,EAAE,MAAM,GAAG,GAAG,SAAS,CAAC,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;;AAE/C,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC;AACpB,IAAI,cAAc,CAAC,CAAC,WAAW,CAAC,CAAC;AACjC,IAAI,GAAG,CAAC,IAAI;AACZ,GAAG,CAAC;;AAEJ,EAAE,OAAO,EAAE;AACX;;ACde,eAAQ,EAAE,CAAC,WAAW,CAAC,EAAE;AACxC,EAAE,MAAM,GAAG,GAAG,SAAS,CAAC,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;;AAE/C,EAAE,OAAO,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC;AAChC;;ACJe,2BAAQ,EAAE,CAAC,WAAW,CAAC,EAAE;AACxC,EAAE,OAAOC,QAAE,CAAC,SAAS,CAAC,CAAC,EAAE,WAAW,CAAC,eAAe,CAAC,EAAE,aAAa,CAAC;AACrE;;ACDe,qBAAc,EAAE,CAAC,WAAW,EAAE,OAAO,CAAC,EAAE;AACvD,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC;AACpB,IAAI,kBAAkB,CAAC,CAAC,WAAW,CAAC,CAAC;AACrC,IAAI,UAAU,CAAC,CAAC,WAAW,EAAE,OAAO,CAAC;AACrC,GAAG,CAAC;;AAEJ,EAAE,OAAO,EAAE;AACX;;;;"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@form8ion/git",
   "description": "form8ion plugin for managing projects versioned with git",
   "license": "MIT",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "type": "module",
   "engines": {
     "node": "^18.19.0 || ^20.9.0 || >=22.11.0"
@@ -46,13 +46,14 @@
   },
   "files": [
     "example.js",
-    "lib/"
+    "lib/",
+    "src/"
   ],
   "publishConfig": {
     "access": "public",
     "provenance": true
   },
-  "packageManager": "npm@11.0.0",
+  "packageManager": "npm@11.12.1+sha512.cdca14b85d647b3192028d02aadbe82d75f79a446aceea9874be98e6d768f20ebd3555770a48d0e9906106007877bbc690f715e9372f2e2dc644a3c3157fb14c",
   "dependencies": {
     "@form8ion/core": "^4.3.0",
     "@form8ion/ignore-file": "^1.0.0",
@@ -60,31 +61,31 @@
     "simple-git": "^3.25.0"
   },
   "devDependencies": {
-    "@cucumber/cucumber": "11.2.0",
-    "@form8ion/commitlint-config": "2.0.3",
-    "@form8ion/eslint-config": "7.0.12",
+    "@cucumber/cucumber": "11.3.0",
+    "@form8ion/commitlint-config": "2.0.11",
+    "@form8ion/eslint-config": "7.0.14",
     "@form8ion/eslint-config-cucumber": "1.4.1",
-    "@form8ion/remark-lint-preset": "6.0.6",
-    "@travi/any": "3.1.2",
-    "c8": "10.1.3",
-    "chai": "5.1.2",
-    "cross-env": "7.0.3",
+    "@form8ion/remark-lint-preset": "6.0.7",
+    "@travi/any": "3.3.0",
+    "c8": "11.0.0",
+    "chai": "6.2.2",
+    "cross-env": "10.1.0",
     "cz-conventional-changelog": "3.3.0",
     "gherkin-lint": "4.2.4",
     "husky": "9.1.7",
-    "jest-when": "3.7.0",
-    "lockfile-lint": "4.14.0",
-    "ls-engines": "0.9.3",
-    "mock-fs": "5.4.1",
-    "npm-run-all2": "7.0.2",
-    "publint": "0.3.2",
+    "lockfile-lint": "5.0.0",
+    "ls-engines": "0.9.4",
+    "mock-fs": "5.5.0",
+    "npm-run-all2": "8.0.4",
+    "publint": "0.3.18",
     "remark-cli": "12.0.1",
     "remark-toc": "9.0.0",
     "remark-usage": "11.0.1",
-    "rimraf": "6.0.1",
-    "rollup": "4.32.1",
+    "rimraf": "6.1.3",
+    "rollup": "4.60.1",
     "rollup-plugin-auto-external": "2.0.0",
     "testdouble": "3.20.2",
-    "vitest": "3.0.5"
+    "vitest": "4.1.4",
+    "vitest-when": "0.10.0"
   }
 }

package/src/attributes/index.js

@@ -0,0 +1 @@
+export {default as scaffold} from './scaffolder.js';

package/src/attributes/scaffolder.js

@@ -0,0 +1,5 @@
+import {promises as fs} from 'node:fs';
+
+export default function ({projectRoot}) {
+  return fs.writeFile(`${projectRoot}/.gitattributes`, '* text=auto');
+}

package/src/attributes/scaffolder.test.js

@@ -0,0 +1,18 @@
+import {promises as fs} from 'node:fs';
+
+import {describe, expect, it, vi} from 'vitest';
+import any from '@travi/any';
+
+import scaffoldAttributes from './scaffolder.js';
+
+vi.mock('node:fs');
+
+describe('attributes scaffolder', () => {
+  it('should create the attributes file', async () => {
+    const projectRoot = any.string();
+
+    await scaffoldAttributes({projectRoot});
+
+    expect(fs.writeFile).toHaveBeenCalledWith(`${projectRoot}/.gitattributes`, '* text=auto');
+  });
+});

package/src/ignore/appender.js

@@ -0,0 +1,13 @@
+import gitignoreExists from './existence-checker.js';
+import readGitIgnore from './reader.js';
+import writeGitIgnore from './writer.js';
+
+export default async function appendToIgnoreFile({projectRoot, ignores}) {
+  let existingIgnores = [];
+
+  if (await gitignoreExists({projectRoot})) {
+    existingIgnores = await readGitIgnore({projectRoot});
+  }
+
+  await writeGitIgnore({projectRoot, ignores: [...existingIgnores, ...ignores]});
+}

package/src/ignore/appender.test.js

@@ -0,0 +1,36 @@
+import {describe, it, vi, expect} from 'vitest';
+// eslint-disable-next-line import/no-unresolved
+import {when} from 'vitest-when';
+import any from '@travi/any';
+
+import gitignoreExists from './existence-checker.js';
+import read from './reader.js';
+import write from './writer.js';
+import appendToIgnoreFile from './appender.js';
+
+vi.mock('./existence-checker.js');
+vi.mock('./reader.js');
+vi.mock('./writer.js');
+
+describe('gitignore appender', () => {
+  const projectRoot = any.string();
+  const ignores = any.listOf(any.string);
+
+  it('should add the provided ignores to the existing gitignore', async () => {
+    const existingIgnores = any.listOf(any.string);
+    when(gitignoreExists).calledWith({projectRoot}).thenResolve(true);
+    when(read).calledWith({projectRoot}).thenResolve(existingIgnores);
+
+    await appendToIgnoreFile({projectRoot, ignores});
+
+    expect(write).toHaveBeenCalledWith({projectRoot, ignores: [...existingIgnores, ...ignores]});
+  });
+
+  it('should write only the provided ignores when the ignore file does not yet exist', async () => {
+    when(gitignoreExists).calledWith({projectRoot}).thenResolve(false);
+
+    await appendToIgnoreFile({projectRoot, ignores});
+
+    expect(write).toHaveBeenCalledWith({projectRoot, ignores});
+  });
+});

package/src/ignore/existence-checker.js

@@ -0,0 +1,5 @@
+import {exists} from '@form8ion/ignore-file';
+
+export default function gitignoreExists({projectRoot} = {}) {
+  return exists({projectRoot, name: 'git'});
+}

package/src/ignore/existence-checker.test.js

@@ -0,0 +1,20 @@
+import {exists} from '@form8ion/ignore-file';
+
+import {it, describe, vi, expect} from 'vitest';
+import any from '@travi/any';
+// eslint-disable-next-line import/no-unresolved
+import {when} from 'vitest-when';
+
+import gitignoreExists from './existence-checker.js';
+
+vi.mock('@form8ion/ignore-file');
+
+describe('gitignore existence checker', () => {
+  it('should check for existence of the gitignore', async () => {
+    const projectRoot = any.string();
+    const fileExists = any.boolean();
+    when(exists).calledWith({projectRoot, name: 'git'}).thenResolve(fileExists);
+
+    expect(await gitignoreExists({projectRoot})).toBe(fileExists);
+  });
+});

package/src/ignore/index.js

@@ -0,0 +1,3 @@
+export {default as scaffold} from './scaffolder.js';
+export {default as test} from './tester.js';
+export {default as lift} from './lifter.js';

package/src/ignore/lifter.js

@@ -0,0 +1,15 @@
+import {info} from '@travi/cli-messages';
+
+import appendIgnores from './appender.js';
+
+export default async function ({projectRoot, results: {vcsIgnore}}) {
+  if (vcsIgnore) {
+    info('Updating files and directories to be ignored from version control', {level: 'secondary'});
+
+    const {directories = [], files = []} = vcsIgnore;
+
+    await appendIgnores({projectRoot, ignores: [...directories, ...files]});
+  }
+
+  return {};
+}

package/src/ignore/lifter.test.js

@@ -0,0 +1,41 @@
+import {describe, expect, it, vi} from 'vitest';
+import any from '@travi/any';
+
+import appendToIgnores from './appender.js';
+import liftGitIgnore from './lifter.js';
+
+vi.mock('./appender.js');
+
+describe('gitignore lifter', () => {
+  const projectRoot = any.string();
+  const ignoredDirectories = any.listOf(any.word);
+  const ignoredFiles = any.listOf(any.word);
+
+  it('should append the provided ignores to the gitignore file', async () => {
+    expect(
+      await liftGitIgnore({projectRoot, results: {vcsIgnore: {directories: ignoredDirectories, files: ignoredFiles}}})
+    ).toEqual({});
+
+    expect(appendToIgnores).toHaveBeenCalledWith({projectRoot, ignores: [...ignoredDirectories, ...ignoredFiles]});
+  });
+
+  it('should append provided directories to ignore', async () => {
+    expect(await liftGitIgnore({projectRoot, results: {vcsIgnore: {directories: ignoredDirectories}}}))
+      .toEqual({});
+
+    expect(appendToIgnores).toHaveBeenCalledWith({projectRoot, ignores: ignoredDirectories});
+  });
+
+  it('should append provided directories to ignore', async () => {
+    expect(await liftGitIgnore({projectRoot, results: {vcsIgnore: {files: ignoredFiles}}}))
+      .toEqual({});
+
+    expect(appendToIgnores).toHaveBeenCalledWith({projectRoot, ignores: ignoredFiles});
+  });
+
+  it('should not update the ignore file if no additional ignores are provided', async () => {
+    expect(await liftGitIgnore({projectRoot, results: {}})).toEqual({});
+
+    expect(appendToIgnores).not.toHaveBeenCalledWith({projectRoot});
+  });
+});

package/src/ignore/reader.js

@@ -0,0 +1,5 @@
+import {read} from '@form8ion/ignore-file';
+
+export default function readGitIgnore({projectRoot}) {
+  return read({projectRoot, name: 'git'});
+}

package/src/ignore/reader.test.js

@@ -0,0 +1,20 @@
+import {read} from '@form8ion/ignore-file';
+
+import {it, describe, vi, expect} from 'vitest';
+import any from '@travi/any';
+// eslint-disable-next-line import/no-unresolved
+import {when} from 'vitest-when';
+
+import readGitIgnore from './reader.js';
+
+vi.mock('@form8ion/ignore-file');
+
+describe('gitignore reader', () => {
+  it('should read the contents of the .gitignore file', async () => {
+    const projectRoot = any.string();
+    const existingIgnores = any.listOf(any.word);
+    when(read).calledWith({projectRoot, name: 'git'}).thenResolve(existingIgnores);
+
+    expect(await readGitIgnore({projectRoot})).toEqual(existingIgnores);
+  });
+});

package/src/ignore/scaffolder.js

@@ -0,0 +1,5 @@
+import write from './writer.js';
+
+export default function ({projectRoot}) {
+  return write({projectRoot, ignores: []});
+}

package/src/ignore/scaffolder.test.js

@@ -0,0 +1,17 @@
+import {describe, expect, it, vi} from 'vitest';
+import any from '@travi/any';
+
+import writeGitIgnore from './writer.js';
+import scaffold from './scaffolder.js';
+
+vi.mock('./writer.js');
+
+describe('ignore scaffolder', () => {
+  const projectRoot = any.string();
+
+  it('should write the directories and files', async () => {
+    await scaffold({projectRoot});
+
+    expect(writeGitIgnore).toHaveBeenCalledWith({projectRoot, ignores: []});
+  });
+});

package/src/ignore/tester.js

@@ -0,0 +1,5 @@
+import {fileExists} from '@form8ion/core';
+
+export default function ({projectRoot}) {
+  return fileExists(`${projectRoot}/.gitignore`);
+}

package/src/ignore/tester.test.js

@@ -0,0 +1,30 @@
+import {fileExists} from '@form8ion/core';
+
+import {describe, it, expect, vi, afterEach} from 'vitest';
+import any from '@travi/any';
+// eslint-disable-next-line import/no-unresolved
+import {when} from 'vitest-when';
+
+import gitignoreExists from './tester.js';
+
+vi.mock('@form8ion/core');
+
+describe('gitignore tester', () => {
+  const projectRoot = any.string();
+
+  afterEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it('should return `true` if a `.gitignore` file exists', async () => {
+    when(fileExists).calledWith(`${projectRoot}/.gitignore`).thenResolve(true);
+
+    expect(await gitignoreExists({projectRoot})).toBe(true);
+  });
+
+  it('should return `false` if a `.gitignore` file does not exist', async () => {
+    when(fileExists).calledWith(`${projectRoot}/.gitignore`).thenResolve(false);
+
+    expect(await gitignoreExists({projectRoot})).toBe(false);
+  });
+});

package/src/ignore/writer.js

@@ -0,0 +1,5 @@
+import {write} from '@form8ion/ignore-file';
+
+export default function writeGitIgnore({projectRoot, ignores}) {
+  return write({projectRoot, name: 'git', ignores});
+}

package/src/ignore/writer.test.js

@@ -0,0 +1,19 @@
+import {write} from '@form8ion/ignore-file';
+
+import {describe, it, vi, expect} from 'vitest';
+import any from '@travi/any';
+
+import writeGitIgnore from './writer.js';
+
+vi.mock('@form8ion/ignore-file');
+
+describe('gitignore writer', () => {
+  it('should write the provided ignores to the .gitignore file', async () => {
+    const projectRoot = any.string();
+    const ignores = any.listOf(any.string);
+
+    await writeGitIgnore({projectRoot, ignores});
+
+    expect(write).toHaveBeenCalledWith({projectRoot, name: 'git', ignores});
+  });
+});

package/src/index.js

@@ -0,0 +1,3 @@
+export {default as scaffold} from './scaffolder.js';
+export {default as test} from './tester.js';
+export {default as lift} from './lifter.js';

package/src/lifter.js

@@ -0,0 +1,11 @@
+import {scaffold as scaffoldAttributes} from './attributes/index.js';
+import {lift as liftIgnore} from './ignore/index.js';
+
+export default async function ({projectRoot, results}) {
+  await Promise.all([
+    scaffoldAttributes({projectRoot}),
+    liftIgnore({projectRoot, results})
+  ]);
+
+  return {};
+}

package/src/lifter.test.js

@@ -0,0 +1,22 @@
+import any from '@travi/any';
+import {describe, expect, it, vi} from 'vitest';
+
+import {scaffold as scaffoldAttributes} from './attributes/index.js';
+import {lift as liftIgnore} from './ignore/index.js';
+import lift from './lifter.js';
+
+vi.mock('./attributes/index.js');
+vi.mock('./ignore/index.js');
+
+describe('git lifter', () => {
+  it('should define the attributes file', async () => {
+    const projectRoot = any.string();
+    const results = any.simpleObject();
+
+    const result = await lift({projectRoot, results});
+
+    expect(result).toEqual({});
+    expect(scaffoldAttributes).toHaveBeenCalledWith({projectRoot});
+    expect(liftIgnore).toHaveBeenCalledWith({projectRoot, results});
+  });
+});

package/src/scaffolder.js

@@ -0,0 +1,17 @@
+import simpleGit from 'simple-git';
+import {info} from '@travi/cli-messages';
+
+import {scaffold as scaffoldIgnore} from './ignore/index.js';
+
+export default async function ({projectRoot}) {
+  info('Initializing Git Repository');
+
+  const git = simpleGit({baseDir: projectRoot});
+
+  await Promise.all([
+    scaffoldIgnore({projectRoot}),
+    git.init()
+  ]);
+
+  return {};
+}

package/src/scaffolder.test.js

@@ -0,0 +1,27 @@
+import * as simpleGit from 'simple-git';
+
+import any from '@travi/any';
+import {describe, expect, it, vi} from 'vitest';
+// eslint-disable-next-line import/no-unresolved
+import {when} from 'vitest-when';
+
+import {scaffold as scaffoldIgnore} from './ignore/index.js';
+import scaffold from './scaffolder.js';
+
+vi.mock('touch');
+vi.mock('simple-git');
+vi.mock('./ignore/index.js');
+
+describe('scaffold', () => {
+  it('should initialize the repo', async () => {
+    const projectRoot = any.string();
+    const init = vi.fn();
+    when(simpleGit.simpleGit).calledWith({baseDir: projectRoot}).thenReturn({init});
+
+    const results = await scaffold({projectRoot});
+
+    expect(results).toEqual({});
+    expect(init).toHaveBeenCalled();
+    expect(scaffoldIgnore).toHaveBeenCalledWith({projectRoot});
+  });
+});

package/src/tester.js

@@ -0,0 +1,7 @@
+import simpleGit from 'simple-git';
+
+export default function ({projectRoot}) {
+  const git = simpleGit({baseDir: projectRoot});
+
+  return git.checkIsRepo('root');
+}

package/src/tester.test.js

@@ -0,0 +1,35 @@
+import * as simpleGit from 'simple-git';
+
+import any from '@travi/any';
+import {beforeEach, describe, it, expect, vi} from 'vitest';
+// eslint-disable-next-line import/no-unresolved
+import {when} from 'vitest-when';
+
+import gitIsPresent from './tester.js';
+
+vi.mock('simple-git');
+
+describe('git predicate', () => {
+  let checkIsRepo;
+  const projectRoot = any.string();
+
+  beforeEach(() => {
+    checkIsRepo = vi.fn();
+
+    when(simpleGit.simpleGit)
+      .calledWith({baseDir: projectRoot})
+      .thenReturn({checkIsRepo});
+  });
+
+  it('should return `true` if a `.gitignore` file exists', async () => {
+    when(checkIsRepo).calledWith('root').thenResolve(true);
+
+    expect(await gitIsPresent({projectRoot})).toBe(true);
+  });
+
+  it('should return `false` if a `.gitignore` file does not exist', async () => {
+    when(checkIsRepo).calledWith('root').thenResolve(false);
+
+    expect(await gitIsPresent({projectRoot})).toBe(false);
+  });
+});