Merge pull request #2 from Braden1996/feature/readme-improvements

Improve READMEs across packages and simplify repo deps
Braden1996 · Mar 5, 2023 · a7b37b4 · a7b37b4
2 parents 21ba644 + f7d0baa
commit a7b37b4
Show file tree

Hide file tree

Showing 11 changed files with 151 additions and 269 deletions.
diff --git a/package.json b/package.json
@@ -25,12 +25,19 @@
     "lint-fix": "turbo run lint-fix",
     "clean": "turbo run clean",
     "clean-node-modules": "rm -rf **/node_modules",
-    "graph": "turbo run build --graph=graph.pdf"
+    "graph": "turbo run build --graph=graph.pdf",
+    "root:eslint": "cd $INIT_CWD && eslint",
+    "root:rimraf": "cd $INIT_CWD && rimraf",
+    "root:tsc": "cd $INIT_CWD && tsc"
   },
   "devDependencies": {
+    "eslint": "8.32.0",
     "eslint-config-universe": "^11.1.1",
+    "prettier": "^2.8.3",
+    "rimraf": "^4.3.0",
     "syncpack": "^9.3.2",
-    "turbo": "latest"
+    "turbo": "latest",
+    "typescript": "~4.9.4"
   },
   "workspaces": {
     "packages": [

diff --git a/packages/deep-freeze/package.json b/packages/deep-freeze/package.json
@@ -27,26 +27,27 @@
   "scripts": {
     "build": "bob build",
     "test": "yarn run test-typescript",
-    "test-typescript": "tsc --noEmit",
-    "lint": "eslint ./src --ext .ts",
+    "test-typescript": "yarn run root:tsc --noEmit",
+    "lint": "yarn run root:eslint ./src --ext .ts",
     "lint-fix": "yarn run lint --fix",
-    "clean": "rm -rf dist .turbo"
+    "clean": "yarn run root:rimraf dist .turbo"
   },
   "devDependencies": {
     "@braden1996/tsconfig": "^0.0.1",
-    "eslint": "8.32.0",
-    "eslint-config-universe": "^11.1.1",
-    "prettier": "^2.8.3",
-    "react-native-builder-bob": "^0.20.3",
-    "typescript": "~4.9.4"
+    "react-native-builder-bob": "^0.20.3"
   },
   "react-native-builder-bob": {
     "source": "src",
     "output": "dist",
     "targets": [
       "commonjs",
       "module",
-      "typescript"
+      [
+        "typescript",
+        {
+          "tsc": "../../node_modules/.bin/tsc"
+        }
+      ]
     ]
   },
   "eslintConfig": {

diff --git a/packages/example/client-shared/package.json b/packages/example/client-shared/package.json
@@ -8,22 +8,18 @@
   "type": "module",
   "scripts": {
     "test": "yarn run test-typescript",
-    "test-typescript": "tsc --noEmit",
-    "lint": "eslint ./src --ext .js,.ts,.tsx",
+    "test-typescript": "yarn run root:tsc --noEmit",
+    "lint": "yarn run root:eslint ./src --ext .js,.ts,.tsx",
     "lint-fix": "yarn run lint --fix",
-    "clean": "rm -rf .turbo"
+    "clean": "yarn run root:rimraf .turbo"
   },
   "devDependencies": {
-    "@braden1996/tsconfig": "^0.0.1",
-    "eslint": "8.32.0",
-    "eslint-config-universe": "^11.1.1",
-    "prettier": "^2.8.3",
-    "typescript": "~4.9.4"
+    "@braden1996/tsconfig": "^0.0.1"
   },
   "peerDependencies": {
-    "react": "18.2.0",
-    "replicache": "12.2.0",
-    "replicache-react": "^2.10.0"
+    "react": ">=18.2.0",
+    "replicache": ">=12.2.0",
+    "replicache-react": ">=2.10.0"
   },
   "eslintConfig": {
     "extends": "universe"

diff --git a/packages/example/mobile-react-native/package.json b/packages/example/mobile-react-native/package.json
@@ -9,11 +9,11 @@
     "ios": "expo run:ios",
     "prebuild": "expo prebuild",
     "test": "yarn run test-typescript",
-    "test-typescript": "tsc --noEmit",
-    "lint": "eslint ./src/**/*.{ts,tsx}",
+    "test-typescript": "yarn run root:tsc --noEmit",
+    "lint": "yarn run root:eslint ./src/**/*.{ts,tsx}",
     "lint-fix": "yarn run lint --fix",
-    "clean": "rm -rf .turbo .expo ios android",
-    "clean-expo": "rm -rf .expo ios android",
+    "clean": "yarn run root:rimraf .turbo .expo ios android",
+    "clean-expo": "yarn run root:rimraf .expo ios android",
     "clean-cache": "rm -rf $TMPDIR/metro-cache ~/Library/Developer/Xcode/DerivedData/ && watchman watch-del-all",
     "start": "expo start --dev-client"
   },
@@ -44,11 +44,7 @@
     "@types/react": "^18.0.28",
     "@types/react-native": "~0.71.2",
     "@types/react-native__assets": "^1.0.0",
-    "eslint": "8.32.0",
-    "eslint-config-universe": "^11.1.1",
-    "get-yarn-workspaces": "^1.0.2",
-    "prettier": "^2.8.3",
-    "typescript": "~4.9.4"
+    "get-yarn-workspaces": "^1.0.2"
   },
   "eslintConfig": {
     "extends": "universe/native"

diff --git a/packages/example/server/package.json b/packages/example/server/package.json
@@ -27,10 +27,10 @@
     "start": "node -r dotenv/config ./dist/server.js",
     "dev": "NODE_ENV=development nodemon",
     "test": "yarn run test-typescript",
-    "test-typescript": "tsc --noEmit",
-    "lint": "eslint ./src --ext .js,.ts,.tsx",
+    "test-typescript": "yarn run root:tsc --noEmit",
+    "lint": "yarn run root:eslint ./src --ext .js,.ts,.tsx",
     "lint-fix": "yarn run lint --fix",
-    "clean": "rm -rf dist .turbo"
+    "clean": "yarn run root:rimraf dist .turbo"
   },
   "dependencies": {
     "@react-native-replicache/example-shared": "0.0.0",
@@ -45,12 +45,8 @@
     "@types/express": "^4.17.13",
     "@types/node": "^16.11.50",
     "@vercel/ncc": "^0.36.0",
-    "eslint": "8.32.0",
-    "eslint-config-universe": "^11.1.1",
     "nodemon": "^2.0.19",
-    "prettier": "^2.8.3",
-    "ts-node": "^10.9.1",
-    "typescript": "~4.9.4"
+    "ts-node": "^10.9.1"
   },
   "eslintConfig": {
     "extends": "universe/native"

diff --git a/packages/example/shared/package.json b/packages/example/shared/package.json
@@ -8,24 +8,20 @@
   "type": "module",
   "scripts": {
     "test": "yarn run test-typescript",
-    "test-typescript": "tsc --noEmit",
-    "lint": "eslint ./src --ext .js,.ts,.tsx",
+    "test-typescript": "yarn run root:tsc --noEmit",
+    "lint": "yarn run root:eslint ./src --ext .js,.ts,.tsx",
     "lint-fix": "yarn run lint --fix",
-    "clean": "rm -rf dist .turbo"
+    "clean": "yarn run root:rimraf dist .turbo"
   },
   "devDependencies": {
     "@braden1996/tsconfig": "^0.0.1",
     "@types/express": "^4.17.13",
     "@types/node": "^16.11.50",
-    "eslint": "8.32.0",
-    "eslint-config-universe": "^11.1.1",
     "nodemon": "^2.0.19",
-    "prettier": "^2.8.3",
-    "ts-node": "^10.9.1",
-    "typescript": "~4.9.4"
+    "ts-node": "^10.9.1"
   },
   "peerDependencies": {
-    "replicache": "12.2.0"
+    "replicache": ">=12.2.0"
   },
   "eslintConfig": {
     "extends": "universe"

diff --git a/packages/example/web-react/package.json b/packages/example/web-react/package.json
@@ -8,10 +8,10 @@
     "start": "vite start",
     "build": "vite build",
     "test": "yarn run test-typescript",
-    "test-typescript": "tsc --noEmit",
-    "lint": "eslint ./src --ext .js,.ts,.tsx",
+    "test-typescript": "yarn run root:tsc --noEmit",
+    "lint": "yarn run root:eslint ./src --ext .js,.ts,.tsx",
     "lint-fix": "yarn run lint --fix",
-    "clean": "rm -rf dist .turbo"
+    "clean": "yarn run root:rimraf dist .turbo"
   },
   "dependencies": {
     "@react-native-replicache/example-client-shared": "0.0.0",
@@ -26,16 +26,10 @@
   },
   "devDependencies": {
     "@braden1996/tsconfig": "^0.0.1",
-    "@rocicorp/eslint-config": "^0.1.2",
-    "@rocicorp/prettier-config": "^0.1.1",
     "@types/babel__core": "^7.20.0",
     "@types/react": "^18.0.28",
     "@types/react-dom": "^18.0.6",
     "@vitejs/plugin-react": "^2.0.1",
-    "concurrently": "^7.4.0",
-    "eslint": "8.32.0",
-    "eslint-config-universe": "^11.1.1",
-    "prettier": "^2.8.3",
     "typescript": "~4.9.4",
     "vite": "^3.0.7"
   },

diff --git a/packages/react-native-expo-sqlite/package.json b/packages/react-native-expo-sqlite/package.json
@@ -28,34 +28,35 @@
   "scripts": {
     "build": "bob build",
     "test": "yarn run test-typescript",
-    "test-typescript": "tsc --noEmit",
-    "lint": "eslint ./src --ext .js,.ts,.tsx",
+    "test-typescript": "yarn run root:tsc --noEmit",
+    "lint": "yarn run root:eslint ./src --ext .js,.ts,.tsx",
     "lint-fix": "yarn run lint --fix",
-    "clean": "rm -rf dist .turbo"
+    "clean": "yarn run root:rimraf dist .turbo"
   },
   "dependencies": {
     "@react-native-replicache/replicache-generic-sqlite": "1.0.0"
   },
   "devDependencies": {
     "@braden1996/tsconfig": "^0.0.1",
     "@types/react": "^18.0.28",
-    "eslint": "8.32.0",
-    "eslint-config-universe": "^11.1.1",
-    "prettier": "^2.8.3",
-    "react-native-builder-bob": "^0.20.3",
-    "typescript": "~4.9.4"
+    "react-native-builder-bob": "^0.20.3"
   },
   "peerDependencies": {
-    "expo-sqlite": "11.0.0",
-    "react-native": "^0.71.0"
+    "expo-sqlite": ">=11.0.0",
+    "react-native": ">=0.71.0"
   },
   "react-native-builder-bob": {
     "source": "src",
     "output": "dist",
     "targets": [
       "commonjs",
       "module",
-      "typescript"
+      [
+        "typescript",
+        {
+          "tsc": "../../node_modules/.bin/tsc"
+        }
+      ]
     ]
   },
   "eslintConfig": {

diff --git a/packages/react-native-quick-sqlite/package.json b/packages/react-native-quick-sqlite/package.json
@@ -28,33 +28,34 @@
   "scripts": {
     "build": "bob build",
     "test": "yarn run test-typescript",
-    "test-typescript": "tsc --noEmit",
-    "lint": "eslint ./src --ext .js,.ts,.tsx",
+    "test-typescript": "yarn run root:tsc --noEmit",
+    "lint": "yarn run root:eslint ./src --ext .js,.ts,.tsx",
     "lint-fix": "yarn run lint --fix",
-    "clean": "rm -rf dist .turbo"
+    "clean": "yarn run root:rimraf dist .turbo"
   },
   "dependencies": {
     "@react-native-replicache/replicache-generic-sqlite": "1.0.0"
   },
   "devDependencies": {
     "@braden1996/tsconfig": "^0.0.1",
     "@types/react": "^18.0.28",
-    "eslint": "8.32.0",
-    "eslint-config-universe": "^11.1.1",
-    "prettier": "^2.8.3",
-    "react-native-builder-bob": "^0.20.3",
-    "typescript": "~4.9.4"
+    "react-native-builder-bob": "^0.20.3"
   },
   "peerDependencies": {
-    "react-native-quick-sqlite": "8.0.0-beta.2"
+    "react-native-quick-sqlite": ">=8.0.0-beta.2"
   },
   "react-native-builder-bob": {
     "source": "src",
     "output": "dist",
     "targets": [
       "commonjs",
       "module",
-      "typescript"
+      [
+        "typescript",
+        {
+          "tsc": "../../node_modules/.bin/tsc"
+        }
+      ]
     ]
   },
   "eslintConfig": {

diff --git a/packages/replicache-generic-sqlite/package.json b/packages/replicache-generic-sqlite/package.json
@@ -30,33 +30,34 @@
   "scripts": {
     "build": "bob build",
     "test": "yarn run test-typescript",
-    "test-typescript": "tsc --noEmit",
-    "lint": "eslint ./src --ext .ts",
+    "test-typescript": "yarn run root:tsc --noEmit",
+    "lint": "yarn run root:eslint ./src --ext .ts",
     "lint-fix": "yarn run lint --fix",
-    "clean": "rm -rf dist .turbo"
+    "clean": "yarn run root:rimraf dist .turbo"
   },
   "dependencies": {
     "@react-native-replicache/deep-freeze": "1.0.0"
   },
   "devDependencies": {
     "@braden1996/tsconfig": "^0.0.1",
-    "eslint": "8.32.0",
-    "eslint-config-universe": "^11.1.1",
-    "prettier": "^2.8.3",
     "react-native-builder-bob": "^0.20.3",
-    "replicache": "12.2.0",
-    "typescript": "~4.9.4"
+    "replicache": "12.2.0"
   },
   "peerDependencies": {
-    "replicache": "12.2.0"
+    "replicache": ">=12.2.0"
   },
   "react-native-builder-bob": {
     "source": "src",
     "output": "dist",
     "targets": [
       "commonjs",
       "module",
-      "typescript"
+      [
+        "typescript",
+        {
+          "tsc": "../../node_modules/.bin/tsc"
+        }
+      ]
     ]
   },
   "eslintConfig": {