search

hardeep / tslint-plugin-jest

TSLint Plugin for Jest
1 stars 0 forks source link

Install issues #1

Open fjcaetano opened 5 years ago

fjcaetano commented 5 years ago

Hi @hardeep, first of all, thanks for this repo. I was needing something like this and what you provided is really helpful. I had some issue installing it so here are a few suggestions on how to better enable this:

  1. The name of the repo is different than the name of the package:

    I first tried installing this as tslint-plugin-jest, but that failed because there's no package with that name. In fact, your package.json names the project as tslint-jest-rules. That should to be normalized to avoid confusion.

  2. There are no instructions on how to install.

    On the same note, these install issues could be prevented by adding a "how to install" section to the README, which is always good.

  3. Unnecessary requirement of tslint-config-prettier

    Your tslint.json declares that this project extends tslint-config-prettier. I believe you may be using it only for development, right? Then it shouldn't be in the exported tslint.json. If by any chance you decide this is a necessary requirement, please move tslint-config-prettier from "devDependencies" to "dependencies" in your package.json.

fjcaetano commented 5 years ago

Let me know if you need any help with this.