Skip to content

Commit

Permalink
Update README (#2)
Browse files Browse the repository at this point in the history
* update package details and readme

modify readme

rm .github folder

* minor change

* minor change

* minor change

minor change

add jsx-a11y and link scripts

* resolve merge conflict"

* updates

* readme changes

* update readme docs

* updated pkg name and readme

* add tests folder

* minor changes

* add object curly newline rule

* rm ts and stylistic plugins

* add json file

* rm json plugins

* add .eslintrc config

* modify -> function-paren-newline

* update readme

* rules config wip

* final docs done

* update README

* rm @typescript-eslint/no-this-alias

* update

* 1.0.1

* update readme

* update docs

* v 1.0.2
  • Loading branch information
nishkohli96 authored Jan 23, 2024
1 parent 053d93a commit 6eabbe0
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
strategy:
matrix:
node-version: [20.x]
os: [ubuntu-latest, windows-latest, macos-latest]
os: [ubuntu-latest]
steps:
- uses: actions/checkout@v4
- name: Use Node.js ${{ matrix.node-version }}
Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ This config extends the following plugins -
- [eslint/recommended](https://eslint.org/docs/latest/rules/)
- [eslint-plugin-react](https://www.npmjs.com/package/eslint-plugin-react)
- [eslint-plugin-react-hooks](https://www.npmjs.com/package/eslint-plugin-react-hooks)
- [eslint-plugin-jsx-a11y](https://www.npmjs.com/package/eslint-plugin-jsx-a11y)
- [eslint-plugin-jsx-a11y](https://www.npmjs.com/package/eslint-plugin-jsx-a11y)
- [@stylistic](https://eslint.style/)

## Installation

Expand Down Expand Up @@ -97,14 +98,14 @@ Some folders have already been preconfigured to ignore when linting.

View the complete list of rules
- [eslint](https://eslint.org/docs/latest/rules/)
- [stylistic](https://eslint.style/rules/default)
- [stylistic](https://eslint.style/rules)
- [typescript](https://typescript-eslint.io/rules/)
- [react](https://github.com/jsx-eslint/eslint-plugin-react/tree/master/docs/rules)
- [jsx-a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/main/docs/rules)

⚠️ ***WARNING*** - avoid using this style of code.
***ERROR*** - your code is 🗑️
🔧 ***FLEXIBLE*** - make eslint less strict and more developer-friendly.
🔧 ***FLEXIBLE*** - specified or overwritten default cases for rules.

## **stylistic rules**

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@nish1896/eslint-config",
"version": "1.0.0",
"version": "1.0.2",
"description": "eslint and stylistic rules to help you follow the industry-recommended coding practices.",
"author": "Nishant Kohli",
"scripts": {
Expand All @@ -26,7 +26,7 @@
"main": "./lib/index.js",
"homepage": "https://github.com/nishkohli96/eslint-config#readme",
"repository": {
"url": "https://github.com/nishkohli96/eslint-config"
"url": "git+https://github.com/nishkohli96/eslint-config.git"
},
"dependencies": {
"@stylistic/eslint-plugin": "^1.5.4",
Expand Down

0 comments on commit 6eabbe0

Please sign in to comment.