feat: add flag to ingore public, private or forked repos

Author: stefanbuck

README.md

@@ -27,14 +27,17 @@ npx octoherd-script-get-files \
 
 ## Options
 
-| option                                        | type             | description                                                                                                                                                                                                                                 |
-| --------------------------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `--source`                                    | string           | **Required.** File to download. This can also be a Glob see [example](#examples).                                                                                                                                                                                             |
-| `--output`                                    | string           | **Required.** Specify a path to place the downloaded file or directory (instead of using the current working directory). Directories specified in the path will be created by this command. |
-| `--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                                                                                                                                                                                                 |
+| option | type| description|
+| --- | --- | --- |
+| `--source` | string | **Required.** File to download. This can also be a Glob see [example](#examples).|
+| `--output` | string | **Required.** Specify a path to place the downloaded file or directory (instead of using the current working directory). Directories specified in the path will be created by this command. |
+| `--ignore-archived` or `--no-ignore-archived` | boolean | Default `true`. Ignores archive repositories|
+| `--ignore-forks` or `--no-ignore-forks` | boolean | Default `true`. Ignores forked repositories|
+| `--ignore-public` or `--no-ignore-public` | boolean | Default `false`. Ignores public repositories|
+| `--ignore-private` or `--no-ignore-private` | boolean | Default `false`. Ignores private 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|
 
 ## Examples
 

script.js

@@ -13,10 +13,13 @@ let hasRepoScope;
  * @param {import('@octoherd/cli').Repository} repository
  * @param {object} options
  * @param {boolean} [options.ignoreArchived] Ignores archive repositories
+ * @param {boolean} [options.ignoreForks] Ignores forks repositories
+ * @param {boolean} [options.ignorePublic] Ignores public repositories
+ * @param {boolean} [options.ignorePrivate] Ignores private repositories
  * @param {string} options.source Path to the destination directory
  * @param {string} options.output File path to download. Note: Directories are not supported yet
  */
-export async function script(octokit, repository, { source, output = process.cwd(), ignoreArchived = true }) {
+export async function script(octokit, repository, { source, output = process.cwd(), ignoreArchived = true, ignoreForks = true, ignorePublic = false, ignorePrivate = false }) {
   if (!hasRepoScope) {
     const { headers } = await octokit.request("HEAD /");
     const scopes = new Set(headers["x-oauth-scopes"].split(", "));
@@ -34,6 +37,21 @@ export async function script(octokit, repository, { source, output = process.cwd
     return;
   }
 
+  if (ignoreForks && repository.fork) {
+    octokit.log.warn(`IGNORE repository is a fork`);
+    return;
+  }
+
+  if (ignorePublic && !repository.private) {
+    octokit.log.warn(`IGNORE repository is public`);
+    return;
+  }
+
+  if (ignorePrivate && repository.private) {
+    octokit.log.warn(`IGNORE repository is private`);
+    return;
+  }
+
   if (!source) {
     octokit.log.error('Please specify a source file to download with --source=README.md')
     process.exit(1);