feat: initial version (#1)

Author: gr2m

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  # https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/release.yml

@@ -0,0 +1,21 @@
+name: Release
+on:
+  push:
+    branches:
+      - main
+      - next
+      - beta
+      - "*.x" # maintenance releases
+
+jobs:
+  release:
+    name: release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+      - run: npm ci
+      - run: npx semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -0,0 +1 @@
+node_modules

bin/mutate-github-repositories.js

@@ -0,0 +1,37 @@
+#!/usr/bin/env node
+
+const yargs = require("yargs");
+
+const findGitHubReleases = require("..");
+
+var argv = yargs
+  .usage("Usage: $0 [options] [script] [repos...]")
+  .example(
+    "$0 --token 0123456789012345678901234567890123456789 octokit/rest.js"
+  )
+  .command("$0 [script] [repos...]", "", (yargs) => {
+    yargs.positional("script", {
+      demandOption: true,
+      describe: "Path to your *.js script",
+    });
+    yargs.positional("repos", {
+      demandOption: true,
+      describe: "One or multiple arrays in the form of 'repo-owner/repo-name'",
+      default: [],
+    });
+  })
+  .option("token", {
+    description:
+      'Requires the "public_repo" scope for public repositories, "repo" scope for private repositories.',
+    demandOption: true,
+    type: "string",
+  })
+  .option("cache", {
+    description: "Cache responses for debugging",
+    type: "boolean",
+    default: false,
+  })
+  .epilog("copyright 2020").argv;
+
+const { _, $0, ...options } = argv;
+findGitHubReleases(options).catch(console.error);

example.js

@@ -0,0 +1,20 @@
+module.exports = exampleScript;
+
+/**
+ * Example script that stars or unstars the passed repository based on the `--unstar` CLI option
+ *
+ * @param {import('@octokit/core').Octokit} octokit
+ * @param {object} repository Repository object as returned by the GitHub API, see https://docs.github.com/en/rest/reference/repos#get-a-repository
+ * @param {object} options Custom user options passed to the CLI
+ */
+async function exampleScript(octokit, repository, options) {
+  const method = options.unstar ? "DELETE" : "PUT";
+
+  // https://docs.github.com/en/rest/reference/activity#star-a-repository-for-the-authenticated-user
+  // https://docs.github.com/en/rest/reference/activity#unstar-a-repository-for-the-authenticated-user
+  await octokit.request("/user/starred/{owner}/{repo}", {
+    method,
+    owner: repository.owner.login,
+    repo: repository.name,
+  });
+}

index.js

@@ -0,0 +1,74 @@
+module.exports = mutateGithubRepositories;
+
+const { resolve } = require("path");
+
+const { Octokit: OctokitCore } = require("@octokit/core");
+const { paginateRest } = require("@octokit/plugin-paginate-rest");
+const { throttling } = require("@octokit/plugin-throttling");
+const { retry } = require("@octokit/plugin-retry");
+
+const { cache: octokitCachePlugin } = require("./lib/octokit-plugin-cache");
+const { resolveRepositories } = require("./lib/resolve-repositories");
+const { name, version } = require("./package.json");
+
+const Octokit = OctokitCore.plugin(paginateRest, throttling, retry).defaults({
+  log: console,
+  userAgent: [name, version].join("/"),
+  throttle: {
+    onAbuseLimit: (error, options) => {
+      octokit.log.error("onAbuseLimit", error, options);
+    },
+    onRateLimit: (error, options) => {
+      octokit.log.error("onRateLimit", error, options);
+    },
+  },
+});
+
+/**
+ * Find all releases in a GitHub repository or organization after a specified date
+ *
+ * @param {object} options
+ * @param {string} options.token Personal Access Token: Requires the "public_repo" scope for public repositories, "repo" scope for private repositories.
+ * @param {string} options.script Path to script to run against a repository
+ * @param {string} options.repos Array of repository names in the form of "repo-owner/repo-name". To match all repositories for an owner, pass "repo-owner/*"
+ * @param {boolean} options.cache Cache responses for debugging
+ */
+async function mutateGithubRepositories(
+  options = {
+    cache: false,
+    repos: [],
+  }
+) {
+  const { token, script, repos, cache, ...userOptions } = options;
+  const MyOctokit = cache ? Octokit.plugin(octokitCachePlugin) : Octokit;
+  const octokit = new MyOctokit({
+    auth: token,
+  });
+
+  let userScript;
+  try {
+    userScript = require(resolve(process.cwd(), script));
+  } catch (error) {
+    throw new Error(
+      `[mutate-github-repositories] ${script} script could not be found`
+    );
+  }
+
+  if (repos.length === 0) {
+    throw new Error("[mutate-github-repositories] No repositories provided");
+  }
+
+  state = {
+    log: console,
+    octokit,
+  };
+
+  const repositories = await resolveRepositories(state, repos);
+
+  for (const repository of repositories) {
+    console.log("Running %s on %s...", script, repository.full_name);
+    await userScript(octokit, repository, userOptions);
+  }
+
+  console.log("\ndone.");
+}

lib/octokit-plugin-cache.js

@@ -0,0 +1,31 @@
+module.exports = { cache };
+
+const { URL } = require("url");
+const { dirname } = require("path");
+
+const mkdirp = require("mkdirp");
+const { readFileSync, writeFileSync } = require("jsonfile");
+
+function cache(octokit) {
+  octokit.hook.wrap("request", async (request, options) => {
+    if (options.method !== "GET") {
+      return request(options);
+    }
+
+    const { url } = octokit.request.endpoint.parse(options);
+
+    const { pathname, searchParams } = new URL(url);
+    const page = searchParams.get("page");
+    const cachePath = `./cache${pathname}${page ? `-page-${page}` : ""}.json`;
+
+    try {
+      return readFileSync(cachePath);
+    } catch (error) {
+      const response = await request(options);
+
+      mkdirp.sync(dirname(cachePath));
+      writeFileSync(cachePath, response);
+      return response;
+    }
+  });
+}

lib/resolve-repositories.js

@@ -0,0 +1,62 @@
+module.exports = { resolveRepositories };
+
+async function resolveRepositories(state, repositories) {
+  const invalidRepositories = repositories.filter((fullName) => {
+    /^[a-z0-9_.-]+\/([a-z0-9_.-]+|\*)$/i.test(fullName);
+  });
+
+  if (invalidRepositories.length) {
+    throw new Error(
+      "[mutate-github-repositories] Invalid repositories: %o",
+      invalidRepositories
+    );
+  }
+
+  const repositoriesWithStars = repositories.filter((fullName) => {
+    return /^[a-z0-9_.-]+\/\*$/i.test(fullName);
+  });
+
+  const repositoriesWithoutStars = repositories.filter((fullName) => {
+    return !/^[a-z0-9_.-]+\/\*$/i.test(fullName);
+  });
+  const resolvedRepositories = [];
+
+  for (const name of repositoriesWithoutStars) {
+    const [owner, repo] = name.split("/");
+    const { data } = await state.octokit.request("/repos/{owner}/{repo}", {
+      owner,
+      repo,
+    });
+    resolvedRepositories.push(data);
+  }
+
+  for (const name of repositoriesWithStars) {
+    const owner = name.split("/")[0];
+    const isOrg = await state.octokit
+      .request("HEAD /orgs/:org", {
+        org: owner,
+      })
+      .then(
+        () => true,
+        () => false
+      );
+    const paginateReposRoute = isOrg
+      ? // https://docs.github.com/en/rest/reference/repos#list-organization-repositories
+        "GET /orgs/{owner}/repos"
+      : // https://docs.github.com/en/rest/reference/repos#list-repositories-for-a-user
+        "GET /users/{owner}/repos";
+
+    for await (const response of state.octokit.paginate.iterator(
+      paginateReposRoute,
+      {
+        owner,
+        per_page: 100,
+      }
+    )) {
+      resolvedRepositories.push(...response.data);
+    }
+  }
+
+  // return unique array (https://www.samanthaming.com/tidbits/43-3-ways-to-remove-array-duplicates/)
+  return [...new Set(resolvedRepositories)];
+}