repository-settings

form8ion plugin for managing configuration for the repository-settings app for a project

Table of Contents

• Usage
  • Installation
  • Example
    • Import
    • Execute
• Contributing
  • Dependencies
  • Verification

Usage

Installation

$ npm install @form8ion/repository-settings --save-prod

Example

Import

import {Octokit} from '@octokit/core';
import any from '@travi/any';
import {scaffold, test as projectManagedByRepositorySettings, lift, promptConstants} from '@form8ion/repository-settings';

Execute

(async () => {
  const projectRoot = process.cwd();
  const logger = {
    info: message => console.error(message),
    success: message => console.error(message),
    warn: message => console.error(message),
    error: message => console.error(message)
  };

  await scaffold(
    {
      projectRoot,
      projectName: 'project-name',
      description: 'description of the project',
      homepage: 'https://npm.im/project-name',
      visibility: 'Public',
      topics: ['topic 1', 'topic 2']
    },
    {logger}
  );

  if (await projectManagedByRepositorySettings({projectRoot})) {
    await lift(
      {
        projectRoot,
        vcs: {owner: 'account-name', name: 'repository-name'},
        results: {
          homepage: 'https://npm.im/project-name',
          tags: ['tag1', 'tag2']
        }
      },
      {
        logger,
        octokit: new Octokit(),
        prompt: async ({id, questions}) => {
          const {questionNames, ids} = promptConstants;
          const expectedPromptId = ids.REQUIRED_CHECK_BYPASS;

          if (expectedPromptId === id) {
            const checkBypassTeamQuestionName = questionNames[expectedPromptId].CHECK_BYPASS_TEAM;

            return {
              [checkBypassTeamQuestionName]: questions
                .find(({name}) => name === checkBypassTeamQuestionName)
                .choices
                .find(({short}) => 'maintainers' === short).value
            };
          }

          throw new Error(`Unknown prompt with ID: ${id}`);
        }
      }
    );
  }
})();

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test