Merge pull request #5 from form8ion/alpha

Author: travi

.eslintrc.yml

@@ -8,3 +8,6 @@ overrides:
   - files: ./vitest.config.js
     rules:
       import/no-unresolved: off
+
+parserOptions:
+  ecmaVersion: 2022

.github/workflows/node-ci.yml

@@ -53,6 +53,6 @@ jobs:
       id-token: write
       issues: write
       pull-requests: write
-    uses: form8ion/.github/.github/workflows/release-package.yml@master
+    uses: form8ion/.github/.github/workflows/release-package-semantic-release-22.yml@master
     secrets:
       NPM_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}

.github/workflows/release.yml

@@ -12,6 +12,6 @@ jobs:
       id-token: write
       issues: write
       pull-requests: write
-    uses: form8ion/.github/.github/workflows/release-package.yml@master
+    uses: form8ion/.github/.github/workflows/release-package-semantic-release-22.yml@master
     secrets:
       NPM_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}

.nvmrc

@@ -1 +1 @@
-v20
+20.6.1

README.md

@@ -13,13 +13,25 @@ their git repository
 
 ## Table of Contents
 
+* [Features](#features)
+  * [Creation of GitHub repository](#creation-of-github-repository)
 * [Usage](#usage)
   * [Installation](#installation)
+  * [Enabling actions against the GitHub API](#enabling-actions-against-the-github-api)
   * [Example](#example)
+    * [Import](#import)
+    * [Execute](#execute)
 * [Contributing](#contributing)
   * [Dependencies](#dependencies)
   * [Verification](#verification)
 
+## Features
+
+### Creation of GitHub repository
+
+When [authentication is provided](#enabling-actions-against-the-github-api),
+a repository will be created on GitHub, assuming one does not already exist.
+
 ## Usage
 
 <!--consumer-badges start -->
@@ -37,20 +49,31 @@ their git repository
 $ npm install @form8ion/github --save-prod
 ```
 
+### Enabling actions against the GitHub API
+
+This plugin leverages the [.netrc strategy](https://github.com/travi/octokit-auth-netrc)
+for [octokit](https://github.com/octokit/rest.js/). Be sure to
+[add your personal access token](https://github.com/travi/octokit-auth-netrc#defining-your-token)
+to leverage the GitHub API integration benefits of this plugin.
+
 ### Example
 
 #### Import
 
 ```javascript
 import {scaffold} from '@form8ion/github';
+import any from '@travi/any';
 ```
 
 #### Execute
 
 ```javascript
-(async () => {
-  await scaffold({projectRoot: process.cwd()});
-})();
+await scaffold({
+  projectRoot: process.cwd(),
+  name: 'foo',
+  owner: 'travi',
+  visibility: any.fromList(['Public', 'Private'])
+});
 ```
 
 ## Contributing

example.js

@@ -1,13 +1,18 @@
 // #### Import
-// remark-usage-ignore-next
+// remark-usage-ignore-next 2
+import {resolve} from 'path';
 import stubbedFs from 'mock-fs';
+import any from '@travi/any';
 import {scaffold} from './lib/index.js';
 
 // remark-usage-ignore-next
-stubbedFs();
+stubbedFs({node_modules: stubbedFs.load(resolve('node_modules'))});
 
 // #### Execute
 
-(async () => {
-  await scaffold({projectRoot: process.cwd()});
-})();
+await scaffold({
+  projectRoot: process.cwd(),
+  name: 'foo',
+  owner: 'travi',
+  visibility: any.fromList(['Public', 'Private'])
+});