Skip to content

Commit b5d95e5

Browse files
deploy: dd7d3a9
1 parent 5ce2501 commit b5d95e5

File tree

65 files changed

+47
-222
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+47
-222
lines changed

command/fix/index.html

Lines changed: 3 additions & 42 deletions
Large diffs are not rendered by default.

command/format/index.html

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,9 @@
8080
<div class="sl-heading-wrapper level-h2"><h2 id="examples">Examples</h2><a class="sl-anchor-link" href="#examples"><span aria-hidden="true" class="sl-anchor-icon"><svg width="16" height="16" viewBox="0 0 24 24"><path fill="currentcolor" d="m12.11 15.39-3.88 3.88a2.52 2.52 0 0 1-3.5 0 2.47 2.47 0 0 1 0-3.5l3.88-3.88a1 1 0 0 0-1.42-1.42l-3.88 3.89a4.48 4.48 0 0 0 6.33 6.33l3.89-3.88a1 1 0 1 0-1.42-1.42Zm8.58-12.08a4.49 4.49 0 0 0-6.33 0l-3.89 3.88a1 1 0 0 0 1.42 1.42l3.88-3.88a2.52 2.52 0 0 1 3.5 0 2.47 2.47 0 0 1 0 3.5l-3.88 3.88a1 1 0 1 0 1.42 1.42l3.88-3.89a4.49 4.49 0 0 0 0-6.33ZM8.83 15.17a1 1 0 0 0 1.1.22 1 1 0 0 0 .32-.22l4.92-4.92a1 1 0 0 0-1.42-1.42l-4.92 4.92a1 1 0 0 0 0 1.42Z"></path></svg></span><span class="sr-only">Section titled “Examples”</span></a></div>
8181
<div class="expressive-code"><link rel="stylesheet" href="/syncpack/_astro/ec.pwai7.css"><script type="module" src="/syncpack/_astro/ec.8zarh.js"></script><figure class="frame is-terminal not-content"><figcaption class="header"><span class="title"></span><span class="sr-only">Terminal window</span></figcaption><pre data-language="bash"><code><div class="ec-line"><div class="code"><span style="--0:#616972;--1:#8B949E"># Fix every formatting issue in the monorepo</span></div></div><div class="ec-line"><div class="code"><span style="--0:#953800;--1:#FFA657">syncpack</span><span style="--0:#1F2328;--1:#E6EDF3"> </span><span style="--0:#0A3069;--1:#A5D6FF">format</span></div></div><div class="ec-line"><div class="code"><span style="--0:#616972;--1:#8B949E"># List all formatting issues in the monorepo</span></div></div><div class="ec-line"><div class="code"><span style="--0:#953800;--1:#FFA657">syncpack</span><span style="--0:#1F2328;--1:#E6EDF3"> </span><span style="--0:#0A3069;--1:#A5D6FF">format</span><span style="--0:#1F2328;--1:#E6EDF3"> </span><span style="--0:#0550AE;--1:#79C0FF">--check</span></div></div><div class="ec-line"><div class="code"><span style="--0:#616972;--1:#8B949E"># Check the formatting of one package</span></div></div><div class="ec-line"><div class="code"><span style="--0:#953800;--1:#FFA657">syncpack</span><span style="--0:#1F2328;--1:#E6EDF3"> </span><span style="--0:#0A3069;--1:#A5D6FF">format</span><span style="--0:#1F2328;--1:#E6EDF3"> </span><span style="--0:#0550AE;--1:#79C0FF">--check</span><span style="--0:#1F2328;--1:#E6EDF3"> </span><span style="--0:#0550AE;--1:#79C0FF">--source</span><span style="--0:#1F2328;--1:#E6EDF3"> </span><span style="--0:#0A3069;--1:#A5D6FF">'packages/pingu/package.json'</span></div></div><div class="ec-line"><div class="code"><span style="--0:#616972;--1:#8B949E"># See more examples</span></div></div><div class="ec-line"><div class="code"><span style="--0:#953800;--1:#FFA657">syncpack</span><span style="--0:#1F2328;--1:#E6EDF3"> </span><span style="--0:#0A3069;--1:#A5D6FF">format</span><span style="--0:#1F2328;--1:#E6EDF3"> </span><span style="--0:#0550AE;--1:#79C0FF">--help</span></div></div><div class="ec-line"><div class="code"><span style="--0:#616972;--1:#8B949E"># See a short summary of options</span></div></div><div class="ec-line"><div class="code"><span style="--0:#953800;--1:#FFA657">syncpack</span><span style="--0:#1F2328;--1:#E6EDF3"> </span><span style="--0:#0A3069;--1:#A5D6FF">format</span><span style="--0:#1F2328;--1:#E6EDF3"> </span><span style="--0:#0550AE;--1:#79C0FF">-h</span></div></div></code></pre><div class="copy"><button title="Copy to clipboard" data-copied="Copied!" data-code="syncpack formatsyncpack format --checksyncpack format --check --source &#x27;packages/pingu/package.json&#x27;syncpack format --helpsyncpack format -h"><div></div></button></div></figure></div>
8282
<div class="sl-heading-wrapper level-h2"><h2 id="options">Options</h2><a class="sl-anchor-link" href="#options"><span aria-hidden="true" class="sl-anchor-icon"><svg width="16" height="16" viewBox="0 0 24 24"><path fill="currentcolor" d="m12.11 15.39-3.88 3.88a2.52 2.52 0 0 1-3.5 0 2.47 2.47 0 0 1 0-3.5l3.88-3.88a1 1 0 0 0-1.42-1.42l-3.88 3.89a4.48 4.48 0 0 0 6.33 6.33l3.89-3.88a1 1 0 1 0-1.42-1.42Zm8.58-12.08a4.49 4.49 0 0 0-6.33 0l-3.89 3.88a1 1 0 0 0 1.42 1.42l3.88-3.88a2.52 2.52 0 0 1 3.5 0 2.47 2.47 0 0 1 0 3.5l-3.88 3.88a1 1 0 1 0 1.42 1.42l3.88-3.89a4.49 4.49 0 0 0 0-6.33ZM8.83 15.17a1 1 0 0 0 1.1.22 1 1 0 0 0 .32-.22l4.92-4.92a1 1 0 0 0-1.42-1.42l-4.92 4.92a1 1 0 0 0 0 1.42Z"></path></svg></span><span class="sr-only">Section titled “Options”</span></a></div>
83-
<div><p><code>*</code> <code>!</code> <code>{</code> <code>}</code> etc</p><p>When passing values to <code>syncpack</code> via the command line, remember to add quotes around values containing special characters so your shell does not interpret them.</p></div>
83+
<aside aria-label="* ! { } etc" class="starlight-aside starlight-aside--tip"> <p class="starlight-aside__title" aria-hidden="true"> <svg aria-hidden="true" class="starlight-aside__icon astro-zbkotcip" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1em;"><path fill-rule="evenodd" d="M1.44 8.855v-.001l3.527-3.516c.34-.344.802-.541 1.285-.548h6.649l.947-.947c3.07-3.07 6.207-3.072 7.62-2.868a1.821 1.821 0 0 1 1.557 1.557c.204 1.413.203 4.55-2.868 7.62l-.946.946v6.649a1.845 1.845 0 0 1-.549 1.286l-3.516 3.528a1.844 1.844 0 0 1-3.11-.944l-.858-4.275-4.52-4.52-2.31-.463-1.964-.394A1.847 1.847 0 0 1 .98 10.693a1.843 1.843 0 0 1 .46-1.838Zm5.379 2.017-3.873-.776L6.32 6.733h4.638l-4.14 4.14Zm8.403-5.655c2.459-2.46 4.856-2.463 5.89-2.33.134 1.035.13 3.432-2.329 5.891l-6.71 6.71-3.561-3.56 6.71-6.711Zm-1.318 15.837-.776-3.873 4.14-4.14v4.639l-3.364 3.374Z" clip-rule="evenodd"/><path d="M9.318 18.345a.972.972 0 0 0-1.86-.561c-.482 1.435-1.687 2.204-2.934 2.619a8.22 8.22 0 0 1-1.23.302c.062-.365.157-.79.303-1.229.415-1.247 1.184-2.452 2.62-2.935a.971.971 0 1 0-.62-1.842c-.12.04-.236.084-.35.13-2.02.828-3.012 2.588-3.493 4.033a10.383 10.383 0 0 0-.51 2.845l-.001.016v.063c0 .536.434.972.97.972H2.24a7.21 7.21 0 0 0 .878-.065c.527-.063 1.248-.19 2.02-.447 1.445-.48 3.205-1.472 4.033-3.494a5.828 5.828 0 0 0 .147-.407Z"/></svg>* ! { } etc </p> <div class="starlight-aside__content"> <p>When passing values to <code>syncpack</code> via the command line, remember to add quotes
84+
around values containing special characters so your shell does not interpret
85+
them.</p> </div> </aside>
8486
<div class="sl-heading-wrapper level-h3"><h3 id="--check">--check</h3><a class="sl-anchor-link" href="#--check"><span aria-hidden="true" class="sl-anchor-icon"><svg width="16" height="16" viewBox="0 0 24 24"><path fill="currentcolor" d="m12.11 15.39-3.88 3.88a2.52 2.52 0 0 1-3.5 0 2.47 2.47 0 0 1 0-3.5l3.88-3.88a1 1 0 0 0-1.42-1.42l-3.88 3.89a4.48 4.48 0 0 0 6.33 6.33l3.89-3.88a1 1 0 1 0-1.42-1.42Zm8.58-12.08a4.49 4.49 0 0 0-6.33 0l-3.89 3.88a1 1 0 0 0 1.42 1.42l3.88-3.88a2.52 2.52 0 0 1 3.5 0 2.47 2.47 0 0 1 0 3.5l-3.88 3.88a1 1 0 1 0 1.42 1.42l3.88-3.89a4.49 4.49 0 0 0 0-6.33ZM8.83 15.17a1 1 0 0 0 1.1.22 1 1 0 0 0 .32-.22l4.92-4.92a1 1 0 0 0-1.42-1.42l-4.92 4.92a1 1 0 0 0 0 1.42Z"></path></svg></span><span class="sr-only">Section titled “--check”</span></a></div>
8587
<p>Lint formatting instead of fixing it and exit with a status code of 1 if issues are found.</p>
8688
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="bash"><code><span class="line"><span style="color:#B392F0">syncpack</span><span style="color:#9ECBFF"> format</span><span style="color:#79B8FF"> --check</span></span></code></pre>
@@ -120,15 +122,10 @@
120122

121123
<table><thead><tr><th>Level</th><th>What is written to this channel</th></tr></thead><tbody><tr><td>info</td><td>The standard output which forms syncpack's UI, including lint issues</td></tr><tr><td>warn</td><td>Possible mistakes in your setup, or highlights of known gaps in syncpack</td></tr><tr><td>error</td><td>Fatal exceptions or errors outside the normal running of syncpack</td></tr><tr><td>debug</td><td>Extremely verbose detail on why syncpack assigns each status code</td></tr></tbody></table>
122124
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="bash"><code><span class="line"><span style="color:#6A737D"># Turn off logging completely</span></span>
123-
<span class="line"></span>
124125
<span class="line"><span style="color:#B392F0">syncpack</span><span style="color:#9ECBFF"> format</span><span style="color:#79B8FF"> --log-levels</span><span style="color:#9ECBFF"> off</span></span>
125-
<span class="line"></span>
126126
<span class="line"><span style="color:#6A737D"># Only show verbose debugging logs</span></span>
127-
<span class="line"></span>
128127
<span class="line"><span style="color:#B392F0">syncpack</span><span style="color:#9ECBFF"> format</span><span style="color:#79B8FF"> --log-levels</span><span style="color:#9ECBFF"> debug</span></span>
129-
<span class="line"></span>
130128
<span class="line"><span style="color:#6A737D"># Show everything</span></span>
131-
<span class="line"></span>
132129
<span class="line"><span style="color:#B392F0">syncpack</span><span style="color:#9ECBFF"> format</span><span style="color:#79B8FF"> --log-levels</span><span style="color:#9ECBFF"> error,warn,info,debug</span></span></code></pre>
133130
<div class="sl-heading-wrapper level-h3"><h3 id="--no-ansi">--no-ansi</h3><a class="sl-anchor-link" href="#--no-ansi"><span aria-hidden="true" class="sl-anchor-icon"><svg width="16" height="16" viewBox="0 0 24 24"><path fill="currentcolor" d="m12.11 15.39-3.88 3.88a2.52 2.52 0 0 1-3.5 0 2.47 2.47 0 0 1 0-3.5l3.88-3.88a1 1 0 0 0-1.42-1.42l-3.88 3.89a4.48 4.48 0 0 0 6.33 6.33l3.89-3.88a1 1 0 1 0-1.42-1.42Zm8.58-12.08a4.49 4.49 0 0 0-6.33 0l-3.89 3.88a1 1 0 0 0 1.42 1.42l3.88-3.88a2.52 2.52 0 0 1 3.5 0 2.47 2.47 0 0 1 0 3.5l-3.88 3.88a1 1 0 1 0 1.42 1.42l3.88-3.89a4.49 4.49 0 0 0 0-6.33ZM8.83 15.17a1 1 0 0 0 1.1.22 1 1 0 0 0 .32-.22l4.92-4.92a1 1 0 0 0-1.42-1.42l-4.92 4.92a1 1 0 0 0 0 1.42Z"></path></svg></span><span class="sr-only">Section titled “--no-ansi”</span></a></div>
134131
<p>Syncpack will print colours and clickable hyperlinks to the terminal using <a href="https://en.wikipedia.org/wiki/ANSI_escape_code">ANSI escape code</a> unless this option is set.</p>
@@ -146,20 +143,13 @@
146143
</ol>
147144
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="bash"><code><span class="line"><span style="color:#6A737D"># only the root package</span></span>
148145
<span class="line"><span style="color:#B392F0">syncpack</span><span style="color:#9ECBFF"> format</span><span style="color:#79B8FF"> --source</span><span style="color:#9ECBFF"> 'package.json'</span></span>
149-
<span class="line"></span>
150146
<span class="line"><span style="color:#6A737D"># only packages matching a glob</span></span>
151-
<span class="line"></span>
152147
<span class="line"><span style="color:#B392F0">syncpack</span><span style="color:#9ECBFF"> format</span><span style="color:#79B8FF"> --source</span><span style="color:#9ECBFF"> 'packages/beta-*'</span></span>
153-
<span class="line"></span>
154148
<span class="line"><span style="color:#6A737D"># multiple values can be provided</span></span>
155-
<span class="line"></span>
156149
<span class="line"><span style="color:#B392F0">syncpack</span><span style="color:#9ECBFF"> format</span><span style="color:#79B8FF"> --source</span><span style="color:#9ECBFF"> 'package.json'</span><span style="color:#79B8FF"> --source</span><span style="color:#9ECBFF"> 'packages/beta-*'</span></span></code></pre>
157150
<div class="sl-heading-wrapper level-h3"><h3 id="--help">--help</h3><a class="sl-anchor-link" href="#--help"><span aria-hidden="true" class="sl-anchor-icon"><svg width="16" height="16" viewBox="0 0 24 24"><path fill="currentcolor" d="m12.11 15.39-3.88 3.88a2.52 2.52 0 0 1-3.5 0 2.47 2.47 0 0 1 0-3.5l3.88-3.88a1 1 0 0 0-1.42-1.42l-3.88 3.89a4.48 4.48 0 0 0 6.33 6.33l3.89-3.88a1 1 0 1 0-1.42-1.42Zm8.58-12.08a4.49 4.49 0 0 0-6.33 0l-3.89 3.88a1 1 0 0 0 1.42 1.42l3.88-3.88a2.52 2.52 0 0 1 3.5 0 2.47 2.47 0 0 1 0 3.5l-3.88 3.88a1 1 0 1 0 1.42 1.42l3.88-3.89a4.49 4.49 0 0 0 0-6.33ZM8.83 15.17a1 1 0 0 0 1.1.22 1 1 0 0 0 .32-.22l4.92-4.92a1 1 0 0 0-1.42-1.42l-4.92 4.92a1 1 0 0 0 0 1.42Z"></path></svg></span><span class="sr-only">Section titled “--help”</span></a></div>
158151
<p>Display a list of CLI options and other help information.</p>
159152
<pre class="astro-code github-dark" style="background-color:#24292e;color:#e1e4e8; overflow-x: auto;" tabindex="0" data-language="bash"><code><span class="line"><span style="color:#6A737D"># Display a short summary of commands and options</span></span>
160-
<span class="line"></span>
161153
<span class="line"><span style="color:#B392F0">syncpack</span><span style="color:#9ECBFF"> format</span><span style="color:#79B8FF"> -h</span></span>
162-
<span class="line"></span>
163154
<span class="line"><span style="color:#6A737D"># Display full help with examples</span></span>
164-
<span class="line"></span>
165155
<span class="line"><span style="color:#B392F0">syncpack</span><span style="color:#9ECBFF"> format</span><span style="color:#79B8FF"> --help</span></span></code></pre> </div> <footer class="sl-flex astro-5ommezym"> <div class="meta sl-flex astro-5ommezym"> <a href="https://github.com/JamieMason/syncpack/edit/main/site/src/content/docs/command/format.mdx" class="sl-flex print:hidden astro-7azdwqg5"><svg aria-hidden="true" class="astro-7azdwqg5 astro-zbkotcip" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1.2em;"><path d="M22 7.24a1 1 0 0 0-.29-.71l-4.24-4.24a1 1 0 0 0-1.1-.22 1 1 0 0 0-.32.22l-2.83 2.83L2.29 16.05a1 1 0 0 0-.29.71V21a1 1 0 0 0 1 1h4.24a1 1 0 0 0 .76-.29l10.87-10.93L21.71 8c.1-.1.17-.2.22-.33a1 1 0 0 0 0-.24v-.14l.07-.05ZM6.83 20H4v-2.83l9.93-9.93 2.83 2.83L6.83 20ZM18.17 8.66l-2.83-2.83 1.42-1.41 2.82 2.82-1.41 1.42Z"/></svg>Edit page</a> </div> <div class="pagination-links print:hidden astro-toycqs26" dir="ltr"> </div> </footer> </div> </div> </main> </div> </div> </div> </div> </body></html>

0 commit comments

Comments
 (0)