New version patch

.changeset/thin-snakes-admire.md

@@ -0,0 +1,6 @@
+---
+"quirgo": patch
+---
+
+- Program auto exit on invalid github access token option
+- Now using user's default username/login as repository owner

.github/workflows/main.yaml

@@ -2,7 +2,7 @@ name: CI
 on:
   push:
     branches:
-      - "**"
+      - dev
 
 jobs:
   build:

TODO.md

@@ -0,0 +1,25 @@
+## Todo
+
+- Replace OctokitResponse<any> by proper typing!
+- Consider writing tests (unit tests and whatnot)
+- Add warning about gitbub's rate limit
+- Changeset to major version when basic cli is active
+- Octokit
+  - Check if user is authenticated
+- Add a mini logger lib file
+- Handle verbose properly
+
+## From feedback
+
+- [x] use more branches (e.g. `main`, `develop`, `feature/...`, `bugfix/...`), moost of them will be temporary till reviewing process
+- [] see if owner can be retrieved from GitHub access token, use default as username
+- [] better README
+- [] donner plus d'infos pour l'access token, permettre d'obtenir un lien pour le générer avec peut-etre en query params de quoi remplir le formulaire avec le minimum requis pour l'access token
+- [] preciser les permissions accordees a quirgo sont les permissions minimales requises
+- [] donner la possibilite de stocker le token, voire meme plusieurs
+- [] set verbose to false at default in configuration
+- [] mutual exclusion of --json && --env
+- [] simplify the usage of --verbose (specially when default is false)
+
+-- CLI --
+Other: [gulp, jest]

package.json

@@ -1,6 +1,6 @@
 {
   "name": "quirgo",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "private": false,
   "description": "A CLI tool to automate repositories secrets and variables setting via the Gihub API",
   "type": "module",
@@ -12,7 +12,7 @@
   },
   "scripts": {
     "init-cli": "pnpm --global unlink quirgo && pnpm link --global",
-    "build": "tsup src/**/*.ts --format esm,cjs --dts",
+    "build": "tsup src/**/*.ts --format esm --dts",
     "ci": "pnpm run build && pnpm run lint",
     "release": "pnpm run build && pnpm run lint && changeset publish",
     "dev": "tsc -w",

src/index.ts

@@ -17,6 +17,11 @@ import { spinner } from "./lib/spinner.js";
 
 console.log(BANNER);
 
+/**
+ * TODO: handle the case when --env/--json is provided
+ * TODO: create todolist in README.md
+ */
+
 // Declare the program
 const program = new Command();
 
@@ -251,8 +256,27 @@ program.on("option:verbose", () => {
   config.verbose = true;
 });
 
-program.on("option:token", (token) => {
-  if (!repoManager) repoManager = new RepoManager(token);
+program.on("option:token", async (token) => {
+  try {
+    if (!repoManager) repoManager = new RepoManager(token);
+
+    // DOC: note that this will be default if no --owner option is detected
+    config.repositoryOwner = (await repoManager.getUserLogin()) || "";
+
+    if (config.verbose) {
+      console.log(
+        chalk.cyan("-> Using"),
+        chalk.bgBlueBright(config.repositoryOwner),
+        chalk.cyan("as default repository owner")
+      );
+    }
+  } catch (err: any) {
+    console.error(
+      chalk.red("Impossible to authenticate using the GitHub Access Token")
+    );
+    console.error(chalk.red(err));
+    process.exit(-1);
+  }
 });
 
 program.on("option:repo", (repo) => {
@@ -271,6 +295,11 @@ program.on("option:json", (json) => {
   parsedKeyValues = jsonParser(json, { verbose: config.verbose || false });
 });
 
+program.action(() => {
+  program.outputHelp();
+  process.exit(0);
+});
+
 program.parse(process.argv);
 
 /**
@@ -312,7 +341,7 @@ async function fn() {
   }
 }
 
-// If no command is provided, show help
-if (!process.argv.slice(2).length) {
-  program.outputHelp();
-}
+// // If no command is provided, show help
+// if (!process.argv.slice(2).length) {
+//   program.outputHelp();
+// }

src/lib/repository-manager.ts

@@ -9,6 +9,7 @@ import { spinner } from "./spinner.js";
  * Faster & shorter
  * Tag commit as "refactor"
  * TODO: check returnTypes
+ * TODO: different request methods for variables
  */
 
 export class RepoManager {
@@ -18,6 +19,11 @@ export class RepoManager {
     this.app = new Octokit({ auth: githubAccessToken });
   }
 
+  public async getUserLogin(): Promise<string | null> {
+    const user = await this.app.rest.users.getAuthenticated();
+    return user.data.login;
+  }
+
   /**
    * List variables in the repository for GitHub Actions.
    * @param {Configuration} config The configuration object containing repository details.
@@ -125,13 +131,13 @@ export class RepoManager {
    * @param {Configuration} config The configuration object containing repository details.
    * @param {string} secretName The name of the variable to create.
    * @param {string} secretValue The value of the variable to create.
-   * @returns {Promise<void | OctokitResponse<any>>} A Promise containing the Octokit response.
+   * @returns {Promise<OctokitResponse<any>>} A Promise containing the Octokit response.
    */
   public async setRepoSecret(
     config: Configuration,
     secretName: string,
     secretValue: string
-  ): Promise<void | OctokitResponse<any>> {
+  ): Promise<OctokitResponse<any>> {
     spinner.start(`Setting secret <${secretName}>...\n`);
     // get repo public key
     const encryptedValue = await this.app.rest.actions.getRepoPublicKey({