Merge pull request #244 from screendriver/esm

lo1tuma · web-flow · commit 66e76ca2fe3d · 2023-07-16T19:16:56.000+02:00
Set package type to ECMAScript module
diff --git a/ava.config.integration.js b/ava.config.integration.js
@@ -1,4 +1,4 @@
-import defaultConfig from './ava.config.mjs';
+import defaultConfig from './ava.config.js';
 
 export default {
     ...defaultConfig,
diff --git a/ava.config.js b/ava.config.js
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,8 +1,12 @@
 {
     "name": "gitlab-pipeline-deleter",
+    "type": "module",
     "version": "2.3.18",
     "description": "A CLI tool that deletes old GitLab pipelines",
-    "main": "target/src/index.js",
+    "exports": {
+        "types": "./target/src/index.d.ts",
+        "default": "./target/src/index.js"
+    },
     "engines": {
         "node": ">=16"
     },
@@ -36,31 +40,31 @@
         "compile": "tsc --build",
         "lint": "eslint src test --ext '.ts,.tsx'",
         "copy:paste:detection": "jscpd src test",
-        "test:unit": "TS_NODE_PROJECT=tsconfig.base.json ava",
+        "test:unit": "ava",
         "test:unit:coverage": "c8 npm run test:unit",
-        "test:integration": "TS_NODE_PROJECT=tsconfig.base.json ava --config ava.config.integration.mjs",
+        "test:integration": "ava --config ava.config.integration.js",
         "release:dry": "release-it --dry-run --no-npm",
         "release": "release-it"
     },
     "dependencies": {
-        "@sindresorhus/is": "4.6.0",
+        "@sindresorhus/is": "5.5.0",
         "commander": "9.5.0",
         "cosmiconfig": "7.1.0",
         "date-fns": "2.30.0",
-        "got": "11.8.6",
-        "ink": "3.2.0",
-        "ink-spinner": "4.0.3",
-        "p-queue": "6.6.2",
-        "react": "17.0.2",
-        "true-myth": "4.1.1",
+        "got": "13.0.0",
+        "ink": "4.2.0",
+        "ink-spinner": "5.0.0",
+        "p-queue": "7.3.4",
+        "react": "18.2.0",
+        "true-myth": "7.0.0",
         "tslib": "2.6.0",
-        "urlcat": "2.0.4",
         "zod": "3.21.4"
     },
     "devDependencies": {
         "@ava/typescript": "4.1.0",
         "@types/common-tags": "1.8.1",
-        "@types/react": "17.0.62",
+        "@types/node": "20.4.2",
+        "@types/react": "18.2.15",
         "@types/sinon": "10.0.15",
         "@typescript-eslint/eslint-plugin": "5.62.0",
         "@typescript-eslint/parser": "5.62.0",
@@ -77,12 +81,11 @@
         "eslint-plugin-testing-library": "5.11.0",
         "fastify": "4.19.2",
         "fishery": "2.2.2",
-        "get-port": "7.0.0",
-        "ink-testing-library": "2.1.0",
+        "ink-testing-library": "3.0.0",
         "jscpd": "3.5.9",
         "prettier": "2.8.8",
         "release-it": "16.1.2",
         "sinon": "14.0.2",
-        "typescript": "4.9.5"
+        "typescript": "5.1.6"
     }
 }
diff --git a/src/App.tsx b/src/App.tsx
@@ -2,9 +2,9 @@ import React, { Fragment, FunctionComponent, useEffect, useState } from 'react';
 import { Text, Static } from 'ink';
 import Spinner from 'ink-spinner';
 import PQueue from 'p-queue';
-import type { ListPipelinesFunction, DeletePipelineFunction, FilterPipelinesByDateFunction } from './gitlab';
-import { Error, ErrorProps } from './Error';
-import { Pipeline } from './network';
+import type { ListPipelinesFunction, DeletePipelineFunction, FilterPipelinesByDateFunction } from './gitlab.js';
+import { Error, ErrorProps } from './Error.js';
+import { Pipeline } from './network.js';
 
 export interface AppProps {
     readonly gitlabUrl: string;
diff --git a/src/bin.tsx b/src/bin.tsx
@@ -3,13 +3,13 @@ import React from 'react';
 import { createCommand } from 'commander';
 import { render } from 'ink';
 import { cosmiconfig } from 'cosmiconfig';
-import path from 'path';
+import path from 'node:path';
 import PQueue from 'p-queue';
-import { App } from './App';
-import { Error } from './Error';
-import { getRequest, deleteRequest } from './network';
-import { listPipelines, filterPipelinesByDate, deletePipeline } from './gitlab';
-import { PartialConfigInput, loadConfig, mergeCliArgumentsWithConfig } from './config';
+import { App } from './App.js';
+import { Error } from './Error.js';
+import { getRequest, deleteRequest } from './network.js';
+import { listPipelines, filterPipelinesByDate, deletePipeline } from './gitlab.js';
+import { PartialConfigInput, loadConfig, mergeCliArgumentsWithConfig } from './config.js';
 
 function exit() {
     process.exitCode = 1;
@@ -46,7 +46,7 @@ program
                 return mergeCliArgumentsWithConfig(cliArguments, config);
             });
 
-            if (glpdArguments.isErr()) {
+            if (glpdArguments.isErr) {
                 render(<Error exit={exit}>Missing or invalid arguments</Error>);
                 return;
             }
diff --git a/src/gitlab.ts b/src/gitlab.ts
@@ -1,6 +1,6 @@
-import urlcat from 'urlcat';
+import { URL } from 'node:url';
 import { parseISO, differenceInDays } from 'date-fns';
-import { GetRequest, DeleteRequest, Pipeline } from './network';
+import { GetRequest, DeleteRequest, Pipeline } from './network.js';
 
 interface ListPipelinesArguments {
     readonly getRequest: GetRequest;
@@ -12,9 +12,12 @@ export type ListPipelinesFunction = (projectId: number) => Promise<readonly Pipe
 
 export function listPipelines({ getRequest, gitlabUrl, accessToken }: ListPipelinesArguments): ListPipelinesFunction {
     return (projectId) => {
-        const url = urlcat(gitlabUrl, '/api/v4/projects/:id/pipelines', { id: projectId, per_page: 100 });
+        const escapedProjectId = encodeURIComponent(projectId);
+        const url = new URL(`/api/v4/projects/${escapedProjectId}/pipelines`, gitlabUrl);
 
-        return getRequest(url, accessToken);
+        url.searchParams.set('per_page', '100');
+
+        return getRequest(url.toString(), accessToken);
     };
 }
 
@@ -32,12 +35,11 @@ export function deletePipeline({
     accessToken,
 }: DeletePipelineArguments): DeletePipelineFunction {
     return async (projectId, pipeline) => {
-        const url = urlcat(gitlabUrl, '/api/v4/projects/:id/pipelines/:pipeline_id', {
-            id: projectId,
-            pipeline_id: pipeline.id,
-        });
+        const escapedProjectId = encodeURIComponent(projectId);
+        const escapedPipelineId = encodeURIComponent(pipeline.id);
+        const url = new URL(`/api/v4/projects/${escapedProjectId}/pipelines/${escapedPipelineId}`, gitlabUrl);
 
-        await deleteRequest(url, accessToken);
+        await deleteRequest(url.toString(), accessToken);
     };
 }
 
diff --git a/src/network.ts b/src/network.ts
@@ -24,7 +24,9 @@ export const deleteRequest: DeleteRequest = (url, accessToken) => {
         .delete(url, {
             headers: createHeaders(accessToken),
             throwHttpErrors: true,
-            retry: 0,
+            retry: {
+                limit: 0,
+            },
         })
         .text();
 };
diff --git a/test/integration/deletePipelines.test.tsx b/test/integration/deletePipelines.test.tsx
@@ -5,10 +5,10 @@ import { parseISO } from 'date-fns';
 import delay from 'delay';
 import PQueue from 'p-queue';
 import sinon from 'sinon';
-import { withGitLabServer } from './gitlabServer';
-import { App } from '../../src/App';
-import { deletePipeline, filterPipelinesByDate, listPipelines } from '../../src/gitlab';
-import { getRequest, deleteRequest } from '../../src/network';
+import { withGitLabServer } from './gitlabServer.js';
+import { App } from '../../src/App.js';
+import { deletePipeline, filterPipelinesByDate, listPipelines } from '../../src/gitlab.js';
+import { getRequest, deleteRequest } from '../../src/network.js';
 
 test.afterEach(cleanup);
 
diff --git a/test/integration/gitlabServer.ts b/test/integration/gitlabServer.ts
@@ -3,7 +3,7 @@ import type { RouteOptions } from 'fastify';
 import { Factory } from 'fishery';
 import { subDays, formatISO, parseISO } from 'date-fns';
 import { IncomingHttpHeaders } from 'http';
-import { Pipeline } from '../../src/network';
+import { Pipeline } from '../../src/network.js';
 import type { ExecutionContext, ImplementationFn } from 'ava';
 
 interface PipelineTransientParams {
diff --git a/test/unit/App.test.tsx b/test/unit/App.test.tsx
@@ -4,9 +4,9 @@ import { render, cleanup } from 'ink-testing-library';
 import sinon from 'sinon';
 import delay from 'delay';
 import { Factory } from 'fishery';
-import { App, AppProps } from '../../src/App';
-import { Pipeline } from '../../src/network';
-import { createAppProps } from './factory';
+import { App, AppProps } from '../../src/App.js';
+import { Pipeline } from '../../src/network.js';
+import { createAppProps } from './factory.js';
 
 test.afterEach(cleanup);
 
diff --git a/test/unit/Error.test.tsx b/test/unit/Error.test.tsx
@@ -2,7 +2,7 @@ import React from 'react';
 import test from 'ava';
 import sinon from 'sinon';
 import { render, cleanup } from 'ink-testing-library';
-import { Error, ErrorProps } from '../../src/Error';
+import { Error, ErrorProps } from '../../src/Error.js';
 
 test.afterEach(cleanup);
 
diff --git a/test/unit/config.test.ts b/test/unit/config.test.ts
@@ -2,7 +2,7 @@ import test from 'ava';
 import sinon from 'sinon';
 import { cosmiconfig } from 'cosmiconfig';
 import { Factory } from 'fishery';
-import { PartialConfigInput, Config, loadConfig, mergeCliArgumentsWithConfig } from '../../src/config';
+import { PartialConfigInput, Config, loadConfig, mergeCliArgumentsWithConfig } from '../../src/config.js';
 
 const partialConfigInputFactory = Factory.define<PartialConfigInput>(() => {
     return {
diff --git a/test/unit/factory.ts b/test/unit/factory.ts
@@ -1,6 +1,6 @@
 import sinon from 'sinon';
 import PQueue from 'p-queue';
-import { AppProps } from '../../src/App';
+import { AppProps } from '../../src/App.js';
 
 export function createAppProps(overrides: Partial<AppProps> = {}): AppProps {
     const deleteQueue = new PQueue({ autoStart: false });
diff --git a/test/unit/gitlab.test.ts b/test/unit/gitlab.test.ts
@@ -2,8 +2,8 @@ import test from 'ava';
 import sinon from 'sinon';
 import { Factory } from 'fishery';
 import { parseISO, subDays, formatISO } from 'date-fns';
-import { deletePipeline, filterPipelinesByDate, listPipelines } from '../../src/gitlab';
-import { DeleteRequest, GetRequest, Pipeline } from '../../src/network';
+import { deletePipeline, filterPipelinesByDate, listPipelines } from '../../src/gitlab.js';
+import { DeleteRequest, GetRequest, Pipeline } from '../../src/network.js';
 
 interface PipelineTransientParams {
     readonly startDate: Date;
diff --git a/tsconfig.base.json b/tsconfig.base.json
@@ -1,8 +1,8 @@
 {
     "compilerOptions": {
-        "target": "ES2018",
-        "module": "CommonJS",
-        "moduleResolution": "node",
+        "target": "ES2021",
+        "module": "Node16",
+        "moduleResolution": "Node16",
         "jsx": "react",
         "importHelpers": true,
         "sourceMap": true,

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import defaultConfig from './ava.config.mjs';`
	`1`	`+import defaultConfig from './ava.config.js';`
`2`	`2`
`3`	`3`	`export default {`
`4`	`4`	`...defaultConfig,`