feat: initial version

Author: stefanbuck

README.md

@@ -21,7 +21,6 @@ Pass all options as CLI flags to avoid user prompts
 npx octoherd-script-download-files \
   -T ghp_0123456789abcdefghjklmnopqrstuvwxyzA \
   -R "stefanbuck/*" \
-  --ignoreArchived undefined \
   --source README.md \
   --target ./out
 ```
@@ -30,9 +29,9 @@ npx octoherd-script-download-files \
 
 | option                                        | type             | description                                                                                                                                                                                                                                 |
 | --------------------------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `--ignore-archived` or `--no-ignore-archived` | boolean          | Ignores archive repositories                                                                                                                                                                                                                |
 | `--source`                                    | string           | **Required.** Path to the destination directory                                                                                                                                                                                             |
 | `--target`                                    | string           | **Required.** File path to download. Note: Directories are not supported yet                                                                                                                                                                |
+| `--ignore-archived` or `--no-ignore-archived` | boolean          | Default `true`. Ignores archive repositories                                                                                                                                                                                                                |
 | `--octoherd-token`, `-T`                      | string           | A personal access token ([create](https://github.com/settings/tokens/new?scopes=repo)). Script will create one if option is not set                                                                                                         |
 | `--octoherd-repos`, `-R`                      | array of strings | One or multiple space-separated repositories in the form of `repo-owner/repo-name`. `repo-owner/*` will find all repositories for one owner. `*` will find all repositories the user has access to. Will prompt for repositories if not set |
 | `--octoherd-bypass-confirms`                  | boolean          | Bypass prompts to confirm mutating requests                                                                                                                                                                                                 |

script.js

@@ -1,5 +1,12 @@
 // @ts-check
 
+import os from 'os'
+import fs from 'fs'
+import path from 'path'
+
+/** @type boolean */
+let hasRepoScope;
+
 /**
  * An Octoherd script to download files from repositories
  *
@@ -10,8 +17,63 @@
  * @param {string} options.source Path to the destination directory
  * @param {string} options.target File path to download. Note: Directories are not supported yet
  */
-export async function script(
-  octokit,
-  repository,
-  { ignoreArchived, source, target }
-) {}
+export async function script(octokit, repository, { source, target = process.cwd(), ignoreArchived = true }) {
+  if (!hasRepoScope) {
+    const { headers } = await octokit.request("HEAD /");
+    const scopes = new Set(headers["x-oauth-scopes"].split(", "));
+
+    if (!scopes.has("repo")) {
+      throw new Error(
+        `The "repo" scope is required for this script. Create a token at https://github.com/settings/tokens/new?scopes=repo then run the script with "-T <paste token here>"`
+      );
+    }
+    hasRepoScope = true;
+  }
+
+  if (ignoreArchived && repository.archived) {
+    octokit.log.warn(`IGNORE repository is archived`);
+    return;
+  }
+
+  if (!source) {
+    octokit.log.error('Please specify a source file to download with --source=README.md')
+    process.exit(1);
+  }
+
+  if (!target) {
+    octokit.log.error('Please specify a source file to download with --source=README.md --target=./out')
+    process.exit(1);
+  }
+
+  await octokit.request(
+    `GET /repos/{owner}/{repo}/contents/${source}`,
+    {
+      owner: repository.owner.login,
+      repo: repository.name,
+      headers: {
+        Accept: "application/vnd.github.v3.raw"
+      }
+    }
+  ).then((res) => {
+    octokit.log.info(`Download ${source}`);
+
+    // Expand the ~ character to a users home directory
+    const newTarget = target.replace("~", os.homedir)
+
+    const targetFile = path.join(newTarget, repository.owner.login, repository.name, source);
+    const targetPath = path.join(newTarget, repository.owner.login, repository.name, path.dirname(source));
+
+    if (!fs.existsSync(targetPath)) {
+      fs.mkdirSync(targetPath, { recursive: true });
+    }
+
+    fs.writeFileSync(targetFile, res.data)
+  }).catch(error => {
+    if (error.status === 404) {
+      octokit.log.warn(`File ${source} not found`);
+      return false;
+    }
+
+    throw error;
+  })
+}