feat(predicate): enable detecting use of github to version the project

Author: travi

README.md

@@ -56,24 +56,46 @@ 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.
 
+### Enabling repository configuration with `repository-settings/app`
+
+* Be sure to [install](https://github.com/apps/settings) for the user or
+  organization account that you are scaffolding the new project for.
+* Enable the settings app for all repositories in the account
+
+#### Account-level settings
+
+The settings file generated by this tool assumes that it is extending an
+[account level config](https://github.com/probot/probot-config#recipes)
+
+* Ensure that you have created a `.github` repository in your account
+* Create an [account-level settings file](https://github.com/probot/settings#inheritance)
+  in the `.github` repository at the location `.github/settings.yml` within the
+  repository
+  * for an organization account, [this is a good example](https://github.com/form8ion/.github/blob/master/.github/settings.yml)
+  * for a user account, [this is a good example](https://github.com/travi/.github/blob/master/.github/settings.yml)
+
 ### Example
 
 #### Import
 
 ```javascript
-import {scaffold} from '@form8ion/github';
 import any from '@travi/any';
+import {scaffold, test} from '@form8ion/github';
 ```
 
 #### Execute
 
 ```javascript
+const projectRoot = process.cwd();
+
 await scaffold({
-  projectRoot: process.cwd(),
+  projectRoot,
   name: 'foo',
   owner: 'travi',
   visibility: any.fromList(['Public', 'Private'])
 });
+
+await test({projectRoot});
 ```
 
 ## Contributing

example.js

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

package-lock.json

@@ -56,7 +56,6 @@
   "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",
@@ -85,6 +84,7 @@
     "vitest": "1.6.0"
   },
   "dependencies": {
+    "@form8ion/core": "^4.3.0",
     "@octokit/rest": "^20.0.0",
     "@travi/cli-messages": "^1.1.1",
     "octokit-auth-netrc": "^3.1.1"

package.json

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

src/index.js

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

src/tester.js

@@ -0,0 +1,25 @@
+import {directoryExists} from '@form8ion/core';
+
+import any from '@travi/any';
+import {when} from 'jest-when';
+import {describe, expect, it, vi} from 'vitest';
+
+import projectIsVersionedOnGithub from './tester.js';
+
+vi.mock('@form8ion/core');
+
+describe('github predicate', () => {
+  const projectRoot = any.string();
+
+  it('should return `true` when the `.github` directory is present', async () => {
+    when(directoryExists).calledWith(`${projectRoot}/.github`).mockResolvedValue(true);
+
+    expect(await projectIsVersionedOnGithub({projectRoot})).toBe(true);
+  });
+
+  it('should return `false` when the `.github` directory is not present', async () => {
+    when(directoryExists).calledWith(`${projectRoot}/.github`).mockResolvedValue(false);
+
+    expect(await projectIsVersionedOnGithub({projectRoot})).toBe(false);
+  });
+});