Merge pull request #146 from shelfio/feature/remove-client-reference

Author: slavik-chapelskyi

.circleci/config.yml

@@ -6,16 +6,15 @@ orbs:
 parameters:
   node_version:
     type: string
-    default: '16.15.1'
+    default: '20.11.1'
 
 commands:
   install_deps:
     steps:
       - run: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> .npmrc
       - node/install-packages:
           pkg-manager: yarn
-          cache-version: v1-all
-          cache-only-lockfile: true
+          with-cache: false
           app-dir: ~/repo
           override-ci-command: yarn install --pure-lockfile --no-progress
 
@@ -29,5 +28,5 @@ jobs:
       - checkout
       - install_deps
       - run: yarn test
-      - run: yarn type-check
+      - run: yarn build
       - run: yarn lint:ci

.husky/pre-commit

@@ -0,0 +1 @@
+yarn lint-staged

jest.config.js

@@ -0,0 +1,8 @@
+/** @type {import("ts-jest").JestConfigWithTsJest} */
+const config = {
+  transform: {
+    '^.+\\.(t|j)sx?$': ['@swc/jest'],
+  },
+  resolver: 'ts-jest-resolver',
+};
+export default config;

package.json

@@ -8,15 +8,14 @@
     "email": "vlad@shelf.io",
     "url": "https://shelf.io"
   },
-  "main": "lib",
+  "type": "module",
+  "exports": "./lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
     "lib"
   ],
   "scripts": {
-    "build": "rm -rf lib/ && yarn build:types && yarn build:code",
-    "build:code": "babel src --out-dir lib --ignore '**/*.test.ts' --extensions '.ts' && find ./lib -name '*.test.d.ts' -delete",
-    "build:types": "tsc --emitDeclarationOnly --declaration --isolatedModules false --declarationDir lib",
+    "build": "rm -rf lib/ && tsc",
     "coverage": "jest --coverage",
     "lint": "eslint . --ext .js,.ts,.json --fix",
     "lint:ci": "eslint . --ext .js,.ts,.json",
@@ -25,46 +24,34 @@
     "type-check": "tsc --noEmit",
     "type-check:watch": "npm run type-check -- --watch"
   },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged"
-    }
-  },
   "lint-staged": {
-    "*.{html,json,md,yml}": [
-      "prettier --write"
-    ],
-    "*.{js,ts}": [
-      "eslint --fix"
-    ]
-  },
-  "babel": {
-    "extends": "@shelf/babel-config/backend"
+    "*.{html,json,md,yml}": "prettier --write",
+    "*.{js,ts}": "eslint --fix"
   },
   "prettier": "@shelf/prettier-config",
   "dependencies": {
-    "@octokit/rest": "19.0.5",
+    "@octokit/rest": "20.1.0",
     "lodash": "4.17.21"
   },
   "devDependencies": {
-    "@babel/cli": "7.23.4",
-    "@babel/core": "7.23.7",
-    "@shelf/babel-config": "1.2.0",
-    "@shelf/eslint-config": "2.26.0",
+    "@shelf/eslint-config": "3.15.1",
     "@shelf/prettier-config": "1.0.0",
-    "@shelf/tsconfig": "0.0.9",
-    "@types/jest": "29.5.11",
-    "@types/lodash": "4.14.202",
-    "@types/node": "16",
+    "@shelf/tsconfig": "0.1.0",
+    "@swc/core": "1.4.14",
+    "@swc/jest": "0.2.36",
+    "@types/jest": "29.5.12",
+    "@types/lodash": "4.17.0",
+    "@types/node": "20.12.7",
     "eslint": "8.56.0",
-    "husky": "8.0.3",
+    "husky": "9.0.11",
     "jest": "29.7.0",
-    "lint-staged": "13.3.0",
-    "prettier": "2.8.8",
-    "typescript": "5.1.6"
+    "lint-staged": "15.2.2",
+    "prettier": "3.2.5",
+    "ts-jest-resolver": "2.0.1",
+    "typescript": "5.4.5"
   },
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   },
   "publishConfig": {
     "access": "public"

src/index.ts

@@ -1,3 +1,4 @@
-export * from './prs';
-export * from './repos';
-export * from './misc';
+export * from './prs/index.js';
+export * from './repos/index.js';
+export * from './misc/index.js';
+export * from './rest-client.js';

src/misc/get-orgs.test.ts

@@ -1,7 +1,7 @@
 jest.mock('../rest-client');
 
-import {getClient} from '../rest-client';
-import {getUserOrgs} from './get-orgs';
+import {getClient} from '../rest-client.js';
+import {getUserOrgs} from './get-orgs.js';
 
 const listForAuthenticatedUserMock = jest
   .fn()

src/misc/get-orgs.ts

@@ -1,4 +1,4 @@
-import {getClient} from '../rest-client';
+import {getClient} from '../rest-client.js';
 
 export async function getUserOrgs(): Promise<string[]> {
   const gh = getClient();

src/misc/index.ts

@@ -1 +1 @@
-export * from './get-orgs';
+export * from './get-orgs.js';

src/prs/approve.test.ts

@@ -1,7 +1,7 @@
 jest.mock('../rest-client');
 
-import {getClient} from '../rest-client';
-import {approvePR} from './approve';
+import {getClient} from '../rest-client.js';
+import {approvePR} from './approve.js';
 
 const createReviewMock = jest.fn().mockResolvedValue({data: {a: 1}});
 

src/prs/approve.ts

@@ -1,5 +1,5 @@
 import type {RestEndpointMethodTypes} from '@octokit/plugin-rest-endpoint-methods';
-import {getClient} from '../rest-client';
+import {getClient} from '../rest-client.js';
 
 type ApprovePRParams = {
   owner: string;

src/prs/create-release-pr.test.ts

@@ -1,7 +1,7 @@
 jest.mock('../rest-client');
 
-import {getClient} from '../rest-client';
-import {createReleasePR} from './create-release-pr';
+import {getClient} from '../rest-client.js';
+import {createReleasePR} from './create-release-pr.js';
 
 const owner = 'repo-owner-name';
 const repo = 'some-repo-name';

src/prs/create-release-pr.ts

@@ -1,5 +1,4 @@
-import type {RestEndpointMethodTypes} from '@octokit/plugin-rest-endpoint-methods/dist-types/generated/parameters-and-response-types';
-import {getClient} from '../rest-client';
+import {getClient} from '../rest-client.js';
 
 export async function createReleasePR({
   owner,
@@ -11,7 +10,7 @@ export async function createReleasePR({
   repo: string;
   version: string;
   releaseTitle: string;
-}): Promise<RestEndpointMethodTypes['pulls']['create']['response']['data']> {
+}) {
   const gh = getClient();
   const tagName = `v${version}`;
   const branch = `release/${tagName}`;

src/prs/extract-repo-name.test.ts

@@ -1,4 +1,4 @@
-import {extractRepoNameFromURL} from './extract-repo-name';
+import {extractRepoNameFromURL} from './extract-repo-name.js';
 
 it('should parse API repo url', () => {
   const repoName = extractRepoNameFromURL('https://api.github.com/repos/shelfio/gh-sdk');

src/prs/get-pr.ts

@@ -1,5 +1,5 @@
 import type {RestEndpointMethodTypes} from '@octokit/plugin-rest-endpoint-methods';
-import {getClient} from '../rest-client';
+import {getClient} from '../rest-client.js';
 
 export async function getPR({
   repo,

src/prs/index.ts

@@ -1,6 +1,6 @@
-export * from './approve';
-export * from './create-release-pr';
-export * from './extract-repo-name';
-export * from './get-pr';
-export * from './list-prs';
-export * from './merge';
+export * from './approve.js';
+export * from './create-release-pr.js';
+export * from './extract-repo-name.js';
+export * from './get-pr.js';
+export * from './list-prs.js';
+export * from './merge.js';

src/prs/list-prs.ts

@@ -1,5 +1,5 @@
 import type {RestEndpointMethodTypes} from '@octokit/plugin-rest-endpoint-methods';
-import {getClient} from '../rest-client';
+import {getClient} from '../rest-client.js';
 
 type ListOpenPRsParams = {
   owner: string;
@@ -16,7 +16,7 @@ export function listPrs(params: ListOpenPRsParams): ReturnType<typeof getPRs> {
   return getPRs({...params, prStatus: 'open'});
 }
 
-export async function getOpenRepoPRsFromHuman(owner: string, repo: string): Promise<any[]> {
+export async function getOpenRepoPRsFromHuman(owner: string, repo: string) {
   const gh = getClient();
 
   const {data} = await gh.pulls.list({
@@ -28,11 +28,7 @@ export async function getOpenRepoPRsFromHuman(owner: string, repo: string): Prom
   return data.filter(pr => !pr?.user?.login.endsWith('[bot]') && !pr.draft);
 }
 
-export async function getCommitChecks(
-  owner: string,
-  repo: string,
-  commitRef: string
-): Promise<any[]> {
+export async function getCommitChecks(owner: string, repo: string, commitRef: string) {
   const gh = getClient();
 
   const {data} = await gh.request({

src/prs/merge.test.ts

@@ -1,7 +1,7 @@
 jest.mock('../rest-client');
 
-import {getClient} from '../rest-client';
-import {mergePR} from './merge';
+import {getClient} from '../rest-client.js';
+import {mergePR} from './merge.js';
 
 const mergeMock = jest.fn().mockResolvedValue({data: {a: 1}});
 

src/prs/merge.ts

@@ -1,5 +1,5 @@
 import type {RestEndpointMethodTypes} from '@octokit/plugin-rest-endpoint-methods';
-import {getClient} from '../rest-client';
+import {getClient} from '../rest-client.js';
 
 type MergePRParams = {
   owner: string;

src/repos/create-release-branch.test.ts

@@ -1,7 +1,7 @@
 jest.mock('../rest-client');
 
-import {getClient} from '../rest-client';
-import {createReleaseBranch} from './create-release-branch';
+import {getClient} from '../rest-client.js';
+import {createReleaseBranch} from './create-release-branch.js';
 
 const owner = 'some-owner-name';
 const repo = 'some-repo-name';

src/repos/create-release-branch.ts

@@ -1,5 +1,5 @@
 import type {RestEndpointMethodTypes} from '@octokit/plugin-rest-endpoint-methods';
-import {getClient} from '../rest-client';
+import {getClient} from '../rest-client.js';
 
 export async function createReleaseBranch({
   owner,

src/repos/delete-branch.test.ts

@@ -1,6 +1,6 @@
 jest.mock('./delete-branch');
 
-import {deleteBranch} from './delete-branch';
+import {deleteBranch} from './delete-branch.js';
 
 it('deleteBranch should be called w/ correct arguments', async () => {
   const owner = 'some-repo-owner';

src/repos/delete-branch.ts

@@ -1,5 +1,5 @@
 import type {RestEndpointMethodTypes} from '@octokit/plugin-rest-endpoint-methods';
-import {getClient} from '../rest-client';
+import {getClient} from '../rest-client.js';
 
 export async function deleteBranch({
   owner,

src/repos/get-latest-branch-commit.test.ts

@@ -1,11 +1,11 @@
 jest.mock('../rest-client');
 
-import {getClient} from '../rest-client';
+import {getClient} from '../rest-client.js';
 import {
   getLatestBranchCommit,
   getLatestDevelopCommit,
   getLatestDevelopCommitSHA,
-} from './get-latest-branch-commit';
+} from './get-latest-branch-commit.js';
 
 const commit = {
   author: {id: 123, login: 'some-login-string', url: 'some-author-url'},

src/repos/get-latest-branch-commit.ts

@@ -1,5 +1,5 @@
 import type {RestEndpointMethodTypes} from '@octokit/plugin-rest-endpoint-methods';
-import {getRepoBranch} from './get-repo-branches';
+import {getRepoBranch} from './get-repo-branches.js';
 
 type LatestBranchCommit =
   | RestEndpointMethodTypes['repos']['getBranch']['response']['data']['commit']

src/repos/get-repo-branches.test.ts

@@ -1,7 +1,7 @@
 jest.mock('../rest-client');
 
-import {getClient} from '../rest-client';
-import {getRepoBranch, getRepoBranches, getRepoBranchesNames} from './get-repo-branches';
+import {getClient} from '../rest-client.js';
+import {getRepoBranch, getRepoBranches, getRepoBranchesNames} from './get-repo-branches.js';
 
 const branchOne = {
   _links: {html: 'some-html'},

src/repos/get-repo-branches.ts

@@ -1,5 +1,5 @@
 import type {RestEndpointMethodTypes} from '@octokit/plugin-rest-endpoint-methods';
-import {getClient} from '../rest-client';
+import {getClient} from '../rest-client.js';
 
 export async function getRepoBranch({
   owner,

src/repos/get-repo-merge-strategies.ts

@@ -1,5 +1,5 @@
 /* eslint-disable camelcase */
-import {getClient} from '../rest-client';
+import {getClient} from '../rest-client.js';
 
 export async function getRepoMergeStrategies(owner: string, repo: string) {
   const gh = getClient();

src/repos/index.ts

@@ -1,8 +1,8 @@
-export * from './create-release-branch';
-export * from './delete-branch';
-export * from './get-latest-branch-commit';
-export * from './get-repo-branches';
-export * from './get-repo-merge-strategies';
-export * from './labels';
-export * from './list-org-repos';
-export * from './update-repo-merge-strategies';
+export * from './create-release-branch.js';
+export * from './delete-branch.js';
+export * from './get-latest-branch-commit.js';
+export * from './get-repo-branches.js';
+export * from './get-repo-merge-strategies.js';
+export * from './labels.js';
+export * from './list-org-repos.js';
+export * from './update-repo-merge-strategies.js';

src/repos/labels.ts

@@ -1,4 +1,4 @@
-import {getClient} from '../rest-client';
+import {getClient} from '../rest-client.js';
 
 export async function getRepoLabels(owner: string, repo: string): Promise<string[]> {
   const client = getClient();

src/repos/list-org-repos.test.ts

@@ -1,7 +1,7 @@
 jest.mock('../rest-client');
 
-import {getClient} from '../rest-client';
-import {listOrgRepos} from './list-org-repos';
+import {getClient} from '../rest-client.js';
+import {listOrgRepos} from './list-org-repos.js';
 
 const listForOrgMock = jest.fn().mockResolvedValue({
   data: [{a: 1}],

src/repos/list-org-repos.ts

@@ -1,5 +1,5 @@
 import type {RestEndpointMethodTypes} from '@octokit/plugin-rest-endpoint-methods';
-import {getClient} from '../rest-client';
+import {getClient} from '../rest-client.js';
 
 type RepoType = RestEndpointMethodTypes['repos']['listForOrg']['parameters']['type'];
 

src/repos/update-repo-merge-strategies.ts

@@ -1,5 +1,5 @@
 /* eslint-disable camelcase */
-import {getClient} from '../rest-client';
+import {getClient} from '../rest-client.js';
 
 type UpdateRepoMergeStrategiesParams = {
   owner: string;

src/rest-client.ts

@@ -1,15 +1,7 @@
 import {Octokit} from '@octokit/rest';
 
-let client: Octokit;
-
 export function getClient(): Octokit {
-  if (client) {
-    return client;
-  }
-
-  client = new Octokit({
+  return new Octokit({
     auth: process.env.GITHUB_TOKEN,
   });
-
-  return client;
 }

tsconfig.json

@@ -1,7 +1,12 @@
 {
   "extends": "@shelf/tsconfig/backend",
   "compilerOptions": {
-    "strict": true
+    "strict": true,
+    "declaration": true,
+    "noEmit": false,
+    "outDir": "lib",
+    "moduleResolution": "nodenext",
+    "module": "Node16"
   },
   "exclude": ["node_modules"],
   "include": ["src"]