Skip to content

Commit

Permalink
Chore: added react hooks and added np for publishing.
Browse files Browse the repository at this point in the history
Added development and release instructions.

Added hooks eslint rules.
  • Loading branch information
MrHus committed Sep 20, 2019
1 parent ee810e7 commit 534cc48
Show file tree
Hide file tree
Showing 5 changed files with 1,571 additions and 14 deletions.
6 changes: 4 additions & 2 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,16 @@ module.exports = {
'plugin:react/recommended',
'plugin:@typescript-eslint/recommended'
],
plugins: ['@typescript-eslint', 'react'],
plugins: ['@typescript-eslint', 'react', 'react-hooks'],
rules: {
// Place to specify ESLint rules. Can be used to overwrite rules specified from the extended configs
// e.g. "@typescript-eslint/explicit-function-return-type": "off",
indent: 'off',
'@typescript-eslint/indent': ['off', 0],
'@typescript-eslint/no-use-before-define': ['off', 0],
'react/prop-types': [0] // Disable propTypes warning @see https://stackoverflow.com/questions/41746028/proptypes-in-a-typescript-react-application
'react/prop-types': [0], // Disable propTypes warning @see https://stackoverflow.com/questions/41746028/proptypes-in-a-typescript-react-application
"react-hooks/rules-of-hooks": "error",
"react-hooks/exhaustive-deps": "warn"
},
settings: {
react: {
Expand Down
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
language: node_js
node_js: '10'
node_js: '10.16.3'
sudo: false
after_success:
- bash <(curl -s https://codecov.io/bash)
Expand Down
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,23 @@ Storing errors and listening to their changes.
# Documentation

See the [documentation](https://42bv.github.io/react-error-store/).

# Developing

When developing a new feature, make sure you do not update the `package.json`'s
version this will happen whenever a release is made on `master` by
the releasers.

Create a PR to submit your changes to the master branch, the maintainers
will review your work and decide if the feature warrented or if the
bug is vaporized.

# Releasing

Drafting a new release is as simple as running `npm run release`. This command runs (https://github.com/sindresorhus/np)[np] under the hood, which will guide you through the process of drafting a release.

A checklist for after the release:

- [] Make sure a tag is created in GitHub
- [] Make sure the release is created in GitHub.
- [] Make sure the release is on NPM.
Loading

0 comments on commit 534cc48

Please sign in to comment.