@form8ion/git 1.0.0-alpha.3 → 1.0.0-alpha.5

package/README.md

@@ -12,7 +12,22 @@ form8ion plugin for managing projects versioned with git
 
 ## Table of Contents
 
-Run `npm run generate:md` to generate a table of contents
+* [Features](#features)
+* [Usage](#usage)
+  * [Installation](#installation)
+  * [Example](#example)
+    * [Import](#import)
+    * [Execute](#execute)
+* [Contributing](#contributing)
+  * [Dependencies](#dependencies)
+  * [Verification](#verification)
+
+## Features
+
+* Initializes a git repository for a project
+* Configures git to handle line endings across operating systems
+* Manages ignoring files and directories from being versioned
+* Detects an existing git repository configured for a project
 
 ## Usage
 
@@ -21,6 +36,7 @@ Run `npm run generate:md` to generate a table of contents
 [![MIT license][license-badge]][license-link]
 [![npm][npm-badge]][npm-link]
 [![Try @form8ion/git on RunKit][runkit-badge]][runkit-link]
+![node][node-badge]
 
 <!--consumer-badges end -->
 
@@ -32,7 +48,23 @@ $ npm install @form8ion/git --save-prod
 
 ### Example
 
-run `npm run generate:md` to inject the usage example
+#### Import
+
+```javascript
+import {scaffold, test, lift} from '@form8ion/git';
+```
+
+#### Execute
+
+```javascript
+const projectRoot = process.cwd();
+
+await scaffold({projectRoot});
+
+if (await test({projectRoot})) {
+  await lift({projectRoot});
+}
+```
 
 ## Contributing
 
@@ -100,3 +132,5 @@ $ npm test
 [runkit-link]: https://npm.runkit.com/@form8ion/git
 
 [runkit-badge]: https://badge.runkitcdn.com/@form8ion/git.svg
+
+[node-badge]: https://img.shields.io/node/v/@form8ion/git?logo=node.js

package/example.js

@@ -1,13 +1,17 @@
 // #### Import
 // remark-usage-ignore-next
 import stubbedFs from 'mock-fs';
-import {scaffold} from './lib/index.js';
+import {scaffold, test, lift} from './lib/index.js';
 
 // remark-usage-ignore-next
 stubbedFs();
 
 // #### Execute
 
-(async () => {
-  await scaffold({projectRoot: process.cwd()});
-})();
+const projectRoot = process.cwd();
+
+await scaffold({projectRoot});
+
+if (await test({projectRoot})) {
+  await lift({projectRoot});
+}

package/lib/index.js

@@ -1,18 +1,35 @@
-import { promises } from 'node:fs';
 import touch from 'touch';
 import simpleGit from 'simple-git';
+import { info } from '@travi/cli-messages';
+import { fileExists } from '@form8ion/core';
+import { promises } from 'node:fs';
 
 async function scaffolder ({projectRoot}) {
+  info('Initializing Git Repository');
+
   const git = simpleGit({baseDir: projectRoot});
 
   await Promise.all([
     touch(`${projectRoot}/.gitignore`),
-    promises.writeFile(`${projectRoot}/.gitattributes`, '* text=auto'),
     git.init()
   ]);
 
   return {};
 }
 
-export { scaffolder as scaffold };
+function tester ({projectRoot}) {
+  return fileExists(`${projectRoot}/.gitignore`);
+}
+
+function scaffoldAttributes ({projectRoot}) {
+  return promises.writeFile(`${projectRoot}/.gitattributes`, '* text=auto');
+}
+
+async function lifter ({projectRoot}) {
+  await scaffoldAttributes({projectRoot});
+
+  return {};
+}
+
+export { lifter as lift, scaffolder as scaffold, tester as test };
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/scaffolder.js"],"sourcesContent":["import {promises as fs} from 'node:fs';\nimport touch from 'touch';\nimport simpleGit from 'simple-git';\n\nexport default async function ({projectRoot}) {\n  const git = simpleGit({baseDir: projectRoot});\n\n  await Promise.all([\n    touch(`${projectRoot}/.gitignore`),\n    fs.writeFile(`${projectRoot}/.gitattributes`, '* text=auto'),\n    git.init()\n  ]);\n\n  return {};\n}\n"],"names":["fs"],"mappings":";;;;AAIe,yBAAc,EAAE,CAAC,WAAW,CAAC,EAAE;AAC9C,EAAE,MAAM,GAAG,GAAG,SAAS,CAAC,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC;AAChD;AACA,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC;AACpB,IAAI,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC;AACtC,IAAIA,QAAE,CAAC,SAAS,CAAC,CAAC,EAAE,WAAW,CAAC,eAAe,CAAC,EAAE,aAAa,CAAC;AAChE,IAAI,GAAG,CAAC,IAAI,EAAE;AACd,GAAG,CAAC,CAAC;AACL;AACA,EAAE,OAAO,EAAE,CAAC;AACZ;;;;"}
+{"version":3,"file":"index.js","sources":["../src/scaffolder.js","../src/tester.js","../src/attributes/scaffolder.js","../src/lifter.js"],"sourcesContent":["import touch from 'touch';\nimport simpleGit from 'simple-git';\nimport {info} from '@travi/cli-messages';\n\nexport default async function ({projectRoot}) {\n  info('Initializing Git Repository');\n\n  const git = simpleGit({baseDir: projectRoot});\n\n  await Promise.all([\n    touch(`${projectRoot}/.gitignore`),\n    git.init()\n  ]);\n\n  return {};\n}\n","import {fileExists} from '@form8ion/core';\n\nexport default function ({projectRoot}) {\n  return fileExists(`${projectRoot}/.gitignore`);\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';\n\nexport default async function ({projectRoot}) {\n  await scaffoldAttributes({projectRoot});\n\n  return {};\n}\n"],"names":["fs"],"mappings":";;;;;;AAIe,yBAAc,EAAE,CAAC,WAAW,CAAC,EAAE;AAC9C,EAAE,IAAI,CAAC,6BAA6B,CAAC,CAAC;AACtC;AACA,EAAE,MAAM,GAAG,GAAG,SAAS,CAAC,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC;AAChD;AACA,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC;AACpB,IAAI,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC;AACtC,IAAI,GAAG,CAAC,IAAI,EAAE;AACd,GAAG,CAAC,CAAC;AACL;AACA,EAAE,OAAO,EAAE,CAAC;AACZ;;ACbe,eAAQ,EAAE,CAAC,WAAW,CAAC,EAAE;AACxC,EAAE,OAAO,UAAU,CAAC,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC;AACjD;;ACFe,2BAAQ,EAAE,CAAC,WAAW,CAAC,EAAE;AACxC,EAAE,OAAOA,QAAE,CAAC,SAAS,CAAC,CAAC,EAAE,WAAW,CAAC,eAAe,CAAC,EAAE,aAAa,CAAC,CAAC;AACtE;;ACFe,qBAAc,EAAE,CAAC,WAAW,CAAC,EAAE;AAC9C,EAAE,MAAM,kBAAkB,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;AAC1C;AACA,EAAE,OAAO,EAAE,CAAC;AACZ;;;;"}

package/package.json

@@ -2,8 +2,11 @@
   "name": "@form8ion/git",
   "description": "form8ion plugin for managing projects versioned with git",
   "license": "MIT",
-  "version": "1.0.0-alpha.3",
+  "version": "1.0.0-alpha.5",
   "type": "module",
+  "engines": {
+    "node": "^18.17 || >=20.6.1"
+  },
   "author": "Matt Travi <npm@travi.org> (https://matt.travi.org)",
   "repository": "form8ion/git",
   "bugs": "https://github.com/form8ion/git/issues",
@@ -38,7 +41,8 @@
     "lint:js": "eslint . --cache",
     "lint:js:fix": "run-s 'lint:js -- --fix'",
     "lint:publish": "publint --strict",
-    "test": "npm-run-all --print-label build --parallel lint:* --parallel test:*"
+    "test": "npm-run-all --print-label build --parallel lint:* --parallel test:*",
+    "lint:engines": "ls-engines"
   },
   "files": [
     "example.js",
@@ -49,10 +53,15 @@
     "provenance": true
   },
   "packageManager": "npm@10.8.1+sha256.b8807aebb9656758e2872fa6e7c564b506aa2faa9297439a478d471d2fe32483",
+  "dependencies": {
+    "@form8ion/core": "^4.3.0",
+    "@travi/cli-messages": "^1.1.1",
+    "simple-git": "^3.25.0",
+    "touch": "^3.1.1"
+  },
   "devDependencies": {
     "@cucumber/cucumber": "10.8.0",
     "@form8ion/commitlint-config": "1.0.76",
-    "@form8ion/core": "4.3.0",
     "@form8ion/eslint-config": "7.0.9",
     "@form8ion/eslint-config-cucumber": "1.4.1",
     "@form8ion/remark-lint-preset": "6.0.3",
@@ -65,6 +74,7 @@
     "husky": "9.0.11",
     "jest-when": "3.6.0",
     "lockfile-lint": "4.14.0",
+    "ls-engines": "0.9.2",
     "mock-fs": "5.2.0",
     "npm-run-all2": "6.2.0",
     "publint": "0.2.8",
@@ -76,9 +86,5 @@
     "rollup-plugin-auto-external": "2.0.0",
     "testdouble": "3.20.2",
     "vitest": "1.6.0"
-  },
-  "dependencies": {
-    "simple-git": "^3.25.0",
-    "touch": "^3.1.1"
   }
 }