Merge remote-tracking branch 'origin/release/v5.0.0' into feature/ISSUE-336-codebase-migration-to-module

Author: MrRefactoring

.eslintrc.yml

@@ -1,6 +1,7 @@
-parser: "@typescript-eslint/parser"
+parser: '@typescript-eslint/parser'
 extends:
   - airbnb-base
+  - prettier
 parserOptions:
   ecmaVersion: 2018
   project: ./tsconfig.lint.json
@@ -10,7 +11,7 @@ env:
   node: true
   browser: true
 rules:
-  "@typescript-eslint/lines-between-class-members": off
+  '@typescript-eslint/lines-between-class-members': off
   arrow-parens:
     - error
     - as-needed
@@ -37,7 +38,7 @@ rules:
   padding-line-between-statements:
     - error
     - blankLine: always
-      prev: "*"
+      prev: '*'
       next:
         - block
         - block-like
@@ -59,7 +60,7 @@ rules:
         - import
         - let
         - var
-      next: "*"
+      next: '*'
     - blankLine: any
       prev:
         - const
@@ -86,5 +87,5 @@ rules:
         - export
 settings:
   import/parsers:
-    "@typescript-eslint/parser":
+    '@typescript-eslint/parser':
       - .ts

.gitignore

@@ -5,6 +5,7 @@ dist/
 docs/
 coverage/
 
+pnpm-lock.yaml
 yarn.lock
 yarn-error.log
 .DS_Store

examples/package.json

@@ -18,5 +18,6 @@
   },
   "dependencies": {
     "jira.js": "latest"
-  }
+  },
+  "type": "module"
 }

examples/src/addFixVersion.mts

@@ -1,6 +1,6 @@
 import { Version3Client } from 'jira.js';
-import { createIssue } from './utils';
-import { apiToken, email, host } from './credentials';
+import { createIssue } from './utils/index.js';
+import { apiToken, email, host } from './credentials.js';
 
 async function addFixVersion() {
   const client = new Version3Client({

examples/src/addWorklog.mts

@@ -1,6 +1,6 @@
 import { Version3Client } from 'jira.js';
-import { createIssue } from './utils';
-import { apiToken, email, host } from './credentials';
+import { createIssue } from './utils/index.js';
+import { apiToken, email, host } from './credentials.js';
 
 async function addWorklog() {
   const client = new Version3Client({

examples/src/basic.mts

@@ -1,5 +1,5 @@
 import { Version3Client } from 'jira.js';
-import { apiToken, email, host } from './credentials';
+import { apiToken, email, host } from './credentials.js';
 
 const client = new Version3Client({
   host,
@@ -45,9 +45,8 @@ async function main() {
   }
 }
 
-main()
-  .catch(e => {
-    console.error(e);
+main().catch(e => {
+  console.error(e);
 
-    throw new Error(JSON.stringify(e));
-  });
+  throw new Error(JSON.stringify(e));
+});

examples/src/getAllWorklogs.mts

@@ -1,6 +1,7 @@
 import { Version3Client } from 'jira.js';
-import { addWorklog, createIssue } from './utils';
-import { apiToken, email, host } from './credentials';
+import type { Worklog } from 'jira.js/out/version3/models';
+import { apiToken, email, host } from './credentials.js';
+import { addWorklog, createIssue } from './utils/index.js';
 
 async function getAllWorklogs() {
   const client = new Version3Client({
@@ -19,7 +20,7 @@ async function getAllWorklogs() {
   await addWorklog(client, issue);
 
   // The main part responsible for getting the worklogs
-  const worklogs = [];
+  const worklogs: Worklog[] = [];
 
   let offset = 0;
   let total = 0;

examples/src/utils/index.mts

@@ -1,2 +1,2 @@
-export * from './addWorklog';
-export * from './createIssue';
+export * from './addWorklog.js';
+export * from './createIssue.js';

tsconfig.lint.json

@@ -2,6 +2,7 @@
   "extends": "./tsconfig.json",
   "include": [
     "examples",
+    "rollup.config.ts",
     "src",
     "tests",
     "vitest.config.mts"