Skip to content

Commit b4547ef

Browse files
JLekawaDmitryAnansky
JLekawa
authored and
DmitryAnansky
committed
docs(all): fix prettier issues
1 parent 53505c6 commit b4547ef

File tree

10 files changed

+648
-360
lines changed

10 files changed

+648
-360
lines changed

‎docs/@v1/installation.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ To install Redocly CLI locally:
1515
1. In your CLI, `cd` to your project's directory.
1616
1. Enter the following command:
1717

18-
```bash
19-
npm i @redocly/cli@latest
20-
```
18+
```bash
19+
npm i @redocly/cli@latest
20+
```
2121

2222
1. (Optional) Run `redocly --version` to confirm that the installation was successful and the currently-installed version of the tool.
2323

@@ -71,9 +71,10 @@ docker pull ghcr.io/redocly/cli
7171

7272
1. To give a Docker container access to your OpenAPI description files, mount the containing directory as a volume:
7373

74-
```bash Example with lint command
75-
docker run --rm -v $PWD:/spec redocly/cli lint openapi.yaml
76-
```
74+
```bash Example with lint command
75+
docker run --rm -v $PWD:/spec redocly/cli lint openapi.yaml
76+
```
77+
7778
This example assumes that the API description file is in your current working folder.
7879

7980
## Run CLI behind a proxy
@@ -85,7 +86,7 @@ These environment variables specify the proxy server for HTTP and HTTPS traffic,
8586

8687
To set the proxy environment variables:
8788

88-
- Open a terminal and use the following command:
89+
- Open a terminal and use the following command:
8990

9091
{% tabs %}
9192
{% tab label="HTTP proxy" %}

‎docs/@v2/installation.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ To install Redocly CLI locally:
1515
1. In your CLI, `cd` to your project's directory.
1616
1. Enter the following command:
1717

18-
```bash
19-
npm i @redocly/cli@latest
20-
```
18+
```bash
19+
npm i @redocly/cli@latest
20+
```
2121

2222
1. (Optional) Run `redocly --version` to confirm that the installation was successful and the currently-installed version of the tool.
2323

@@ -71,9 +71,10 @@ docker pull ghcr.io/redocly/cli
7171

7272
1. To give a Docker container access to your OpenAPI description files, mount the containing directory as a volume:
7373

74-
```bash Example with lint command
75-
docker run --rm -v $PWD:/spec redocly/cli lint openapi.yaml
76-
```
74+
```bash Example with lint command
75+
docker run --rm -v $PWD:/spec redocly/cli lint openapi.yaml
76+
```
77+
7778
This example assumes that the API description file is in your current working folder.
7879

7980
## Run CLI behind a proxy
@@ -85,7 +86,7 @@ These environment variables specify the proxy server for HTTP and HTTPS traffic,
8586

8687
To set the proxy environment variables:
8788

88-
- Open a terminal and use the following command:
89+
- Open a terminal and use the following command:
8990

9091
{% tabs %}
9192
{% tab label="HTTP proxy" %}

‎packages/cli/src/commands/build-docs/template.hbs‎

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,22 @@
1-
<!DOCTYPE html>
21
<html>
32

4-
<head>
5-
<meta charset="utf8" />
6-
<title>{{title}}</title>
7-
<!-- needed for adaptive design -->
8-
<meta name="viewport" content="width=device-width, initial-scale=1">
9-
<style>
10-
body {
11-
padding: 0;
12-
margin: 0;
13-
}
14-
</style>
15-
{{{redocHead}}}
16-
{{#unless disableGoogleFont}}<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">{{/unless}}
17-
</head>
3+
<head>
4+
<meta charset='utf8' />
5+
<title>{{title}}</title>
6+
<!-- needed for adaptive design -->
7+
<meta name='viewport' content='width=device-width, initial-scale=1' />
8+
<style>
9+
body { padding: 0; margin: 0; }
10+
</style>
11+
{{{redocHead}}}
12+
{{#unless disableGoogleFont}}<link
13+
href='https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700'
14+
rel='stylesheet'
15+
/>{{/unless}}
16+
</head>
1817

19-
<body>
20-
{{{redocHTML}}}
21-
</body>
18+
<body>
19+
{{{redocHTML}}}
20+
</body>
2221

23-
</html>
22+
</html>

‎packages/cli/src/commands/preview-project/types.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import type { VerifyConfigOptions } from '../../types.js';
22
import type { PRODUCT_PACKAGES, PRODUCT_PLANS } from './constants.js';
33

44
export type Product = keyof typeof PRODUCT_PACKAGES;
5-
export type ProductPlan = typeof PRODUCT_PLANS[number];
5+
export type ProductPlan = (typeof PRODUCT_PLANS)[number];
66

77
export type PreviewProjectArgv = {
88
product?: Product | string;

‎packages/cli/src/commands/split/types.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export const PATHS = 'paths';
1818
export const WEBHOOKS = 'webhooks';
1919
export const xWEBHOOKS = 'x-webhooks';
2020

21-
export type Oas3Method = typeof OPENAPI3_METHOD_NAMES[number];
21+
export type Oas3Method = (typeof OPENAPI3_METHOD_NAMES)[number];
2222
export const OPENAPI3_METHOD_NAMES = [
2323
'get',
2424
'put',
@@ -31,7 +31,7 @@ export const OPENAPI3_METHOD_NAMES = [
3131
'query',
3232
] as const;
3333

34-
export type Oas3Component = typeof OPENAPI3_COMPONENT_NAMES[number];
34+
export type Oas3Component = (typeof OPENAPI3_COMPONENT_NAMES)[number];
3535
export const OPENAPI3_COMPONENT_NAMES = [
3636
'schemas',
3737
'responses',

‎packages/cli/src/types.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ export type Entrypoint = {
2525
output?: string;
2626
};
2727
export const outputExtensions = ['json', 'yaml', 'yml'] as const;
28-
export type OutputExtension = typeof outputExtensions[number];
28+
export type OutputExtension = (typeof outputExtensions)[number];
2929
export type CommandArgv =
3030
| StatsArgv
3131
| SplitArgv

‎packages/core/src/oas-types.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ export const specVersions = [
4141
'arazzo1',
4242
'overlay1',
4343
] as const;
44-
export type SpecVersion = typeof specVersions[number];
44+
export type SpecVersion = (typeof specVersions)[number];
4545

4646
export type SpecMajorVersion = 'oas2' | 'oas3' | 'async2' | 'async3' | 'arazzo1' | 'overlay1';
4747

‎packages/core/src/types/redocly-yaml.ts‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ const builtInOAS2Rules = [
5757
'no-duplicated-tag-names',
5858
] as const;
5959

60-
export type BuiltInOAS2RuleId = typeof builtInOAS2Rules[number];
60+
export type BuiltInOAS2RuleId = (typeof builtInOAS2Rules)[number];
6161

6262
const builtInOAS3Rules = [
6363
'info-contact',
@@ -121,7 +121,7 @@ const builtInOAS3Rules = [
121121
'spec-example-values',
122122
] as const;
123123

124-
export type BuiltInOAS3RuleId = typeof builtInOAS3Rules[number];
124+
export type BuiltInOAS3RuleId = (typeof builtInOAS3Rules)[number];
125125

126126
const builtInAsync2Rules = [
127127
'info-contact',
@@ -151,9 +151,9 @@ const builtInAsync3Rules = [
151151
'no-schema-type-mismatch',
152152
] as const;
153153

154-
export type BuiltInAsync2RuleId = typeof builtInAsync2Rules[number];
154+
export type BuiltInAsync2RuleId = (typeof builtInAsync2Rules)[number];
155155

156-
export type BuiltInAsync3RuleId = typeof builtInAsync3Rules[number];
156+
export type BuiltInAsync3RuleId = (typeof builtInAsync3Rules)[number];
157157

158158
const builtInArazzo1Rules = [
159159
'sourceDescription-type',
@@ -178,15 +178,15 @@ const builtInArazzo1Rules = [
178178
'x-security-scheme-name-reference',
179179
] as const;
180180

181-
export type BuiltInArazzo1RuleId = typeof builtInArazzo1Rules[number];
181+
export type BuiltInArazzo1RuleId = (typeof builtInArazzo1Rules)[number];
182182

183183
const builtInOverlay1Rules = ['info-contact'] as const;
184184

185-
export type BuiltInOverlay1RuleId = typeof builtInOverlay1Rules[number];
185+
export type BuiltInOverlay1RuleId = (typeof builtInOverlay1Rules)[number];
186186

187187
const builtInCommonRules = ['struct', 'no-unresolved-refs'] as const;
188188

189-
export type BuiltInCommonRuleId = typeof builtInCommonRules[number];
189+
export type BuiltInCommonRuleId = (typeof builtInCommonRules)[number];
190190

191191
const builtInRules = [
192192
...builtInOAS2Rules,
@@ -198,7 +198,7 @@ const builtInRules = [
198198
...builtInCommonRules,
199199
] as const;
200200

201-
type BuiltInRuleId = typeof builtInRules[number];
201+
type BuiltInRuleId = (typeof builtInRules)[number];
202202

203203
const configGovernanceProperties: Record<
204204
keyof RawGovernanceConfig,

‎tests/e2e/build-docs/build-docs-with-config-option/index.hbs‎

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,22 @@
1-
<!DOCTYPE html>
21
<html>
32

4-
<head>
5-
<meta charset="utf8" />
3+
<head>
4+
<meta charset='utf8' />
65
<title>{{title}}</title>
76
<!-- needed for adaptive design -->
8-
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<meta name='viewport' content='width=device-width, initial-scale=1' />
98
<style>
10-
body {
11-
padding: 0;
12-
margin: 0;
13-
}
9+
body { padding: 0; margin: 0; }
1410
</style>
1511
{{{redocHead}}}
16-
{{#unless disableGoogleFont}}<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">{{/unless}}
17-
</head>
12+
{{#unless disableGoogleFont}}<link
13+
href='https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700'
14+
rel='stylesheet'
15+
/>{{/unless}}
16+
</head>
1817

19-
<body>
20-
{{{redocHTML}}}
21-
</body>
18+
<body>
19+
{{{redocHTML}}}
20+
</body>
2221

23-
</html>
22+
</html>

0 commit comments

Comments
 (0)