add eslint + prettier configs; update README

This commit is contained in:
David Westgate 2025-02-07 20:27:03 -08:00
parent c7d8135829
commit 1f0104652a
6 changed files with 2216 additions and 10 deletions

31
.eslintrc.json Normal file
View File

@ -0,0 +1,31 @@
{
"extends": [
"eslint:recommended",
"plugin:react/recommended",
"plugin:react-native/all",
"plugin:prettier/recommended"
],
"parserOptions": {
"ecmaVersion": 2020,
"sourceType": "module"
},
"env": {
"es6": true,
"node": true,
"browser": true
},
"plugins": [
"react",
"react-native",
"prettier"
],
"rules": {
"prettier/prettier": "error",
"react/prop-types": "off"
},
"settings": {
"react": {
"version": "detect"
}
}
}

7
.prettierrc Normal file
View File

@ -0,0 +1,7 @@
{
"singleQuote": false,
"trailingComma": "es5",
"arrowParens": "always",
"semi": true,
"printWidth": 80
}

8
.vscode/settings.json vendored Normal file
View File

@ -0,0 +1,8 @@
{
"editor.formatOnSave": true,
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit",
"source.fixAll.ts": "explicit"
}
}

View File

@ -1,18 +1,25 @@
# Poker Chips Helper # Poker Chips Helper
A mobile application to assist a poker host with determining the denominations and distributions of poker chips. A mobile application to assist a poker host with determining the denominations and distributions of poker chips.
This applications uses the React Native + Expo framework and by extension is primarily implemented in typescript. These frameworks were chosen for their solid reputation, and ability to easily compile to both major platforms (iOS + Android) with a single code base. Typescript is the default language for new projects with these frameworks, but is also preferred over the javascript alternative as strong typings are very helpful to the developer experience. This applications uses the React Native + Expo framework and by extension is primarily implemented in typescript. These frameworks were chosen for their solid reputation, and ability to easily compile to both major platforms (iOS + Android) with a single code base. Typescript is the default language for new projects with these frameworks, but is also preferred over the javascript alternative as strong typings are very helpful to the developer experience.
## Team Members ## Team Members
* David Westgate
* Lakshmi Vyshnavi Vutukuri - David Westgate
* Mantasha Noyela - Lakshmi Vyshnavi Vutukuri
- Mantasha Noyela
## Building, Running, and Developer Resources ## Building, Running, and Developer Resources
This is an [Expo](https://expo.dev) project created with [`create-expo-app`](https://www.npmjs.com/package/create-expo-app). This is an [Expo](https://expo.dev) project created with [`create-expo-app`](https://www.npmjs.com/package/create-expo-app).
## Get started ### VSCode plugins
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
### Get started
1. Install dependencies 1. Install dependencies
@ -35,7 +42,7 @@ In the output, you'll find options to open the app in a
You can start developing by editing the files inside the **app** directory. This project uses [file-based routing](https://docs.expo.dev/router/introduction). You can start developing by editing the files inside the **app** directory. This project uses [file-based routing](https://docs.expo.dev/router/introduction).
## Learn more ### Learn more
To learn more about developing your project with Expo, look at the following resources: To learn more about developing your project with Expo, look at the following resources:

2155
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -45,8 +45,14 @@
"@types/jest": "^29.5.12", "@types/jest": "^29.5.12",
"@types/react": "~18.3.12", "@types/react": "~18.3.12",
"@types/react-test-renderer": "^18.3.0", "@types/react-test-renderer": "^18.3.0",
"eslint": "^9.20.0",
"eslint-config-prettier": "^10.0.1",
"eslint-plugin-prettier": "^5.2.3",
"eslint-plugin-react": "^7.37.4",
"eslint-plugin-react-native": "^5.0.0",
"jest": "^29.2.1", "jest": "^29.2.1",
"jest-expo": "~52.0.3", "jest-expo": "~52.0.3",
"prettier": "^3.4.2",
"react-test-renderer": "18.3.1", "react-test-renderer": "18.3.1",
"typescript": "^5.3.3" "typescript": "^5.3.3"
}, },