Skip to content

Commit

Permalink
Add npx to the running command (#100)
Browse files Browse the repository at this point in the history
  • Loading branch information
illright authored Sep 11, 2024
1 parent 88a83bd commit bef439b
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
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
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

0 comments on commit bef439b

Please sign in to comment.