/**
 * The ReposConfiguration object contains information about your local repositories,
 * like their name and location on your local filesystem. Add repositories to this
 * configuration object to make a static site for them.
 * 
 * This static site generator works with both git and darcs repositories. Because of the
 * differences between these two version control systems, the configuration for them
 * looks a little different. Both types of configuration objects can be nested underneath
 * the {@link ReposConfiguration.repos} key.
 * 
 * You will also need to set the {@link ReposConfiguration.baseUrl} to the URL of your
 * live website.
 * @example
 * const config: ReposConfiguration = {
 *   baseUrl: "https://repos.tuckerm.us",
 *   repos: {
 *     "My Darcs Project": {
 *       _type: "darcs",
 *       defaultBranch: 'main',
 *       branches: {
 *         'main': {
 *           location: "/home/alice/projects/my_darcs_project",
 *           description: "Main branch of this project."
 *         },
 *         'drafts': {
 *           location: "/home/alice/projects/my_darcs_project_drafts/",
 *           description: "Some things that are a work in progress",
 *         },
 *       },
 *       languageExtensions: {
 *         "njk": "html",
 *       },
 *     },
 *   },
 * }
 */
export type ReposConfiguration = {
  repos: {
    /** An object containing the configuration for your repositories.
    * Each key in this object is a repository name, and the value has several
    * config options for that repository. The required config options describe
    * the path to the repository and which branches should be pulled. See the specific
    * definitions of {@link GitConfig} and {@link DarcsConfig} for more details
    * about what goes in these configuration objects.
    */
    [repoName: string]: GitConfig | DarcsConfig
  },
  /**
  * The root URL where this website will be. E.g.: https://blog.example.com/repos.
  * This URL will be used when a clone or pull command is being shown on your site.
  * @example baseUrl: "https://repos.tuckerm.us"
  */
  baseUrl: string,
  /**
  * The path to put the generated site in. All generated files will be put in this
  * directory, repos for cloning will be put in this directory, and it will be
  * added to the end of all URLs used by the default virtual template.
  * @example path: "/repos"
  */
  path?: string,
}

export type GitConfig = {
  _type: "git",
  /* The absolute path to the repository.
  * @example location: "/home/alice/projects/git_repo"
  */
  location: string,
  description?: string,
  defaultBranch: string,
  branchesToPull: Array<string>,
  languageExtensions?: {
    [fileExtension: string]: string
  }
}

/**
* A configuration object for a darcs repository.
*
* @example
* "My Darcs Project": {
*   _type: "darcs",
*   baseUrl: "https://repos.tuckerm.us",
*   defaultBranch: 'main',
*   branches: {
*     'main': {
*       location: "/home/alice/projects/my_darcs_project",
*       description: "Main branch of this project."
*     },
*     'drafts': {
*       location: "/home/alice/projects/my_darcs_project_drafts/",
*       description: "Some things that are a work in progress",
*     },
*   },
*   languageExtensions: {
*     "njk": "html",
*   },
* }
*/
export type DarcsConfig = {
  /** Must be set to `"darcs"`. */
  _type: "darcs",
  /**
  * The name of the default branch. Should match one of the keys in {@link DarcsConfig.branches}.
  * @example defaultBranch: "main"
  * */
  defaultBranch: string,
  /** The branches of this repository to generate pages for. Since darcs doesn't have
  * branches in the same way that other VCSs do, a "branch" in this case is an entirely
  * separate repository. So, these "branches" are more like repos that are grouped under
  * the same project name. That is why you need to specify a separate location for each
  * branch.
  * @example
  * branches: {
  *   main: {
  *     location: "/home/alice/projects/my-project/main",
  *     description: "The main release branch of this project."
  *   },
  *   drafts: {
  *     location: "/home/alice/projects/my-project/drafts",
  *     description: "Undeployed works-in-progress for this project."
  *   }
  * }
  */
  branches: {
    /**
    * Each key in this object will be the name that is used for that branch.
    */
    [branchName: string]: {
      /**
      * The absolute path to the repository for this branch.
      * @example location: "/home/alice/projects/darcs_repo_main"
      */
      location: string,
      /**
      * A description of this branch. You may want to clarify what this branch is used for here.
      */
      description?: string,
    }
  },
  /**
  * If your repository has any uncommon file extensions that should be treated like a different
  * type of file, list them here. If you include `{njk: "html"}` here, that will tell the
  * syntax highlighter to highlight an `njk` file like an `html` file. The key is the file
  * extension in your code, and the value is the file extension that the syntax highlighter
  * will know about.
  * @example
  * languageExtensions: {
  *   njk: "html",
  *   jss: "js",
  *   madeupformat: "txt"
  * }
  */
  languageExtensions?: {
    [fileExtension: string]: string
  }
}