Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/ci/github-action/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,18 @@ import styles from './styles.module.css';
The [Exlint Action](https://github.com/Exlint/actions) is a GitHub Action that allows you to integrate Exlint into your CI (Continuous Integration) workflow.
It can help you improve the quality of your code by catching errors and potential bugs, enforcing coding standards, and identifying security vulnerabilities.

To use the Exlint Action, you must have a token and a group configured. You can get your token for CI usage on the secret management page of [app.exlint.io](https://app.exlint.io).
To use the Exlint Action, you must have a token and a compliance configured. You can get your token for CI usage on the secret management page of [app.exlint.io](https://app.exlint.io).
Read more about creating secrets [here](/setup/secret-management)

To add the Exlint Action to your workflow, include the following in your config file:

```yaml title="Github Action"
- uses: Exlint/actions@v1.0.0
with:
# Your configured group ID - Required
groupId: ''
# Your configured compliance ID - Required
complianceId: ''
# Your token for CI - Required
token: ''
```

The Exlint Action will then run Exlint on your codebase and check for any issues or violations of the rules specified in your group.
The Exlint Action will then run Exlint on your codebase and check for any issues or violations of the rules specified in your compliance.
2 changes: 1 addition & 1 deletion docs/data-privacy/user-account-data/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ At Exlint, we take data privacy seriously.
When it comes to user and account data, we want to ensure that our users understand what information we collect and how it is used.

It's important to notice that if you are using the Exlint app, in order to use the service we need you to have an account with us.
This account includes personal data such as your email address and also the groups you created on the app.
This account includes personal data such as your email address and also the compliances you created on the app.
This information is necessary for us to provide you with access to the Exlint service and to communicate with you regarding your account and usage of the service.

We also collect usage data related to your account, such as the number of times you run Exlint and the results of those runs.
Expand Down
8 changes: 4 additions & 4 deletions docs/setup/cli-argument/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Exlint's command-line interface (CLI) allows you to run Exlint on your codebase

`auth`: This argument is used to authenticate your Exlint account. You will be prompted to enter your API key.

`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.
`use`: This argument is used to specify the compliance you want to run Exlint on using its unique ID. The compliance ID can be found on the Exlint dashboard.

`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.

Expand All @@ -37,10 +37,10 @@ To authenticate your Exlint account, you can use the following command:
exlint auth
```

To use Exlint with a specific group, you can use the following command:
To use Exlint with a specific compliance, you can use the following command:

```bash
exlint use <group-id>
exlint use <compliance-id>
```

To run Exlint and automatically fix any issues found, you can use the following command:
Expand All @@ -50,5 +50,5 @@ exlint run --fix
```

:::info
Please note that if you are using the `run` command, you should have previously used the `use` command to specify the group you want to run exlint on.
Please note that if you are using the `run` command, you should have previously used the `use` command to specify the compliance you want to run exlint on.
:::
6 changes: 3 additions & 3 deletions docs/setup/cli-output/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import styles from './styles.module.css';

Exlint's `run` command allows you to execute the linting and scanning of your code using the policies in a specific group.
The output of the command will display the results of each policy in the group, similar to running the linter or formatter for each library separately.
Exlint's `run` command allows you to execute the linting and scanning of your code using the policies in a specific compliance.
The output of the command will display the results of each policy in the compliance, similar to running the linter or formatter for each library separately.

#### Examples

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.
For example, when using the run command with a Compliance that includes the `Prettier` and `ESLint` policies, the output will show the results for each policy in the compliance.
Here is an example of what the output may look like:

```bash title="Terminal"
Expand Down
4 changes: 4 additions & 0 deletions docs/setup/compliances/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Compliances",
"position": 1
}
48 changes: 48 additions & 0 deletions docs/setup/compliances/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
sidebar_position: 1
slug: /setup/compliances
title: Compliances
description: Exlint is a CLI tool that provides developers a quick and efficient application of multiple coding rule policies in multiple projects
---

import styles from './styles.module.css';

Exlint Compliances allows you to manage and enforce coding standards across multiple projects and teams.

## What is an Exlint Compliance?

A Compliance is a set of configurable open-source policie that can be run together on any project in a matter of seconds.

## Creating a Compliance

To create a compliance, you'll need to visit the Compliance Management page on the Exlint Dashboard. Here, you can create a new compliance which is assigned with a unique identifier.
Once you've created a compliance, you can configure its open-source policies to suit your needs.

Read more about configuring policies in the [policies section](/setup/policies).

## Running a Compliance

To use an Exlint Compliance in your project, you'll first need to configure an account on the Exlint Dashboard.

Once your account is set up, use `exlint auth` to authenticate your user with Exlint.

```bash
exlint auth
```

Now you can use the compliance in your project by running `exlint use <compliance_id>` in the terminal from your project's root folder.
Exlint will configure your project with the required libraries and plugins for easy development. You can also see your linters in action if the linter support live linting.

```bash
exlint use <compliance_id>
```

:::tip
You can easily switch compliance in your project by running the `exlint use <compliance_id>` command again!
:::

To run the compliance policies over your project, you can use the command `exlint run`. Exlint will automatically use the configured compliance and output the policies' results.

exlint run [options]

You can also run the command with `--fix` or `-f` option. Providinig this option will make Exlint try to automatically fix your code issues.
4 changes: 0 additions & 4 deletions docs/setup/groups/_category_.json

This file was deleted.

48 changes: 0 additions & 48 deletions docs/setup/groups/index.mdx

This file was deleted.

4 changes: 2 additions & 2 deletions docs/setup/policies/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ This document will guide you through the process of creating and using a Policy
<!---
## Policy in a nutshell

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

## Configuring a Policy
Expand Down
8 changes: 4 additions & 4 deletions docs/welcome/getting-started/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -73,16 +73,16 @@ Use the following command to authenticate with your Exlint account:
exlint auth
```

### 2. Run an Exlint Group scan on your repository
### 2. Run an Exlint Compliance scan on your repository

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

```bash
exlint use <group_id>
exlint use <compliance_id>
```

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

```bash
exlint run [options]
Expand Down
8 changes: 4 additions & 4 deletions docs/welcome/how-exlint-works/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ import styles from './styles.module.css';
# How Exlint works

Exlint is an open-source tool that helps in maintaining code quality and compliance by centralizing and streamlining coding standards.
It works by running a set of open-source linters as a group on your codebase, and identifying any issues or violations of the specified rules.
It works by running a set of open-source linters as a compliance on your codebase, and identifying any issues or violations of the specified rules.

When you run Exlint, it will automatically adjust your IDE and install any necessary extensions and libraries.
This allows you to see the results of the linter checks directly in your code editor, including live-linting.

Exlint also provides a web-based dashboard app that allows you to view and manage your Exlint Groups, including adding and removing policies, and managing their configurations and rules.
Exlint also provides a web-based dashboard app that allows you to view and manage your Exlint Compliances, including adding and removing policies, and managing their configurations and rules.
With Exlint, you can easily centralize your compliance efforts and maintain a stardartized code quality across projects.

## What does Exlint analyze?
Expand All @@ -32,15 +32,15 @@ The types of issues that Exlint can analyze include:
- Performance issues
- Unused or deprecated code

The policies which you are using in an Exlint Group will specify what type of analysis it can perform and what type of error it can detect.
The policies which you are using in an Exlint Compliance will specify what type of analysis it can perform and what type of error it can detect.

:::info
Since Exlint is in beta, we only support a limited number of policies ([supported libraries](/supported-libraries)), but we're incrementally adding support for more policies and languages.
:::

## Where does the analysis occur?

Exlint's group run process is entirely local using our open-source CLI.
Exlint's compliance run process is entirely local using our open-source CLI.
Your files and their contents are not sent to our backend, as the CLI performs the run on your machine.
Only metadata is sent to our backend, which will be used to display your run history on your dashboard.

Expand Down
8 changes: 7 additions & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ const config = {
position: 'right',
label: 'Sign up | Login',
},
{
'href': 'https://github.com/Exlint/cli',
'position': 'right',
'className': 'header-github-link',
'aria-label': 'GitHub repository',
},
],
},
footer: {
Expand Down Expand Up @@ -78,7 +84,7 @@ const config = {
},
{
label: 'Setup',
href: '/setup/groups',
href: '/setup/compliances',
},
{
label: 'CI',
Expand Down
Loading