Skip to content

Commit

Permalink
Merge pull request #23 from josh-stillman/js/update-readme
Browse files Browse the repository at this point in the history
update readme for 3.0.1
  • Loading branch information
josh-stillman authored Sep 30, 2024
2 parents f34e66a + be2b446 commit 72fd51a
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@

![](https://github.com/josh-stillman/lintier/blob/main/lintier.gif?raw=true)

Lintier works in React, Node, and other Typescript projects. It provides options to install [stylelint](https://stylelint.io/) for linting & formatting css, and [lint-staged](https://github.com/okonet/lint-staged#readme) for linting pre-commit. Lintier will install the dependencies, create the config files, and add scripts to your `package.json` file.
Lintier works in React, Node, and other Typescript projects. It lets you install [stylelint](https://stylelint.io/) for linting & formatting css, and [lint-staged](https://github.com/okonet/lint-staged#readme) for linting pre-commit. Lintier will install the dependencies, create the config files, and add scripts to your `package.json` file.

Lintier's goal is to provide a minimal foundation, allowing you to further customize the setup to fit your project's needs.
Lintier's goal is to provide a minimal foundation, letting you further customize the setup to fit your project's needs.

## Update for ESLint 9

Expand All @@ -34,8 +34,8 @@ Alternately, you can specify any of these options to skip the interactive prompt

## Troubleshooting and Pinned Versions

By default, lintier installs the latest version of the various dependencies, which means that breaking changes in those dependencies can break lintier. A weekly automated end-to-end test helps catch these changes.
By default, lintier installs the latest dependency versions, which means that breaking changes in those dependencies can break lintier. A weekly automated end-to-end test helps catch these changes.

If the latest versions aren't working, you can fall back to known working dependency versions by passing the `-p` flag when starting lintier. (Interactive mode will still start if this is the only flag passed).
If the latest dependency versions aren't working, you can fall back to the last-known working versions by passing the `-p` flag. (Interactive mode still starts if this is the only flag passed). The [list](./src/installDependencies/pinnedVersions.json) of known working versions is updated after each successful weekly test run.

If you spot trouble, please open an issue in the GitHub repo.

0 comments on commit 72fd51a

Please sign in to comment.