Skip to content

Commit e66da96

Browse files
committed
style(docs): format mdx files
1 parent f5e91d7 commit e66da96

10 files changed

Lines changed: 78 additions & 24 deletions

File tree

site/src/_partials/option/config.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ import { Code } from "astro:components";
55
The only requirement is that the file must have a file extension and that it is one of `.cjs`, `.cts`, `.js`, `.json`, `.mjs`, `.mts`, `.ts`, `.yaml`, or `.yml`.
66

77
<Code
8-
code={`syncpack ${props.command} --config ./config/syncpack.json`}
9-
lang="bash"
8+
code={`syncpack ${props.command} --config ./config/syncpack.json`}
9+
lang="bash"
1010
/>

site/src/_partials/option/dependencies.mdx

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,29 @@ Include dependencies whose name matches the given glob pattern.
55
To exclude, put a `!` at the start of your query.
66

77
<Code
8-
code={`
8+
code={`
9+
910
# Exact match for "react"
11+
1012
syncpack ${props.command} --dependencies 'react'
13+
1114
# Substring match for "react"
15+
1216
syncpack ${props.command} --dependencies '**react**'
17+
1318
# All dependencies under the AWS SDK scope
14-
syncpack ${props.command} --dependencies '@aws-sdk/**'
19+
20+
syncpack ${props.command} --dependencies '@aws-sdk/\*\*'
21+
1522
# Exact match for "react" or "webpack" (2 approaches)
23+
1624
syncpack ${props.command} --dependencies 'react' --dependencies 'webpack'
1725
syncpack ${props.command} --dependencies '{react,webpack}'
18-
# Substring match for "react" or "webpack" (2 approaches)
26+
27+
# Substring match for "react" or "webpack" (2 approaches)
28+
1929
syncpack ${props.command} --dependencies '**react**' --dependencies '**webpack**'
2030
syncpack ${props.command} --dependencies '**{react,webpack}**'
2131
`.trim()}
22-
lang="bash"
32+
lang="bash"
2333
/>

site/src/_partials/option/dependency-types.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,19 @@ Include dependencies of the given [dependency types](REF_DEPENDENCY_TYPES) and/o
55
To exclude, put a `!` at the start of your query.
66

77
<Code
8-
code={`
8+
code={`
9+
910
# devDependencies only
11+
1012
syncpack ${props.command} --dependency-types dev
13+
1114
# dependencies and devDependencies only
15+
1216
syncpack ${props.command} --dependency-types dev,prod
17+
1318
# everything except peerDependencies
19+
1420
syncpack ${props.command} --dependency-types '!peer'
1521
`.trim()}
16-
lang="bash"
22+
lang="bash"
1723
/>

site/src/_partials/option/help.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,15 @@ import { Code } from "astro:components";
33
Display a list of CLI options and other help information.
44

55
<Code
6-
code={`
6+
code={`
7+
78
# Display a short summary of commands and options
9+
810
syncpack ${props.command} -h
11+
912
# Display full help with examples
13+
1014
syncpack ${props.command} --help
1115
`.trim()}
12-
lang="bash"
16+
lang="bash"
1317
/>

site/src/_partials/option/log-levels.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,19 @@ Control how detailed the log output should be
1010
| debug | Extremely verbose detail on why syncpack assigns each status code |
1111

1212
<Code
13-
code={`
13+
code={`
14+
1415
# Turn off logging completely
16+
1517
syncpack ${props.command} --log-levels off
18+
1619
# Only show verbose debugging logs
20+
1721
syncpack ${props.command} --log-levels debug
22+
1823
# Show everything
24+
1925
syncpack ${props.command} --log-levels error,warn,info,debug
2026
`.trim()}
21-
lang="bash"
27+
lang="bash"
2228
/>

site/src/_partials/option/show-versions.mdx

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,23 @@ Control what information is displayed in terminal output
1111
| none | Shorthand to disable all of the above |
1212

1313
<Code
14-
code={`
14+
code={`
15+
1516
# Only opt into showing status codes
17+
1618
syncpack ${props.command} --show statuses
19+
1720
# Show all instances, not just their names
21+
1822
syncpack ${props.command} --show instances
23+
1924
# Show highest level of detail
25+
2026
syncpack ${props.command} --show all
27+
2128
# Show lowest level of detail
29+
2230
syncpack ${props.command} --show none
2331
`.trim()}
24-
lang="bash"
32+
lang="bash"
2533
/>

site/src/_partials/option/sort.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,15 @@ import { Code } from "astro:components";
33
Change the order in which dependencies are displayed
44

55
<Code
6-
code={`
6+
code={`
7+
78
# Sort by count, in descending order
9+
810
syncpack ${props.command} --sort count
11+
912
# Sort A-Z by name
13+
1014
syncpack ${props.command} --sort name
1115
`.trim()}
12-
lang="bash"
16+
lang="bash"
1317
/>

site/src/_partials/option/source.mdx

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,15 @@ Only run <code>{`syncpack ${props.command}`}</code> on package.json files matchi
66
<HowPackagesAreResolved />
77

88
<Code
9-
code={`# only the root package
9+
code={`# only the root package
1010
syncpack ${props.command} --source 'package.json'
11+
1112
# only packages matching a glob
12-
syncpack ${props.command} --source 'packages/beta-*'
13+
14+
syncpack ${props.command} --source 'packages/beta-\*'
15+
1316
# multiple values can be provided
14-
syncpack ${props.command} --source 'package.json' --source 'packages/beta-*'`}
15-
lang="bash"
17+
18+
syncpack ${props.command} --source 'package.json' --source 'packages/beta-\*'`}
19+
lang="bash"
1620
/>

site/src/_partials/option/specifier-types.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,19 @@ Include only instances whose version specifiers are of the given [specifier type
55
To exclude, put a `!` at the start of your query.
66

77
<Code
8-
code={`
8+
code={`
9+
910
# Exact versions only
11+
1012
syncpack ${props.command} --show instances --specifier-types exact
13+
1114
# Missing or unsupported versions
15+
1216
syncpack ${props.command} --show instances --specifier-types missing,unsupported
17+
1318
# Latest or workspace protocol only
19+
1420
syncpack ${props.command} --show instances --specifier-types latest,workspace-protocol
1521
`.trim()}
16-
lang="bash"
22+
lang="bash"
1723
/>

site/src/_partials/option/target.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,19 @@ import { Code } from "astro:components";
33
Limit updates to only those within the given semver portion.
44

55
<Code
6-
code={`
6+
code={`
7+
78
# Accept any update in latest (x.x.x)
9+
810
syncpack ${props.command} --target latest
11+
912
# Only update minor versions (1.x.x)
13+
1014
syncpack ${props.command} --target minor
15+
1116
# Only update patch versions (1.2.x)
17+
1218
syncpack ${props.command} --target patch
1319
`.trim()}
14-
lang="bash"
20+
lang="bash"
1521
/>

0 commit comments

Comments
 (0)