Skip to content
This repository was archived by the owner on Jul 2, 2024. It is now read-only.
Open
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
82 changes: 45 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,52 @@
# Abide
<h1 align="center">
abide
</h1>

[![Slack Channel](https://img.shields.io/badge/Support_Channel-Slack-purple)](https://slack.com/app_redirect?channel=support-frontend-dx)
[![Maintainer](https://img.shields.io/badge/maintainer-FEDX-silver)](https://wiki.atl.workiva.net/display/FEF/Frontend+Dev+Experience)
[![CI](https://github.com/Workiva/intl_tools/actions/workflows/ci.yaml/badge.svg)](https://github.com/Workiva/intl_tools/actions/workflows/ci.yaml)
[![codecov](https://codecov.io/gh/Workiva/abide/branch/master/graph/badge.svg?token=7S7VXS0TSJ)](https://codecov.io/gh/Workiva/abide)


A command line tool to manage `analysis_options.yaml` and check if it abides by requirements.
This project is meant to be a tool for both local and CI use.

## Installing

### As a dependency
Add it to your pubspec.yaml under dev_dependencies:
```
dev_dependencies:
abide: ^1.6.0
```

This will allow you to `pub run abide` in this project directory. If you want to be
able to run abide on any project without updating project dependencies, use the
global install instructions below. You can install it both ways and run either
the project version or the global version
- `pub run abide` - Runs the local project version
- `pub global run abide` - Runs the globally installed version

### As a global install
1. To install or update to the latest version, run:
```
pub global activate abide
```

2. It is highly recommended to add `~/.pub-cache/bin` to your system PATH to be able to run abide directly.
- Without PATH set: `pub global run abide`
- With PATH set: `abide` (much better)


<hr>
To install a local version, clone it from github and activate it from the current directory.

```
git clone git@github.com:Workiva/abide.git
cd abide
pub global activate --source path .
```

## What does it do?

### Running `abide` will check for these recommendations
Expand Down Expand Up @@ -55,42 +99,6 @@ abide help (shows this help)
without this option, abide will attempt to preserve the state of any commented out rules.
```

## Installing

### As a dependency
Add it to your pubspec.yaml under dev_dependencies:
```
dev_dependencies:
abide: ^1.6.0
```

This will allow you to `pub run abide` in this project directory. If you want to be
able to run abide on any project without updating project dependencies, use the
global install instructions below. You can install it both ways and run either
the project version or the global version
- `pub run abide` - Runs the local project version
- `pub global run abide` - Runs the globally installed version

### As a global install
1. To install or update to the latest version, run:
```
pub global activate abide
```

2. It is highly recommended to add `~/.pub-cache/bin` to your system PATH to be able to run abide directly.
- Without PATH set: `pub global run abide`
- With PATH set: `abide` (much better)


<hr>
To install a local version, clone it from github and activate it from the current directory.

```
git clone git@github.com:Workiva/abide.git
cd abide
pub global activate --source path .
```

## Upgrading the lints in abide.yaml

For abide maintainers, there is an additional tool under `upgrade/` to automatically upgrade
Expand Down