-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
215233c
commit d3a63d9
Showing
3 changed files
with
76 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
Copyright (c) 2021 and onwards Nimble. | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,63 @@ | ||
# `@nimblehq/eslint-config-nimble-typescript` | ||
|
||
> TODO: description | ||
This package provides ESLint typescript rules inheriting from @nimblehq/eslint-config-nimble-core. | ||
|
||
## Installation | ||
|
||
```bash | ||
npm install --save-dev @nimblehq/eslint-config-nimble-typescript | ||
``` | ||
|
||
## Usage | ||
|
||
### Standalone | ||
|
||
Add `@nimblehq/eslint-config-nimble-typescript` to the extends section of your `.eslintrc` configuration file. | ||
|
||
```js | ||
{ | ||
"extends": [ | ||
"@nimblehq/eslint-config-nimble-typescript" | ||
], | ||
"rules": { | ||
// Additional, per-project rules... | ||
} | ||
} | ||
``` | ||
const eslintConfigNimbleTypescript = require('@nimblehq/eslint-config-nimble-typescript'); | ||
|
||
// TODO: DEMONSTRATE API | ||
### With a framework | ||
|
||
Similar to the process above, but usually it requires adding the extra rules for the JS framework: | ||
|
||
```js | ||
{ | ||
"extends": [ | ||
"@nimblehq/eslint-config-nimble-testing", | ||
"plugin:react/recommended", | ||
"plugin:vue/recommended" | ||
], | ||
"rules": { | ||
// Additional, per-project rules... | ||
} | ||
} | ||
``` | ||
|
||
This would require defining the required dependencies in the project itself. | ||
|
||
## License | ||
|
||
This project is Copyright (c) 2021 and onwards Nimble. It is free software and may be redistributed under the terms specified in the [LICENSE] file. | ||
|
||
[LICENSE]: /LICENSE | ||
|
||
## About | ||
|
||
![Nimble](https://assets.nimblehq.co/logo/dark/logo-dark-text-160.png) | ||
|
||
This project is maintained and funded by [Nimble](https://nimblehq.co). | ||
|
||
We love open source and do our part in sharing our work with the community! | ||
See [our other projects][community] or [hire our team][hire] to help build your product. | ||
|
||
[community]: https://github.com/nimblehq | ||
[hire]: https://nimblehq.co/ |