import { Octokit } from '@octokit/rest'
import fs from 'fs'
import { commit, utf8, base64 } from 'github-tree'
 
const tree = {
  'README.md': utf8(`# A cool README!`),
  'src/index.ts': base64(fs.readFileSync('/path.ts', { encoding: 'base64' })),
}
 
await commit({
  owner: 'maticzav',
  repo: 'label-sync',
  message: 'Additions from our server',
  ref: 'heads/master',
  tree,
})

import { commit, loadTreeFromPath } from 'github-tree'
 
const tree = loadTreeFromPath(PATH_TO_TREE, [
  'ignored_folders',
  'node_nodules',
  /.*regex./,
])
 
// ...
 
await commit(_, {
  tree,
})

/* Tree */
 
type Tree = { [path: string]: File }
 
/**
 * Creates an utf-8 encoded file.
 */
export function utf8(content: string): File
 
/**
 * Creates a base64 encoded file.
 */
export function base64(content: string): File
 
/* Github */
 
/**
 * Input variables for commit method.
 */
export type CommitInput = {
  /**
   * Name of the owner of the repository.
   */
  owner: string
  /**
   * Name of the repository.
   */
  repo: string
  /**
   * Message of a commit.
   */
  message: string
  /**
   * Make sure that your ref follows heads/<ref> format.
   */
  ref: string
  /**
   * Your files.
   */
  tree: Tree
}
 
/**
 * Create a commit to Github using Github API v3.
 */
async function commit(
  github: Octokit,
  commit: CommitInput,
): Promise<Octokit.GitCreateCommitResponse>
 
/* Utility functions */
 
/**
 * Loads a tree of utf-8 decoded files at paths.
 */
function loadTreeFromPath(root: string, ignore: (string | RegExp)[]): Tree
 
/**
 * Lets you map files asynchornously.
 */
async function mapFiles(
  tree: Tree,
  fn: (file: File, path: string) => Promise<File>,
): Promise<Tree>
 
/**
 * Lets you manipulate file paths.
 */
function mapPaths(tree: Tree, fn: (path: string, file: File) => string): Tree