Code styles improved (MrRefactoring#134)

* Updates for agile code

* prettier for version2 and version3 code

* prettier for version2 and version3 code

* project key changed for tests

* CI flow improved

* tests speed up and fixes for attachments

Author: MrRefactoring

.github/workflows/ci.yaml

@@ -19,7 +19,6 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm ci
-      - run: npm install
       - name: Create .env file
         run: |
           touch .env

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "plugins": [
+    "prettier-plugin-jsdoc"
+  ]
+}

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Jira.js changelog
 
+### 2.3.1
+
+- [#136](https://github.com/MrRefactoring/jira.js/pull/136) Fixed all URLs for Cloud Agile endpoint. Thanks [John Brunton](https://github.com/jbrunton)!
+- Internal code styles improved
+
 ### 2.3.0
 
 - Huge type improvements

README.md

@@ -11,7 +11,7 @@
 
 ## About
 
-jira.js is a powerful [Node.JS](https://nodejs.org/) / Browser module that allows you to interact with the [Jira API](https://developer.atlassian.com/cloud/jira/platform/rest/) very easily.
+jira.js is a powerful [Node.JS](https://nodejs.org/) / Browser module that allows you to interact with the [Jira Cloud API](https://developer.atlassian.com/cloud/jira/platform/rest/) very easily.
 
 Usability, consistency, and performance are key focuses of jira.js, and it also has nearly 100% coverage of the Jira API. It receives new Jira features shortly after they arrive in the API.
 
@@ -241,7 +241,7 @@ client.<group>.<methodName>(parametersObject);
 ```
 
 Available groups:
-- Agile:
+- Agile group:
   - [backlog](https://developer.atlassian.com/cloud/jira/software/rest/api-group-backlog/#api-group-backlog)
   - [board](https://developer.atlassian.com/cloud/jira/software/rest/api-group-board/#api-group-board)
   - [epic](https://developer.atlassian.com/cloud/jira/software/rest/api-group-epic/#api-group-epic)
@@ -253,7 +253,7 @@ Available groups:
   - [builds](https://developer.atlassian.com/cloud/jira/software/rest/api-group-builds/#api-group-builds)
   - [remoteLinks](https://developer.atlassian.com/cloud/jira/software/rest/api-group-remote-links/#api-group-remote-links)
   - [otherOperations](https://developer.atlassian.com/cloud/jira/software/rest/api-group-other-operations/#api-group-other-operations)
-- Version 2:
+- Version 2 group:
   - [applicationRoles](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-application-roles/#api-group-application-roles)
   - [auditRecords](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-audit-records/#api-group-audit-records)
   - [avatars](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-avatars/#api-group-avatars)
@@ -333,7 +333,7 @@ Available groups:
   - [workflowTransitionProperties](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-workflow-transition-properties/#api-group-workflow-transition-properties)
   - [appProperties](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-app-properties/#api-group-app-properties)
   - [dynamicModules](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-dynamic-modules/#api-group-dynamic-modules)
-- Version 3:
+- Version 3 group:
   - [applicationRoles](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-application-roles/#api-group-application-roles)
   - [auditRecords](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-audit-records/#api-group-audit-records)
   - [avatars](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-avatars/#api-group-avatars)

package-lock.json

@@ -17,6 +17,7 @@
   "scripts": {
     "build": "tsc",
     "prepublishOnly": "npm run build && npm run test && npm run lint",
+    "prettier": "prettier --write src/**/*.ts",
     "lint": "npm run lint:tests && npm run lint:src:agile && npm run lint:src:clients && npm run lint:src:services && npm run lint:src:version2 && npm run lint:src:version3 && npm run lint:src:files",
     "lint:tests": "npm run lint:base -- tests",
     "lint:src:agile": "npm run lint:base -- src/agile",
@@ -41,26 +42,28 @@
     "testEnvironment": "node"
   },
   "devDependencies": {
-    "@types/express": "^4.17.11",
+    "@types/express": "^4.17.12",
     "@types/jest": "^26.0.23",
-    "@types/node": "^15.3.0",
+    "@types/node": "^15.12.2",
     "@types/oauth": "^0.9.1",
-    "@types/sinon": "^10.0.0",
-    "@typescript-eslint/eslint-plugin": "^4.23.0",
-    "@typescript-eslint/parser": "^4.23.0",
-    "dotenv": "^9.0.2",
-    "eslint": "^7.26.0",
+    "@types/sinon": "^10.0.2",
+    "@typescript-eslint/eslint-plugin": "^4.26.1",
+    "@typescript-eslint/parser": "^4.26.1",
+    "dotenv": "^10.0.0",
+    "eslint": "^7.28.0",
     "eslint-config-airbnb-typescript": "^12.3.1",
     "eslint-import-resolver-typescript": "^2.4.0",
-    "eslint-plugin-import": "^2.23.2",
+    "eslint-plugin-import": "^2.23.4",
     "jest": "^26.6.3",
-    "sinon": "^10.0.0",
+    "prettier": "^2.3.1",
+    "prettier-plugin-jsdoc": "^0.3.23",
+    "sinon": "^11.1.1",
     "ts-jest": "^26.5.6",
     "typedoc": "^0.20.36",
-    "typescript": "^4.2.4"
+    "typescript": "^4.3.2"
   },
   "dependencies": {
-    "atlassian-jwt": "^2.0.0",
+    "atlassian-jwt": "^2.0.1",
     "axios": "^0.21.1",
     "form-data": "^4.0.0",
     "oauth": "^0.9.15",

package.json

@@ -4,24 +4,29 @@ import { Callback } from '../callback';
 import { RequestConfig } from '../requestConfig';
 
 export class Backlog {
-  constructor(private client: Client) {
-  }
+  constructor(private client: Client) {}
 
   /**
    * Move issues to the backlog.
    *
-   * This operation is equivalent to remove future and active sprints from a given set of issues.
-   * At most 50 issues may be moved at once.
+   * This operation is equivalent to remove future and active sprints from a given set of issues. At most 50 issues may
+   * be moved at once.
    */
-  async moveIssuesToBacklog<T = void>(parameters: Parameters.MoveIssuesToBacklog | undefined, callback: Callback<T>): Promise<void>;
+  async moveIssuesToBacklog<T = void>(
+    parameters: Parameters.MoveIssuesToBacklog | undefined,
+    callback: Callback<T>
+  ): Promise<void>;
   /**
    * Move issues to the backlog.
    *
-   * This operation is equivalent to remove future and active sprints from a given set of issues.
-   * At most 50 issues may be moved at once.
+   * This operation is equivalent to remove future and active sprints from a given set of issues. At most 50 issues may
+   * be moved at once.
    */
   async moveIssuesToBacklog<T = void>(parameters?: Parameters.MoveIssuesToBacklog, callback?: never): Promise<T>;
-  async moveIssuesToBacklog<T = void>(parameters?: Parameters.MoveIssuesToBacklog, callback?: Callback<T>): Promise<void | T> {
+  async moveIssuesToBacklog<T = void>(
+    parameters?: Parameters.MoveIssuesToBacklog,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
     const config: RequestConfig = {
       url: '/rest/agile/1.0/backlog/issue',
       method: 'POST',
@@ -36,20 +41,29 @@ export class Backlog {
   /**
    * Move issues to the backlog of a particular board (if they are already on that board).
    *
-   * This operation is equivalent to remove future and active sprints from a given set of issues if the board has sprints
-   * If the board does not have sprints this will put the issues back into the backlog from the board.
-   * At most 50 issues may be moved at once.
+   * This operation is equivalent to remove future and active sprints from a given set of issues if the board has
+   * sprints If the board does not have sprints this will put the issues back into the backlog from the board. At most
+   * 50 issues may be moved at once.
    */
-  async moveIssuesToBacklogForBoard<T = void>(parameters: Parameters.MoveIssuesToBacklogForBoard, callback: Callback<T>): Promise<void>;
+  async moveIssuesToBacklogForBoard<T = void>(
+    parameters: Parameters.MoveIssuesToBacklogForBoard,
+    callback: Callback<T>
+  ): Promise<void>;
   /**
    * Move issues to the backlog of a particular board (if they are already on that board).
    *
-   * This operation is equivalent to remove future and active sprints from a given set of issues if the board has sprints
-   * If the board does not have sprints this will put the issues back into the backlog from the board.
-   * At most 50 issues may be moved at once.
+   * This operation is equivalent to remove future and active sprints from a given set of issues if the board has
+   * sprints If the board does not have sprints this will put the issues back into the backlog from the board. At most
+   * 50 issues may be moved at once.
    */
-  async moveIssuesToBacklogForBoard<T = void>(parameters: Parameters.MoveIssuesToBacklogForBoard, callback?: never): Promise<T>;
-  async moveIssuesToBacklogForBoard<T = void>(parameters: Parameters.MoveIssuesToBacklogForBoard, callback?: Callback<T>): Promise<void | T> {
+  async moveIssuesToBacklogForBoard<T = void>(
+    parameters: Parameters.MoveIssuesToBacklogForBoard,
+    callback?: never
+  ): Promise<T>;
+  async moveIssuesToBacklogForBoard<T = void>(
+    parameters: Parameters.MoveIssuesToBacklogForBoard,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
     const config: RequestConfig = {
       url: `/rest/agile/1.0/backlog/${parameters.boardId}/issue`,
       method: 'POST',