Skip to content

Commit 77435d4

Browse files
MrRefactoringMrRefactoring
committed
code quality improvements
1 parent c76c93f commit 77435d4

7 files changed

+66
-53
lines changed

‎package.json

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,13 @@
3737
"test": "npm run test:unit && npm run test:integration",
3838
"test:unit": "ava tests/unit --timeout=2m -с 8",
3939
"test:integration": "ava --timeout=2m --fail-fast --no-worker-threads -c 1 -s tests/integration/**/*.test.ts",
40-
"replacePermissions:version2": "grep -rl \"(#permissions)\" ./src/version2 | xargs sed -i '' 's/(#permissions)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v2\\/intro\\/#permissions)/g'",
41-
"replacePermissions:version3": "grep -rl \"(#permissions)\" ./src/version3 | xargs sed -i '' 's/(#permissions)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v3\\/intro\\/#permissions)/g'"
40+
"replace:permissions:version2": "grep -rl \"(#permissions)\" ./src/version2 | xargs sed -i '' 's/(#permissions)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v2\\/intro\\/#permissions)/g'",
41+
"replace:permissions:version3": "grep -rl \"(#permissions)\" ./src/version3 | xargs sed -i '' 's/(#permissions)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v3\\/intro\\/#permissions)/g'",
42+
"replace:pagination:version2": "grep -rl \"(#pagination)\" ./src/version2 | xargs sed -i '' 's/(#pagination)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v2\\/intro\\/#pagination)/g'",
43+
"replace:pagination:version3": "grep -rl \"(#pagination)\" ./src/version3 | xargs sed -i '' 's/(#pagination)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v3\\/intro\\/#pagination)/g'",
44+
"replace:async:version2": "grep -rl \"(#async)\" ./src/version2 | xargs sed -i '' 's/(#async)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v2\\/intro\\/#async-operations)/g'",
45+
"replace:async:version3": "grep -rl \"(#async)\" ./src/version3 | xargs sed -i '' 's/(#async)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v3\\/intro\\/#async-operations)/g'",
46+
"code:formatting": "npm run replace:permissions:version2 && npm run replace:permissions:version3 && npm run replace:pagination:version2 && npm run replace:pagination:version3 && npm run replace:async:version2 && npm run replace:async:version3 && npm run prettier && npm run lint:fix"
4247
},
4348
"ava": {
4449
"extensions": [

‎src/clients/baseClient.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ export class BaseClient implements Client {
1616
try {
1717
new URL(config.host);
1818
} catch (e) {
19-
throw new Error('Couldn\'t parse the host URL. Perhaps you forgot to add \'http://\' or \'https://\' at the beginning of the URL?');
19+
throw new Error(
20+
"Couldn't parse the host URL. Perhaps you forgot to add 'http://' or 'https://' at the beginning of the URL?",
21+
);
2022
}
2123

2224
this.instance = axios.create({

‎src/version3/issueNotificationSchemes.ts

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,11 @@ export class IssueNotificationSchemes {
9393
}
9494

9595
/**
96-
* Returns a [paginated](#pagination) mapping of project that have notification scheme assigned. You can provide
97-
* either one or multiple notification scheme IDs or project IDs to filter by. If you don't provide any, this will
98-
* return a list of all mappings. Note that only company-managed (classic) projects are supported. This is because
99-
* team-managed projects don't have a concept of a default notification scheme. The mappings are ordered by
100-
* projectId.
96+
* Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) mapping of
97+
* project that have notification scheme assigned. You can provide either one or multiple notification scheme IDs or
98+
* project IDs to filter by. If you don't provide any, this will return a list of all mappings. Note that only
99+
* company-managed (classic) projects are supported. This is because team-managed projects don't have a concept of a
100+
* default notification scheme. The mappings are ordered by projectId.
101101
*
102102
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
103103
* Permission to access Jira.
@@ -107,11 +107,11 @@ export class IssueNotificationSchemes {
107107
callback: Callback<T>,
108108
): Promise<void>;
109109
/**
110-
* Returns a [paginated](#pagination) mapping of project that have notification scheme assigned. You can provide
111-
* either one or multiple notification scheme IDs or project IDs to filter by. If you don't provide any, this will
112-
* return a list of all mappings. Note that only company-managed (classic) projects are supported. This is because
113-
* team-managed projects don't have a concept of a default notification scheme. The mappings are ordered by
114-
* projectId.
110+
* Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) mapping of
111+
* project that have notification scheme assigned. You can provide either one or multiple notification scheme IDs or
112+
* project IDs to filter by. If you don't provide any, this will return a list of all mappings. Note that only
113+
* company-managed (classic) projects are supported. This is because team-managed projects don't have a concept of a
114+
* default notification scheme. The mappings are ordered by projectId.
115115
*
116116
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
117117
* Permission to access Jira.

‎src/version3/issuePriorities.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,8 @@ export class IssuePriorities {
129129
}
130130

131131
/**
132-
* Returns a [paginated](#pagination) list of priorities. The list can contain all priorities or a subset determined
133-
* by any combination of these criteria:
132+
* Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of
133+
* priorities. The list can contain all priorities or a subset determined by any combination of these criteria:
134134
*
135135
* - A list of priority IDs. Any invalid priority IDs are ignored.
136136
* - Whether the field configuration is a default. This returns priorities from company-managed (classic) projects only,
@@ -144,8 +144,8 @@ export class IssuePriorities {
144144
callback: Callback<T>,
145145
): Promise<void>;
146146
/**
147-
* Returns a [paginated](#pagination) list of priorities. The list can contain all priorities or a subset determined
148-
* by any combination of these criteria:
147+
* Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of
148+
* priorities. The list can contain all priorities or a subset determined by any combination of these criteria:
149149
*
150150
* - A list of priority IDs. Any invalid priority IDs are ignored.
151151
* - Whether the field configuration is a default. This returns priorities from company-managed (classic) projects only,

‎src/version3/issueResolutions.ts

Lines changed: 36 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ export class IssueResolutions {
3333
/**
3434
* Creates an issue resolution.
3535
*
36-
* **[Permissions](#permissions) required:** _Administer Jira_ [global
37-
* permission](https://confluence.atlassian.com/x/x4dKLg).
36+
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
37+
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
3838
*/
3939
async createResolution<T = Models.ResolutionId>(
4040
parameters: Parameters.CreateResolution,
@@ -43,8 +43,8 @@ export class IssueResolutions {
4343
/**
4444
* Creates an issue resolution.
4545
*
46-
* **[Permissions](#permissions) required:** _Administer Jira_ [global
47-
* permission](https://confluence.atlassian.com/x/x4dKLg).
46+
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
47+
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
4848
*/
4949
async createResolution<T = Models.ResolutionId>(
5050
parameters: Parameters.CreateResolution,
@@ -66,8 +66,8 @@ export class IssueResolutions {
6666
/**
6767
* Sets default issue resolution.
6868
*
69-
* **[Permissions](#permissions) required:** _Administer Jira_ [global
70-
* permission](https://confluence.atlassian.com/x/x4dKLg).
69+
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
70+
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
7171
*/
7272
async setDefaultResolution<T = void>(
7373
parameters: Parameters.SetDefaultResolution,
@@ -76,8 +76,8 @@ export class IssueResolutions {
7676
/**
7777
* Sets default issue resolution.
7878
*
79-
* **[Permissions](#permissions) required:** _Administer Jira_ [global
80-
* permission](https://confluence.atlassian.com/x/x4dKLg).
79+
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
80+
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
8181
*/
8282
async setDefaultResolution<T = void>(parameters: Parameters.SetDefaultResolution, callback?: never): Promise<T>;
8383
async setDefaultResolution<T = void>(
@@ -98,15 +98,15 @@ export class IssueResolutions {
9898
/**
9999
* Changes the order of issue resolutions.
100100
*
101-
* **[Permissions](#permissions) required:** _Administer Jira_ [global
102-
* permission](https://confluence.atlassian.com/x/x4dKLg).
101+
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
102+
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
103103
*/
104104
async moveResolutions<T = void>(parameters: Parameters.MoveResolutions, callback: Callback<T>): Promise<void>;
105105
/**
106106
* Changes the order of issue resolutions.
107107
*
108-
* **[Permissions](#permissions) required:** _Administer Jira_ [global
109-
* permission](https://confluence.atlassian.com/x/x4dKLg).
108+
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
109+
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
110110
*/
111111
async moveResolutions<T = void>(parameters: Parameters.MoveResolutions, callback?: never): Promise<T>;
112112
async moveResolutions<T = void>(parameters: Parameters.MoveResolutions, callback?: Callback<T>): Promise<void | T> {
@@ -124,28 +124,30 @@ export class IssueResolutions {
124124
}
125125

126126
/**
127-
* Returns a [paginated](#pagination) list of resolutions. The list can contain all resolutions or a subset determined
128-
* by any combination of these criteria:
127+
* Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of
128+
* resolutions. The list can contain all resolutions or a subset determined by any combination of these criteria:
129129
*
130130
* - A list of resolutions IDs.
131131
* - Whether the field configuration is a default. This returns resolutions from company-managed (classic) projects
132132
* only, as there is no concept of default resolutions in team-managed projects.
133133
*
134-
* **[Permissions](#permissions) required:** Permission to access Jira.
134+
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
135+
* Permission to access Jira.
135136
*/
136137
async searchResolutions<T = Models.PageResolution>(
137138
parameters: Parameters.SearchResolutions | undefined,
138139
callback: Callback<T>,
139140
): Promise<void>;
140141
/**
141-
* Returns a [paginated](#pagination) list of resolutions. The list can contain all resolutions or a subset determined
142-
* by any combination of these criteria:
142+
* Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of
143+
* resolutions. The list can contain all resolutions or a subset determined by any combination of these criteria:
143144
*
144145
* - A list of resolutions IDs.
145146
* - Whether the field configuration is a default. This returns resolutions from company-managed (classic) projects
146147
* only, as there is no concept of default resolutions in team-managed projects.
147148
*
148-
* **[Permissions](#permissions) required:** Permission to access Jira.
149+
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
150+
* Permission to access Jira.
149151
*/
150152
async searchResolutions<T = Models.PageResolution>(
151153
parameters?: Parameters.SearchResolutions,
@@ -201,15 +203,15 @@ export class IssueResolutions {
201203
/**
202204
* Updates an issue resolution.
203205
*
204-
* **[Permissions](#permissions) required:** _Administer Jira_ [global
205-
* permission](https://confluence.atlassian.com/x/x4dKLg).
206+
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
207+
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
206208
*/
207209
async updateResolution<T = void>(parameters: Parameters.UpdateResolution, callback: Callback<T>): Promise<void>;
208210
/**
209211
* Updates an issue resolution.
210212
*
211-
* **[Permissions](#permissions) required:** _Administer Jira_ [global
212-
* permission](https://confluence.atlassian.com/x/x4dKLg).
213+
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
214+
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
213215
*/
214216
async updateResolution<T = void>(parameters: Parameters.UpdateResolution, callback?: never): Promise<T>;
215217
async updateResolution<T = void>(parameters: Parameters.UpdateResolution, callback?: Callback<T>): Promise<void | T> {
@@ -230,11 +232,13 @@ export class IssueResolutions {
230232
/**
231233
* Deletes an issue resolution.
232234
*
233-
* This operation is [asynchronous](#async). Follow the `location` link in the response to determine the status of the
234-
* task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
235+
* This operation is
236+
* [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#async-operations). Follow the
237+
* `location` link in the response to determine the status of the task and use [Get
238+
* task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
235239
*
236-
* **[Permissions](#permissions) required:** _Administer Jira_ [global
237-
* permission](https://confluence.atlassian.com/x/x4dKLg).
240+
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
241+
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
238242
*/
239243
async deleteResolution<T = Models.TaskProgressObject>(
240244
parameters: Parameters.DeleteResolution,
@@ -243,11 +247,13 @@ export class IssueResolutions {
243247
/**
244248
* Deletes an issue resolution.
245249
*
246-
* This operation is [asynchronous](#async). Follow the `location` link in the response to determine the status of the
247-
* task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
250+
* This operation is
251+
* [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#async-operations). Follow the
252+
* `location` link in the response to determine the status of the task and use [Get
253+
* task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
248254
*
249-
* **[Permissions](#permissions) required:** _Administer Jira_ [global
250-
* permission](https://confluence.atlassian.com/x/x4dKLg).
255+
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
256+
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
251257
*/
252258
async deleteResolution<T = Models.TaskProgressObject>(
253259
parameters: Parameters.DeleteResolution,

‎src/version3/projectComponents.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@ export class ProjectComponents {
7878
*
7979
* This operation can be accessed anonymously.
8080
*
81-
* **[Permissions](#permissions) required:** _Browse projects_ [project
82-
* permission](https://confluence.atlassian.com/x/yodKLg) for project containing the component.
81+
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** _Browse
82+
* projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for project containing the component.
8383
*/
8484
async getComponent<T = Models.ProjectComponent>(parameters: Parameters.GetComponent, callback?: never): Promise<T>;
8585
async getComponent<T = Models.ProjectComponent>(

‎src/version3/projects.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -595,8 +595,8 @@ export class Projects {
595595
* Gets a [notification scheme](https://confluence.atlassian.com/x/8YdKLg) associated with the project. Deprecated,
596596
* use [Get notification schemes paginated](#api-rest-api-3-notificationscheme-get) supporting search and pagination.
597597
*
598-
* **[Permissions](#permissions) required:** _Administer Jira_ [global
599-
* permission](https://confluence.atlassian.com/x/x4dKLg) or _Administer Projects_ [project
598+
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
599+
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg) or _Administer Projects_ [project
600600
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
601601
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg) or _Administer Projects_ [project
602602
* permission](https://confluence.atlassian.com/x/yodKLg).
@@ -609,8 +609,8 @@ export class Projects {
609609
* Gets a [notification scheme](https://confluence.atlassian.com/x/8YdKLg) associated with the project. Deprecated,
610610
* use [Get notification schemes paginated](#api-rest-api-3-notificationscheme-get) supporting search and pagination.
611611
*
612-
* **[Permissions](#permissions) required:** _Administer Jira_ [global
613-
* permission](https://confluence.atlassian.com/x/x4dKLg) or _Administer Projects_ [project
612+
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
613+
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg) or _Administer Projects_ [project
614614
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
615615
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg) or _Administer Projects_ [project
616616
* permission](https://confluence.atlassian.com/x/yodKLg).

0 commit comments

Comments
 (0)