Skip to content

Commit

Permalink
chore: updated license and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Petr Konecny committed Nov 15, 2023
1 parent 4286c2f commit 4cad108
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 33 deletions.
3 changes: 2 additions & 1 deletion packages/eslint-config-react-native/LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
BSD 3-Clause License

Copyright (c) 2019, STRV
Copyright (c) 2016-present Expo
Copyright (c) 2023-present, STRV
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
4 changes: 2 additions & 2 deletions packages/eslint-config-react-native/index.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/**
* strvcom/eslint-config-react-native
*
* @author André Nanninga <andre.nanninga@strv.com>
* @copyright 2019 STRV
* @author Petr Konecny <petr.konecny@strv.com>
* @copyright 2016-present Expo, 2023-present STRV
* @license http://choosealicense.com/licenses/bsd-3-clause BSD-3-Clause License
*/

Expand Down
31 changes: 1 addition & 30 deletions packages/eslint-config-react-native/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,43 +2,14 @@

> STRV's ESLint config for React-Native projects
Suitable for linting React Native source files. This ruleset extends `@strv/eslint-config-react`.

This rulest includes accessibility rules, based on [eslint-plugin-react-native-a11y][a11y-repo].
Suitable for linting React Native source files. This ruleset extends [`eslint-config-universe`](https://github.com/expo/expo/tree/master/packages/eslint-config-universe).

## Configurations

### `@strv/eslint-config-react-native`

Suitable for linting React Native projects.

### `@strv/eslint-config-react-native/optional`

Use this ruleset in conjunction with the above base ruleset. Provides additional insights into potential inconsistencies in the project. Extends `@strv/eslint-config-react/optional`.

> For new projects, it is recommended to enable this ruleset. For existing projects, it is only recommended for the brave.
## Coding styles

### `@strv/eslint-config-react-native/style`

This ruleset includes rules which deal with how the code looks like and not how it works. It helps keeping the code clean and consistent. Extends `@strv/eslint-config-react/style`. 🎨

A full configuration for a React Native project:

```js
// .eslintrc.js
'use strict'

module.exports = {
extends: [
'@strv/react-native',
'@strv/react-native/optional',
'@strv/react-native/style',
],
}
```

## License

See the [LICENSE](LICENSE) file for information.
Expand Down

0 comments on commit 4cad108

Please sign in to comment.