added linting to the action (#49)

Added eslint and prettier and added the step of running the linter on pull requests

Closes #47

Author: Bullrich

.eslintrc.cjs

@@ -0,0 +1,7 @@
+const { getConfiguration } = require("opstooling-js-style/src/eslint/configuration");
+
+const tsConfParams = { rootDir: __dirname };
+
+const conf = getConfiguration({ typescript: tsConfParams });
+
+module.exports = conf;

.github/workflows/javascript-test.yml

@@ -12,8 +12,10 @@ jobs:
         with:
           node-version: 18
       - name: Install dependencies
-        run: yarn install --immutable
+        run: yarn install --frozen-lockfile
       - name: Run tests
         run: yarn test
+      - name: Run lint
+        run: yarn lint
       - name: Build the project
         run: yarn build

.prettierrc.cjs

@@ -0,0 +1 @@
+module.exports = require("opstooling-js-style/src/prettier/configuration")

jest.config.js

@@ -1,5 +1,6 @@
 module.exports = {
-    preset: "ts-jest",
-    testEnvironment: "node",
-    testMatch: ["<rootDir>/src/test/**/*.test.ts"]
+  preset: "ts-jest",
+  testEnvironment: "node",
+  testMatch: ["<rootDir>/src/test/**/*.test.ts"],
+  moduleNameMapper: { "^src/(.*)$": `${process.cwd()}/src/$1` },
 };

package.json

@@ -16,9 +16,9 @@
     "typecheck": "tsc --noEmit",
     "fix:eslint": "eslint --fix",
     "fix:prettier": "prettier --write",
-    "fix": "yarn fix:eslint '{*,**/*}.{cjs,ts}' && yarn fix:prettier '{*,**/*}.json'",
+    "fix": "yarn fix:eslint '{*,**/*}.ts' && yarn fix:prettier '{*,**/*}.json'",
     "prettier": "prettier --check --loglevel silent '{*,**/*}.{json,html}'",
-    "eslint": "eslint --quiet '{*,**/*}.{cjs,ts}'",
+    "eslint": "eslint --quiet '{*,**/*}.ts'",
     "lint": "yarn eslint && yarn prettier"
   },
   "dependencies": {
@@ -30,7 +30,7 @@
     "@types/jest": "^29.2.5",
     "jest": "^29.3.1",
     "jest-mock-extended": "^3.0.1",
-    "opstooling-js-style": "https://github.com/paritytech/opstooling-js-style#8578c0d55043e4e3db94f7fdf8b698bc4a86e58d",
+    "opstooling-js-style": "https://github.com/paritytech/opstooling-js-style#c298d0f732d93712e4397fd53baa3317a3022c8c",
     "ts-jest": "^29.0.5",
     "typescript": "^4.9.4"
   }

src/github/CoreLogger.ts

@@ -1,22 +1,22 @@
 import * as core from "@actions/core";
+
 import { ILogger } from "./types";
 
 /** Implementation using the logger type from @actions/core */
 export class CoreLogger implements ILogger {
-    info(message: string): void {
-        core.info(message);
-    }
-    warning(message: string): void {
-        core.warning(message);
-    }
-    error(message: string | Error): void {
-        core.error(message);
-    }
-    debug(message: string): void {
-        core.debug(message);
-    }
-    notice(message: string): void {
-        core.notice(message);
-    }
-
+  info(message: string): void {
+    core.info(message);
+  }
+  warning(message: string): void {
+    core.warning(message);
+  }
+  error(message: string | Error): void {
+    core.error(message);
+  }
+  debug(message: string): void {
+    core.debug(message);
+  }
+  notice(message: string): void {
+    core.notice(message);
+  }
 }

src/github/issueKit.ts

@@ -1,22 +1,22 @@
 import { GitHub } from "@actions/github/lib/utils";
-import { Octokit } from "@octokit/rest";
-import { IIssues, Issue, Repository } from "./types";
-
 
+import { IIssues, Issue, Repository } from "./types";
 
 export class IssueApi implements IIssues {
-    /** Requires permissions to the repository with access to the repo */
-    constructor(private readonly octokit: InstanceType<typeof GitHub>, private readonly repoData: Repository) {
-    }
+  /** Requires permissions to the repository with access to the repo */
+  constructor(private readonly octokit: InstanceType<typeof GitHub>, private readonly repoData: Repository) {}
 
-    async getIssueState(issueId: number): Promise<"open" | "closed"> {
-        const { owner, repo } = this.repoData;
-        const issueData = await this.octokit.rest.issues.get({ repo, owner, issue_number: issueId });
-        return issueData.data.state === "open" ? "open" : "closed";
-    }
+  async getIssueState(issueId: number): Promise<"open" | "closed"> {
+    const { owner, repo } = this.repoData;
+    const issueData = await this.octokit.rest.issues.get({ repo, owner, issue_number: issueId });
+    return issueData.data.state === "open" ? "open" : "closed";
+  }
 
-    async getAllIssuesId(excludeClosed: boolean): Promise<Issue[]> {
-        const allIssues = await this.octokit.rest.issues.listForRepo({ ...this.repoData, state: excludeClosed ? "open" : "all" });
-        return allIssues.data;
-    }
+  async getAllIssuesId(excludeClosed: boolean): Promise<Issue[]> {
+    const allIssues = await this.octokit.rest.issues.listForRepo({
+      ...this.repoData,
+      state: excludeClosed ? "open" : "all",
+    });
+    return allIssues.data;
+  }
 }

src/github/projectKit.ts

@@ -1,4 +1,5 @@
 import { graphql } from "@octokit/graphql";
+
 import { ILogger, IProjectApi, Issue, Repository } from "./types";
 
 interface ProjectData {
@@ -14,29 +15,27 @@ interface ProjectData {
       };
     };
   };
-};
+}
 
 interface CreatedProjectItemForIssue {
   addProjectNextItem: { projectNextItem: { id: string } };
-};
-
+}
 
 /**
  * Instance that manages the GitHub's project api
  * ? Octokit.js doesn't support Project v2 API yet so we need to use graphQL
  * Used this blog post as a reference for the queries: https://www.cloudwithchris.com/blog/automate-adding-gh-issues-projects-beta/
  */
 export class ProjectKit implements IProjectApi {
-
   private projectNodeId: string | null = null;
 
   /** Requires an instance with a PAT with the 'write:org' permission enabled */
   constructor(
     private readonly gql: typeof graphql,
     private readonly repoData: Repository,
     private readonly projectNumber: number,
-    private readonly logger: ILogger) {
-  }
+    private readonly logger: ILogger,
+  ) {}
 
   /*   changeIssueStateInProject(issueCardId: number, state: "todo" | "in progress" | "blocked" | "done"): Promise<void> {
       return this.gql(
@@ -99,13 +98,13 @@ export class ProjectKit implements IProjectApi {
   }
 
   // step three
-  updateProjectNextItemField(
+  async updateProjectNextItemField(
     project: string,
     item: string,
     targetField: string,
     targetFieldValue: string,
-  ) {
-    this.gql(
+  ): Promise<void> {
+    await this.gql(
       `
       mutation (
         $project: ID!
@@ -129,7 +128,7 @@ export class ProjectKit implements IProjectApi {
     );
   }
 
-  async assignIssueToProject(issue: Issue, projectId: string) {
+  async assignIssueToProject(issue: Issue, projectId: string): Promise<boolean> {
     const migration = await this.gql<CreatedProjectItemForIssue>(
       `
           mutation($project: ID!, $issue: ID!) {
@@ -152,7 +151,7 @@ export class ProjectKit implements IProjectApi {
 
     this.logger.info(`Syncing issue #${issue.number} for ${this.projectNumber}`);
 
-    return this.assignIssueToProject(issue, projectId)
+    return await this.assignIssueToProject(issue, projectId);
 
     // TODO: Assign targetField
   }

src/github/types.ts

@@ -1,38 +1,38 @@
-export type Repository = { owner: string, repo: string };
+export type Repository = { owner: string; repo: string };
 
 export type Issue = { number: number; node_id: string };
 
 export interface IProjectApi {
-    /**
-     * Assign an issue to a project
-     * @param issueNodeId The issue node_id (which differs from the issue id)
-     * @param projectId The project id (found in github.com/repo/projects/<ID>)
-     */
-    assignIssue(issue: Issue): Promise<boolean>;
-    // getProjectIdFromIssue(issueId: number): Promise<number>;
-    // changeIssueStateInProject(issueId: number, state: "todo" | "in progress" | "blocked" | "done"): Promise<boolean>;
+  /**
+   * Assign an issue to a project
+   * @param issueNodeId The issue node_id (which differs from the issue id)
+   * @param projectId The project id (found in github.com/repo/projects/<ID>)
+   */
+  assignIssue(issue: Issue): Promise<boolean>;
+  // getProjectIdFromIssue(issueId: number): Promise<number>;
+  // changeIssueStateInProject(issueId: number, state: "todo" | "in progress" | "blocked" | "done"): Promise<boolean>;
 }
 
 /** Class managing the instance of issues */
 export interface IIssues {
-    /**
-     * Returns the state of an issue (open or closed)
-     * @param issueId 
-     */
-    getIssueState(issueNumber: number): Promise<"open" | "closed">;
-    /**
-     * Returns the node_id for all the issues available in the repository
-     * @param includeClosed exclude issues which are closed from the data agregation.
-     */
-    getAllIssuesId(excludeClosed: boolean): Promise<Issue[]>;
+  /**
+   * Returns the state of an issue (open or closed)
+   * @param issueId
+   */
+  getIssueState(issueNumber: number): Promise<"open" | "closed">;
+  /**
+   * Returns the node_id for all the issues available in the repository
+   * @param includeClosed exclude issues which are closed from the data agregation.
+   */
+  getAllIssuesId(excludeClosed: boolean): Promise<Issue[]>;
 }
 
 export interface ILogger {
-    info(message: string): void;
-    warning(message: string): void;
-    error(message: string | Error): void;
-    /** Only posts messages if the action is ran in debug mode */
-    debug(message: string): void;
-    /** Publishes a message that can be seen in the action preview */
-    notice(message: string): void;
+  info(message: string): void;
+  warning(message: string): void;
+  error(message: string | Error): void;
+  /** Only posts messages if the action is ran in debug mode */
+  debug(message: string): void;
+  /** Publishes a message that can be seen in the action preview */
+  notice(message: string): void;
 }

src/main.ts

@@ -1,44 +1,43 @@
 import { getInput, info, setFailed } from "@actions/core";
 import { context, getOctokit } from "@actions/github";
+
 import { CoreLogger } from "./github/CoreLogger";
 import { IssueApi } from "./github/issueKit";
 import { ProjectKit } from "./github/projectKit";
 import { GitHubContext, Synchronizer } from "./synchronizer";
 
-
-//** Generates the class that will handle the project logic */
+//* * Generates the class that will handle the project logic */
 const generateSynchronizer = (): Synchronizer => {
-    const repoToken = getInput("GITHUB_TOKEN", { required: true });
-    const orgToken = getInput("PROJECT_TOKEN", { required: true });
+  const repoToken = getInput("GITHUB_TOKEN", { required: true });
+  const orgToken = getInput("PROJECT_TOKEN", { required: true });
 
-    const projectNumber = parseInt(getInput("project", { required: true }));
-    // TODO: Add support for custom project fields (https://docs.github.com/en/issues/planning-and-tracking-with-projects/understanding-fields)
+  const projectNumber = parseInt(getInput("project", { required: true }));
+  // TODO: Add support for custom project fields (https://docs.github.com/en/issues/planning-and-tracking-with-projects/understanding-fields)
 
-    const { repo } = context;
+  const { repo } = context;
 
-    const kit = getOctokit(repoToken);
-    const issueKit = new IssueApi(kit, repo);
-    const projectGraphQl = getOctokit(orgToken).graphql.defaults({ headers: { authorization: `token ${orgToken}` } });
-    const logger = new CoreLogger();
-    const projectKit = new ProjectKit(projectGraphQl, repo, projectNumber, logger);
+  const kit = getOctokit(repoToken);
+  const issueKit = new IssueApi(kit, repo);
+  const projectGraphQl = getOctokit(orgToken).graphql.defaults({ headers: { authorization: `token ${orgToken}` } });
+  const logger = new CoreLogger();
+  const projectKit = new ProjectKit(projectGraphQl, repo, projectNumber, logger);
 
-    return new Synchronizer(issueKit, projectKit, logger);
-}
+  return new Synchronizer(issueKit, projectKit, logger);
+};
 
 const synchronizer = generateSynchronizer();
 
 const { issue } = context.payload;
 const parsedContext: GitHubContext = {
-    eventName: context.eventName,
-    payload: {
-        inputs: context.payload.inputs,
-        issue: issue ? {
-            number: issue.number,
-            node_id: issue.node_id
-        } : undefined
-    }
-}
-
-synchronizer.synchronizeIssue(parsedContext)
-    .then(() => info("Finished"))
-    .catch(setFailed);
+  eventName: context.eventName,
+  payload: {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    inputs: context.payload.inputs,
+    issue: issue ? { number: issue.number, node_id: issue.node_id as string } : undefined,
+  },
+};
+
+synchronizer
+  .synchronizeIssue(parsedContext)
+  .then(() => info("Finished"))
+  .catch(setFailed);