Skip to content

Commit 56108b0

Browse files
authored
Merge pull request #11 from Exlint/EXL-37
docs: 📘 Updated docs for go command
2 parents 6a09fed + 62fde74 commit 56108b0

File tree

4 files changed

+52
-26
lines changed

4 files changed

+52
-26
lines changed

docs/setup/cli-argument/index.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,24 @@ import styles from './styles.module.css';
1111

1212
Exlint's command-line interface (CLI) allows you to run Exlint on your codebase from the command line. The following arguments are available:
1313

14+
#### Usage commands:
15+
1416
`auth`: This argument is used to authenticate your Exlint account. You will be prompted to enter your API key.
1517

1618
`use`: This argument is used to specify the group you want to run Exlint on using its unique ID. The group ID can be found on the Exlint dashboard.
1719

1820
`run`: This argument is used to run Exlint on your codebase. The `--fix` or `-f` flag can be used to automatically fix any issues found by Exlint.
1921

22+
#### Base commands
23+
24+
`-v`, `--version`: This argument is used to check your Exlint CLI version.
25+
26+
`--env-info`: This argument is used to print system and project information.
27+
28+
#### Debugging
29+
30+
Usage commands can be debugged using the `--debug` flag.
31+
2032
#### Examples:
2133

2234
To authenticate your Exlint account, you can use the following command:

docs/setup/cli-output/index.mdx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,15 @@ The output of the command will display the results of each policy in the group,
1717
For example, when using the run command with a Group that includes the `Prettier` and `ESLint` policies, the output will show the results for each policy in the group.
1818
Here is an example of what the output may look like:
1919

20-
```bash title="Exlint File list"
21-
--- Prettier output ---
20+
```bash title="Terminal"
21+
──────────────────────────── Prettier output ────────────────────────────
2222

2323
Checking formatting...
24-
[warn] .vscode/settings.json
2524
[warn] index.js
26-
[warn] Code style issues found in 2 files. Forgot to run Prettier?
25+
[warn] Code style issues found in 1 files. Forgot to run Prettier?
2726

2827

29-
--- ESLint output ---
28+
──────────────────────────── ESLint output ────────────────────────────
3029

3130
/Users/talrofe/Desktop/Exlint/index.js
3231
4:1 error File has too many lines (4). Maximum allowed is 3 max-lines

docs/setup/policies/index.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,15 @@ import styles from './styles.module.css';
1010
A Policy is a way to apply a set of rules and configurations to your code using a specific library.
1111
This document will guide you through the process of creating and using a Policy in Exlint.
1212

13+
<!---
1314
## Policy in a nutshell
1415

1516
1. In the [Exlint Dashboard](https://app.exlint.io), select the `Group` you want to add a new Policy to.
1617
2. When creating a new Policy, select the open-source library you want to use for your Policy.
1718
3. Apply the appropriate `configurations` for your Policy, following the library guidelines.
1819
4. If the library has `rules` that can be applied, configure them as needed.
1920
5. Run the Policy's Group to get results! ([Running a Group](/setup/groups#running-a-group))
21+
-->
2022

2123
## Configuring a Policy
2224

@@ -35,6 +37,9 @@ For example, Prettier has no `Rules`, and all configuration is `Global`.
3537
### Global Policy configurations
3638

3739
When configuring a global configuration, you have two options:
40+
:::tip
41+
Both options will produce the same result, it's just a matter of preference and ease of use.
42+
:::
3843

3944
1. `Code-based configuration`: This option allows you to input configuration using code, like you would on your IDE.
4045
You can set the configurations using the library's specific syntax and guidelines.
@@ -50,10 +55,6 @@ When configuring a global configuration, you have two options:
5055
This feature is currently under maintanance and not available.
5156
:::
5257

53-
:::tip
54-
Both options will produce the same result, it's just a matter of preference and ease of use.
55-
:::
56-
5758
### File list
5859

5960
The `File list` section allows you to specify which files the policy should run on.

docs/welcome/getting-started/index.mdx

Lines changed: 31 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -29,18 +29,9 @@ Exlint does not require access to code, Git provider, or any other sensitive inf
2929

3030
---
3131

32-
## Using Exlint
33-
34-
### 1. Centralize your compliance in Exlint
35-
36-
Get started by creating an account at [app.exlint.io](https://app.exlint.io).
37-
38-
Create your first Exlint Group, where can organize and manage different policies, and then run them as a group.
39-
These policies are used to check your code for compliance with industry standards and best practices.
32+
## Quickstart
4033

41-
Read more about configuring groups [here](setup/groups).
42-
43-
### 2. Install the Exlint CLI
34+
### 1. Install the Exlint CLI
4435

4536
To install the Exlint CLI with `npm`, run one of the following commands:
4637

@@ -57,27 +48,50 @@ To install the Exlint CLI with `npm`, run one of the following commands:
5748
</TabItem>
5849
</Tabs>
5950

60-
### 3. Connect your CLI to your Exlint Dashboard
51+
### 2. 🚀 Run your first compliance run
52+
53+
Use the `go` command to quickly setup a recommended compliance and customize it in our Dashboard.
54+
55+
```bash
56+
exlint go
57+
```
58+
59+
Exlint will ask you for you project languages, and create a recommended compliance based on how we code at Exlint.
60+
61+
:::tip
62+
Use the go command to easily get started enforcing best practices with Exlint.
63+
You can adjust and customize the compliance for your needs, or create a new one from scratch!
64+
:::
65+
66+
## Using Exlint
67+
68+
### 1. Connect your CLI to your Exlint Dashboard
6169

6270
Use the following command to authenticate with your Exlint account:
6371

64-
exlint auth
72+
```bash
73+
exlint auth
74+
```
6575

66-
### 4. Run an Exlint Group scan on your repository
76+
### 2. Run an Exlint Group scan on your repository
6777

6878
To use a group, copy its identifier and use it with the `use` command in the Exlint CLI.
6979
This will adjust your IDE and install necessary extensions and libraries.
7080

71-
exlint use <group_id>
81+
```bash
82+
exlint use <group_id>
83+
```
7284

7385
Run a group scan against your code using the `run` command:
7486

75-
exlint run [options]
87+
```bash
88+
exlint run [options]
89+
```
7690

7791
You can also run the command with `--fix` or `-f` option.
7892
Providing this option will make Exlint try to automatically fix code issues.
7993

80-
### 5. Integrate Exlint into your CI
94+
### 3. Integrate Exlint into your CI
8195

8296
Keep your CI aligned with your stardartized Exlint compliance using our [GitHub Action](/ci/github-action).
8397
Check out our [roadmap](https://github.com/orgs/Exlint/projects/3) to see which other integrations we're planning to support (or tell us if we're missing the one you like!)

0 commit comments

Comments
 (0)