@form8ion/git 1.0.0-alpha.1

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2024 Matt Travi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of 
+this software and associated documentation files (the "Software"), to deal in 
+the Software without restriction, including without limitation the rights to 
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 
+the Software, and to permit persons to whom the Software is furnished to do so, 
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all 
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,102 @@
+# git
+
+form8ion plugin for managing projects versioned with git
+
+<!--status-badges start -->
+
+[![Node CI Workflow Status][github-actions-ci-badge]][github-actions-ci-link]
+[![Codecov][coverage-badge]][coverage-link]
+![SLSA Level 2][slsa-badge]
+
+<!--status-badges end -->
+
+## Table of Contents
+
+Run `npm run generate:md` to generate a table of contents
+
+## Usage
+
+<!--consumer-badges start -->
+
+[![MIT license][license-badge]][license-link]
+[![npm][npm-badge]][npm-link]
+[![Try @form8ion/git on RunKit][runkit-badge]][runkit-link]
+
+<!--consumer-badges end -->
+
+### Installation
+
+```sh
+$ npm install @form8ion/git --save-prod
+```
+
+### Example
+
+run `npm run generate:md` to inject the usage example
+
+## Contributing
+
+<!--contribution-badges start -->
+
+[![Commitizen friendly][commitizen-badge]][commitizen-link]
+[![Conventional Commits][commit-convention-badge]][commit-convention-link]
+[![semantic-release: angular][semantic-release-badge]][semantic-release-link]
+[![Renovate][renovate-badge]][renovate-link]
+[![PRs Welcome][PRs-badge]][PRs-link]
+
+<!--contribution-badges end -->
+
+### Dependencies
+
+```sh
+$ nvm install
+$ npm install
+```
+
+### Verification
+
+```sh
+$ npm test
+```
+
+[commitizen-link]: http://commitizen.github.io/cz-cli/
+
+[commitizen-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
+
+[commit-convention-link]: https://conventionalcommits.org
+
+[commit-convention-badge]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg
+
+[semantic-release-link]: https://github.com/semantic-release/semantic-release
+
+[semantic-release-badge]: https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release
+
+[renovate-link]: https://renovatebot.com
+
+[renovate-badge]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=renovatebot
+
+[PRs-link]: https://makeapullrequest.com
+
+[PRs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
+
+[github-actions-ci-link]: https://github.com/form8ion/git/actions?query=workflow%3A%22Node.js+CI%22+branch%3Amaster
+
+[github-actions-ci-badge]: https://img.shields.io/github/actions/workflow/status/form8ion/git/node-ci.yml.svg?branch=master&logo=github
+
+[coverage-link]: https://codecov.io/github/form8ion/git
+
+[coverage-badge]: https://img.shields.io/codecov/c/github/form8ion/git?logo=codecov
+
+[slsa-badge]: https://slsa.dev/images/gh-badge-level2.svg
+
+[license-link]: LICENSE
+
+[license-badge]: https://img.shields.io/github/license/form8ion/git.svg
+
+[npm-link]: https://www.npmjs.com/package/@form8ion/git
+
+[npm-badge]: https://img.shields.io/npm/v/@form8ion/git?logo=npm
+
+[runkit-link]: https://npm.runkit.com/@form8ion/git
+
+[runkit-badge]: https://badge.runkitcdn.com/@form8ion/git.svg

package/example.js

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

package/lib/index.js

@@ -0,0 +1,10 @@
+import touch from 'touch';
+
+async function scaffolder ({projectRoot}) {
+  await touch(`${projectRoot}/.gitignore`);
+
+  return {};
+}
+
+export { scaffolder as scaffold };
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/scaffolder.js"],"sourcesContent":["import touch from 'touch';\n\nexport default async function ({projectRoot}) {\n  await touch(`${projectRoot}/.gitignore`);\n\n  return {};\n}\n"],"names":[],"mappings":";;AAEe,yBAAc,EAAE,CAAC,WAAW,CAAC,EAAE;AAC9C,EAAE,MAAM,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC;AAC3C;AACA,EAAE,OAAO,EAAE,CAAC;AACZ;;;;"}

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@form8ion/git",
+  "description": "form8ion plugin for managing projects versioned with git",
+  "license": "MIT",
+  "version": "1.0.0-alpha.1",
+  "type": "module",
+  "author": "Matt Travi <npm@travi.org> (https://matt.travi.org)",
+  "repository": "form8ion/git",
+  "bugs": "https://github.com/form8ion/git/issues",
+  "homepage": "https://npm.im/@form8ion/git",
+  "runkitExampleFilename": "./example.js",
+  "exports": "./lib/index.js",
+  "main": "./lib/index.js",
+  "sideEffects": false,
+  "scripts": {
+    "build:js": "rollup --config",
+    "watch": "run-s 'build:js -- --watch'",
+    "clean": "rimraf ./lib",
+    "prebuild": "run-s clean",
+    "build": "npm-run-all --print-label --parallel build:*",
+    "prepack": "run-s build",
+    "pregenerate:md": "run-s build",
+    "test:unit": "cross-env NODE_ENV=test c8 run-s test:unit:base",
+    "test:unit:base": "DEBUG=any vitest run",
+    "lint:lockfile": "lockfile-lint",
+    "prepare": "husky",
+    "lint:md": "remark . --frail",
+    "generate:md": "remark . --output",
+    "lint:peer": "npm ls >/dev/null",
+    "pretest:integration:base": "run-s build",
+    "test:integration": "run-s 'test:integration:base -- --profile noWip'",
+    "test:integration:base": "NODE_OPTIONS=--enable-source-maps DEBUG=any cucumber-js test/integration",
+    "test:integration:debug": "DEBUG=test run-s test:integration",
+    "test:integration:wip": "run-s 'test:integration:base -- --profile wip'",
+    "test:integration:wip:debug": "DEBUG=test run-s 'test:integration:wip'",
+    "test:integration:focus": "run-s 'test:integration:base -- --profile focus'",
+    "lint:gherkin": "gherkin-lint --config=.gherkin-lintrc.json",
+    "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:*"
+  },
+  "files": [
+    "example.js",
+    "lib/"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "packageManager": "npm@10.8.1+sha256.b8807aebb9656758e2872fa6e7c564b506aa2faa9297439a478d471d2fe32483",
+  "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",
+    "@travi/any": "3.1.2",
+    "c8": "10.1.2",
+    "chai": "5.1.1",
+    "cross-env": "7.0.3",
+    "cz-conventional-changelog": "3.3.0",
+    "gherkin-lint": "4.2.4",
+    "husky": "9.0.11",
+    "jest-when": "3.6.0",
+    "lockfile-lint": "4.14.0",
+    "mock-fs": "5.2.0",
+    "npm-run-all2": "6.2.0",
+    "publint": "0.2.8",
+    "remark-cli": "12.0.1",
+    "remark-toc": "9.0.0",
+    "remark-usage": "11.0.1",
+    "rimraf": "5.0.7",
+    "rollup": "4.18.0",
+    "rollup-plugin-auto-external": "2.0.0",
+    "vitest": "1.6.0"
+  },
+  "dependencies": {
+    "touch": "^3.1.1"
+  }
+}