Skip to content

Commit e612456

Browse files
authored
Deps upgrade, general cleanup (#78)
* chore(deps): update deps, remove tslint * [cleanup] format code, remove react-axe * [cleanup] update readme * [rebase] update readme to reflect new startup scripts * [cleanup] add back axe dep
1 parent 45c7878 commit e612456

File tree

11 files changed

+21234
-14192
lines changed

11 files changed

+21234
-14192
lines changed

.eslintrc

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,30 @@
1212
},
1313
// we want to use the recommended rules provided from the typescript plugin
1414
"extends": [
15-
"plugin:@typescript-eslint/recommended",
16-
"plugin:patternfly-react/recommended"
15+
"eslint:recommended",
16+
"plugin:react/recommended",
17+
"plugin:@typescript-eslint/recommended"
1718
],
19+
"globals": {
20+
"window": "readonly",
21+
"describe": "readonly",
22+
"test": "readonly",
23+
"expect": "readonly",
24+
"it": "readonly",
25+
"process": "readonly",
26+
"document": "readonly"
27+
},
28+
"settings": {
29+
"react": {
30+
"version": "^16.11.0"
31+
}
32+
},
1833
// includes the typescript specific rules found here: https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin#supported-rules
19-
"plugins": ["@typescript-eslint", "react-hooks", "eslint-plugin-react-hooks"],
34+
"plugins": [
35+
"@typescript-eslint",
36+
"react-hooks",
37+
"eslint-plugin-react-hooks"
38+
],
2039
"rules": {
2140
"@typescript-eslint/explicit-function-return-type": "off",
2241
"react-hooks/rules-of-hooks": "error",

README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,35 +8,36 @@ Out of the box you'll get an app layout with chrome (header/sidebar), routing, b
88

99
## Quick-start
1010
```bash
11-
npm install yarn -g # ensure you have yarn on your machine globally
1211
git clone https://github.com/patternfly/patternfly-react-seed # clone the project
1312
cd patternfly-react-seed # navigate into the project directory
14-
yarn # install patternfly-react-seed dependencies
15-
yarn build # build the project
16-
yarn start # start the development server
13+
npm install # install patternfly-react-seed dependencies
14+
npm run start # start the development server
1715
```
1816
## Development Scripts
1917

2018
Install development/build dependencies
21-
`yarn`
19+
`npm install`
2220

2321
Start the development server
24-
`yarn start`
22+
`npm run start:dev`
2523

2624
Run a production build
27-
`yarn build`
25+
`npm run build`
2826

2927
Run the test suite
30-
`yarn test`
28+
`npm run test`
3129

3230
Run the linter
33-
`yarn lint`
31+
`npm run lint`
3432

3533
Run the code formatter
36-
`yarn format`
34+
`npm run format`
3735

3836
Launch a tool to inspect the bundle size
39-
`yarn bundle-profile:analyze`
37+
`npm run bundle-profile:analyze`
38+
39+
Start the express server (run a production build first)
40+
`npm run start`
4041

4142
## Configurations
4243
* [TypeScript Config](./tsconfig.json)
@@ -82,6 +83,3 @@ body {
8283
* To keep our code formatting in check, we use [prettier](https://github.com/prettier/prettier)
8384
* To keep our code logic and test coverage in check, we use [jest](https://github.com/facebook/jest)
8485
* To ensure code styles remain consistent, we use [eslint](https://eslint.org/)
85-
86-
### Linter Supper
87-
Currently, eslint and tslint are both supported. This is temporary. We will be removing support for tslint at some point in the near future, given tslint's roadmap to deprecate itself in favor of a more unified developer experience across TypeScript and JavaScript languages.

0 commit comments

Comments
 (0)