Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add npx to the running command #100

Merged
merged 1 commit into from
Sep 11, 2024
Merged

Add npx to the running command #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ npm i -D steiger
# Usage

```bash
steiger ./src
npx steiger ./src
```

To run in watch mode, add `-w`/`--watch` to the command:

```bash
steiger ./src --watch
npx steiger ./src --watch
```

# Configuration
Expand Down
8 changes: 5 additions & 3 deletions packages/steiger/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,25 +22,27 @@ npm i -D steiger
# Usage

```bash
steiger ./src
npx steiger ./src
```

To run in watch mode, add `-w`/`--watch` to the command:

```bash
steiger ./src --watch
npx steiger ./src --watch
```

# Configuration

Steiger is zero-config! If you don't want to disable certain rules, you can safely skip this section.

Steiger is configurable via `cosmiconfig`. That means that you can create a `steiger.config.ts` or `steiger.config.js` file in the root of your project to configure the rules. Import `{ defineConfig } from "steiger"` to get autocompletion.

```ts
import { defineConfig } from 'steiger'

export default defineConfig({
rules: {
'no-public-api': 'off',
'public-api': 'off',
},
})
```
Expand Down