Use GHA's token

.github/workflows/test.yml

@@ -94,3 +94,5 @@ jobs:
 
     - name: Run tests
       run: npm test
+      env:
+        AUTH_GITHUB: ${{ github.token }}

lib/flags.js

@@ -23,7 +23,7 @@ const gitHubAuthFlag = {
     'Follow https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token to create an API token. The API token needs access to public repositories.',
     '',
     'Then use the flag like this:',
-    chalk.greenBright('  --github-auth=my-user-name:abcdef01234567890')
+    chalk.greenBright('  --github-auth=github_pat_abcdef01234567890')
   ]
 };
 

lib/options.js

@@ -181,12 +181,7 @@ try re-running it with ${chalk.cyan('--elmjson <path-to-elm.json>')}.`,
 
   const forTests = args['FOR-TESTS'];
 
-  // eslint-disable-next-line unicorn/no-useless-undefined -- Bad TS type.
-  const {gitHubUser = undefined, gitHubPassword = undefined} = args[
-    'github-auth'
-  ]
-    ? parseGitHubAuth(subcommand, args['github-auth'])
-    : {};
+  const gitHubPat = parseGitHubAuth(subcommand, args['github-auth']);
 
   const localElmReviewSrc = process.env.LOCAL_ELM_REVIEW_SRC;
 
@@ -324,9 +319,8 @@ try re-running it with ${chalk.cyan('--elmjson <path-to-elm.json>')}.`,
     resultCachePath: (appHash) =>
       path.join(elmStuffFolder(), 'result-cache', appHash),
 
-    // GitHub tokens
-    gitHubUser,
-    gitHubPassword
+    // GitHub token
+    gitHubPat
   };
 }
 
@@ -653,12 +647,14 @@ I recommend you try to gain network access and try again.`,
 
 /**
  * @param {Subcommand | null} subcommand
- * @param {string} gitHubAuth
- * @returns {{gitHubUser: string | undefined, gitHubPassword: string | undefined} | never}
+ * @param {string | undefined} gitHubAuth
+ * @returns {string | undefined | never}
  */
 function parseGitHubAuth(subcommand, gitHubAuth) {
+  if (gitHubAuth === undefined) return;
+
   const split = gitHubAuth.split(':');
-  if (split.length !== 2) {
+  if (split.length !== 2 && split.length !== 1) {
     reportErrorAndExit(
       new ErrorMessage.CustomError(
         'INVALID FLAG ARGUMENT',
@@ -673,8 +669,7 @@ ${Flags.buildFlag(subcommand, Flags.gitHubAuthFlag)}`
     );
   }
 
-  const [gitHubUser, gitHubPassword] = split;
-  return {gitHubUser, gitHubPassword};
+  return split.length === 2 ? split[1] : split[0];
 }
 
 /**

lib/remote-template.js

@@ -197,21 +197,31 @@ ${error.message}`
   }
 }
 
-/** @type {ErrorMessageInfo} */
-const rateLimitErrorMessage = {
-  title: 'GITHUB RATE LIMIT EXCEEDED',
-  message: `It looks like you exceeded the GitHub rate limit by using "--template" too many
-times, this will likely last for 30 minutes.
-
-In the meantime, you can use \`--github-auth your-github-username:your-api-token\`.
-Follow this guide: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token to create an API token, and give it access to public repositories.
+/**
+ * @param {boolean} hasPat
+ * @param {string} resetTime
+ * @returns {ErrorMessageInfo}
+ */
+function rateLimitErrorMessage(hasPat, resetTime) {
+  return {
+    title: 'GITHUB RATE LIMIT EXCEEDED',
+    message: `It looks like you exceeded the GitHub rate limit by using "--template" too many
+times, this will likely last until ${resetTime}.
+${
+  hasPat
+    ? ''
+    : `
+In the meantime, you can use \`--github-auth=your-api-token\`.
+Follow this guide: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token to create an API token, and give it access to public repositories.`
+}
 
 To avoid this problem and to make the review process faster, consider setting up
 elm-review in your project:
 
     elm-review init
     elm-review init --template <some-configuration>`
-};
+  };
+}
 
 /**
  * @param {string} repoName
@@ -358,12 +368,11 @@ async function downloadFile(url, dest) {
  * @returns {Promise<unknown>}
  */
 async function makeGitHubApiRequest(options, url, handleNotFound) {
-  /** @type {OptionsOfJSONResponseBody}} */
-  const parameters = {responseType: 'json'};
-  if (options.gitHubUser && options.gitHubPassword) {
-    parameters.username = options.gitHubUser;
-    parameters.password = options.gitHubPassword;
-  }
+  /** @type {OptionsOfJSONResponseBody} */
+  const parameters = {
+    responseType: 'json',
+    headers: {Authorization: `BEARER: ${options.gitHubPat}`}
+  };
 
   Debug.log(`Making API request to GitHub: ${url}`);
   try {
@@ -381,11 +390,14 @@ async function makeGitHubApiRequest(options, url, handleNotFound) {
     Debug.log(`# body:\n${JSON.stringify(error.response.body, null, 4)}`);
     if (error.name === 'HTTPError') {
       switch (error.response.statusCode) {
+        case 429:
         case 403: {
-          throw new ErrorMessage.CustomError(
-            rateLimitErrorMessage.title,
-            rateLimitErrorMessage.message
-          );
+          const hasPat = options.gitHubPat !== undefined;
+          const rateLimitReset = error.response.headers['x-ratelimit-reset'];
+          const resetTime = new Date(rateLimitReset * 1000).toLocaleString();
+          const {title, message} = rateLimitErrorMessage(hasPat, resetTime);
+
+          throw new ErrorMessage.CustomError(title, message);
         }
 
         case 404:

lib/types/options.ts

@@ -60,8 +60,7 @@ export type Options = OptionsBase & {
   fileCachePath: () => Path;
   resultCachePath: (appHash: AppHash) => Path;
 
-  gitHubUser: string | undefined;
-  gitHubPassword: string | undefined;
+  gitHubPat?: string | undefined;
 };
 
 export type ReviewOptions = Options & {

test/flags.test.js

@@ -96,7 +96,7 @@ test('Running new-package --compiler without an argument', async () => {
 });
 
 test('Running --github-auth with a bad value', async () => {
-  const output = await TestCli.runAndExpectError('--github-auth=bad');
+  const output = await TestCli.runAndExpectError('--github-auth=::');
   expect(output).toMatchFile(testName('github-auth-bad-argument'));
 });
 

test/run.sh

@@ -14,7 +14,7 @@ replace_script() {
 }
 
 # If you get errors like rate limit exceeded, you can run these tests
-# with "AUTH_GITHUB=gitHubUserName:token"
+# with "AUTH_GITHUB=token"
 # Follow this guide: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
 # to create an API token, and give it access to public repositories.
 if [ -z "${AUTH_GITHUB:-}" ]

test/snapshots/flags/github-auth-bad-argument.txt

@@ -1,6 +1,6 @@
 -- INVALID FLAG ARGUMENT -------------------------------------------------------
 
-The value bad passed to --github-auth is not a valid one.
+The value :: passed to --github-auth is not a valid one.
 
 Here is the documentation for this flag:
 
@@ -9,5 +9,5 @@ Here is the documentation for this flag:
         Follow https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token to create an API token. The API token needs access to public repositories.
 
         Then use the flag like this:
-          --github-auth=my-user-name:abcdef01234567890
+          --github-auth=github_pat_abcdef01234567890
 

turbo.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://turbo.build/schema.json",
-  "globalEnv": ["NO_COLOR", "LOCAL_ELM_REVIEW_SRC", "ELM_HOME"],
-  "globalPassThroughEnv": ["GITHUB_TOKEN", "AUTH_GITHUB"],
+  "globalEnv": ["NO_COLOR", "LOCAL_ELM_REVIEW_SRC"],
+  "globalPassThroughEnv": ["AUTH_GITHUB", "ELM_HOME"],
   "tasks": {
     "elm-format": {
       "inputs": [