chore(ci): filter out examples (#4239)

* filter out examples * typo * update docs and gitignore to account for pnpm switch
TanStack · Sep 28, 2022 · d9478e0 · d9478e0
1 parent 6c06966
commit d9478e0
Show file tree

Hide file tree

Showing 31 changed files with 50 additions and 16 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -26,7 +26,7 @@ jobs:
           node-version: 16.14.2
           registry-url: https://registry.npmjs.org/
       - run: |
-          pnpm install
+          pnpm --filter ./packages/** --filter query install
           git config --global user.name 'Tanner Linsley'
           git config --global user.email '[email protected]'
           pnpm run cipublish

diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -18,7 +18,7 @@ jobs:
           node-version: ${{ matrix.node }}
           cache: 'pnpm'
       - name: Install dependencies
-        run: pnpm install
+        run: pnpm --filter "./packages/**" --filter query install
       - run: |
           pnpm run test:ci
           pnpm run test:size

diff --git a/.gitignore b/.gitignore
@@ -3,6 +3,8 @@
 
 # dependencies
 node_modules
+package-lock.json
+yarn.lock
 
 # builds
 types

diff --git a/docs/community/liaoliao666-react-query-kit.md b/docs/community/liaoliao666-react-query-kit.md
@@ -21,6 +21,8 @@ should be installed as one of your project's `dependencies`:
 ```bash
 $ npm i react-query-kit
 # or
+$ pnpm add react-query-kit
+# or
 $ yarn add react-query-kit
 ```
 
@@ -74,4 +76,4 @@ export async function getStaticProps() {
 }
 ```
 
-Check the complete documentation on [GitHub](https://github.com/liaoliao666/react-query-kit).
+Check the complete documentation on [GitHub](https://github.com/liaoliao666/react-query-kit).
diff --git a/docs/community/lukemorales-query-key-factory.md b/docs/community/lukemorales-query-key-factory.md
@@ -12,6 +12,8 @@ You can install Query Key Factory via [NPM](https://www.npmjs.com/package/@lukem
 ```bash
 $ npm i @lukemorales/query-key-factory
 # or
+$ pnpm add @lukemorales/query-key-factory
+# or
 $ yarn add @lukemorales/query-key-factory
 ```
 

diff --git a/docs/devtools.md b/docs/devtools.md
@@ -16,6 +16,8 @@ The devtools are a separate package that you need to install:
 ```bash
 $ npm i @tanstack/react-query-devtools
 # or
+$ pnpm add @tanstack/react-query-devtools
+# or
 $ yarn add @tanstack/react-query-devtools
 ```
 

diff --git a/docs/installation.md b/docs/installation.md
@@ -12,6 +12,8 @@ or a good ol' `<script>` via
 ```bash
 $ npm i @tanstack/react-query
 # or
+$ pnpm add @tanstack/react-query
+# or
 $ yarn add @tanstack/react-query
 ```
 

diff --git a/docs/plugins/createAsyncStoragePersister.md b/docs/plugins/createAsyncStoragePersister.md
@@ -11,6 +11,10 @@ npm install @tanstack/query-async-storage-persister @tanstack/react-query-persis
 ```
 or
 ```bash
+pnpm add @tanstack/query-async-storage-persister @tanstack/react-query-persist-client
+```
+or
+```bash
 yarn add @tanstack/query-async-storage-persister @tanstack/react-query-persist-client
 ```
 

diff --git a/docs/plugins/createSyncStoragePersister.md b/docs/plugins/createSyncStoragePersister.md
@@ -11,6 +11,10 @@ npm install @tanstack/query-sync-storage-persister @tanstack/react-query-persist
 ```
 or
 ```bash
+pnpm add @tanstack/query-sync-storage-persister @tanstack/react-query-persist-client
+```
+or
+```bash
 yarn add @tanstack/query-sync-storage-persister @tanstack/react-query-persist-client
 ```
 

diff --git a/examples/react/auto-refetching/.gitignore b/examples/react/auto-refetching/.gitignore
@@ -11,6 +11,7 @@
 # production
 /build
 
+pnpm-lock.yaml
 yarn.lock
 package-lock.json
 

diff --git a/examples/react/basic-graphql-request/.gitignore b/examples/react/basic-graphql-request/.gitignore
@@ -11,6 +11,7 @@
 # production
 /build
 
+pnpm-lock.yaml
 yarn.lock
 package-lock.json
 

diff --git a/examples/react/basic-typescript/.gitignore b/examples/react/basic-typescript/.gitignore
@@ -11,6 +11,7 @@
 # production
 /build
 
+pnpm-lock.yaml
 yarn.lock
 package-lock.json
 

diff --git a/examples/react/basic-typescript/public/index.html b/examples/react/basic-typescript/public/index.html
@@ -31,8 +31,8 @@
       You can add webfonts, meta tags, or analytics to this file.
       The build step will place the bundled scripts into the <body> tag.
 
-      To begin the development, run `npm start` or `yarn start`.
-      To create a production bundle, use `npm run build` or `yarn build`.
+      To begin the development, run `npm start`, `pnpm start` or `yarn start`.
+      To create a production bundle, use `npm run build`, `pnpm buld` or `yarn build`.
     -->
   </body>
 </html>
diff --git a/examples/react/basic/.gitignore b/examples/react/basic/.gitignore
@@ -11,6 +11,7 @@
 # production
 /build
 
+pnpm-lock.yaml
 yarn.lock
 package-lock.json
 

diff --git a/examples/react/default-query-function/.gitignore b/examples/react/default-query-function/.gitignore
@@ -11,6 +11,7 @@
 # production
 /build
 
+pnpm-lock.yaml
 yarn.lock
 package-lock.json
 

diff --git a/examples/react/load-more-infinite-scroll/.gitignore b/examples/react/load-more-infinite-scroll/.gitignore
@@ -11,6 +11,7 @@
 # production
 /build
 
+pnpm-lock.yaml
 yarn.lock
 package-lock.json
 

diff --git a/examples/react/offline/.gitignore b/examples/react/offline/.gitignore
@@ -11,6 +11,7 @@
 # production
 /build
 
+pnpm-lock.yaml
 yarn.lock
 package-lock.json
 

diff --git a/examples/react/optimistic-updates-typescript/.gitignore b/examples/react/optimistic-updates-typescript/.gitignore
@@ -11,6 +11,7 @@
 # production
 /build
 
+pnpm-lock.yaml
 yarn.lock
 package-lock.json
 

diff --git a/examples/react/pagination/.gitignore b/examples/react/pagination/.gitignore
@@ -11,6 +11,7 @@
 # production
 /build
 
+pnpm-lock.yaml
 yarn.lock
 package-lock.json
 

diff --git a/examples/react/playground/.gitignore b/examples/react/playground/.gitignore
@@ -11,6 +11,7 @@
 # production
 /build
 
+pnpm-lock.yaml
 yarn.lock
 package-lock.json
 

diff --git a/examples/react/prefetching/.gitignore b/examples/react/prefetching/.gitignore
@@ -11,6 +11,7 @@
 # production
 /build
 
+pnpm-lock.yaml
 yarn.lock
 package-lock.json
 

diff --git a/examples/react/react-native/README.md b/examples/react/react-native/README.md
@@ -3,5 +3,5 @@
 To run this example:
 
 - Install expo CLI if needed `npm install --global expo-cli`
-- `yarn`
-- `yarn start`
+- `pnpm install`
+- `pnpm start`
diff --git a/examples/react/react-native/package.json b/examples/react/react-native/package.json
@@ -9,12 +9,12 @@
     "web": "expo start --web",
     "eject": "expo eject",
     "lint:check": "eslint --ext '.js,.ts,.tsx' .",
-    "lint:fix": "yarn lint --fix",
+    "lint:fix": "pnpm lint --fix",
     "type:check": "tsc --noEmit",
     "prettier": "prettier \"{.,src,src/**}/*.{md,js,jsx,ts,tsx,json}\"",
-    "prettier:check": "yarn prettier -c",
-    "prettier:fix": "yarn prettier -w",
-    "dev:check": "yarn prettier:check & yarn lint:check & yarn type:check"
+    "prettier:check": "pnpm prettier -c",
+    "prettier:fix": "pnpm prettier -w",
+    "dev:check": "pnpm prettier:check & pnpm lint:check & pnpm type:check"
   },
   "dependencies": {
     "@react-navigation/stack": "^6.0.2",

diff --git a/examples/react/react-router/.gitignore b/examples/react/react-router/.gitignore
@@ -11,6 +11,7 @@
 # production
 /build
 
+pnpm-lock.yaml
 yarn.lock
 package-lock.json
 

diff --git a/examples/react/rick-morty/.gitignore b/examples/react/rick-morty/.gitignore
@@ -11,6 +11,7 @@
 # production
 /build
 
+pnpm-lock.yaml
 yarn.lock
 package-lock.json
 

diff --git a/examples/react/simple/.gitignore b/examples/react/simple/.gitignore
@@ -11,6 +11,7 @@
 # production
 /build
 
+pnpm-lock.yaml
 yarn.lock
 package-lock.json
 

diff --git a/examples/react/star-wars/.gitignore b/examples/react/star-wars/.gitignore
@@ -11,6 +11,7 @@
 # production
 /build
 
+pnpm-lock.yaml
 yarn.lock
 package-lock.json
 

diff --git a/examples/react/suspense/.gitignore b/examples/react/suspense/.gitignore
@@ -11,6 +11,7 @@
 # production
 /build
 
+pnpm-lock.yaml
 yarn.lock
 package-lock.json
 

diff --git a/examples/react/suspense/README.md b/examples/react/suspense/README.md
@@ -2,5 +2,5 @@
 
 To run this example:
 
-- `npm install` or `yarn`
-- `npm run dev` or `yarn run dev`
+- `pnpm install`
+- `pnpm dev`
diff --git a/packages/react-query/package.json b/packages/react-query/package.json
@@ -28,8 +28,8 @@
     "clean": "rm -rf ./build",
     "test:codemods": "../../node_modules/.bin/jest --config codemods/jest.config.js",
     "test:eslint": "../../node_modules/.bin/eslint --ext .ts,.tsx ./src",
-    "test:jest": "yarn test:codemods && ../../node_modules/.bin/jest --config jest.config.js",
-    "test:jest:dev": "yarn test:jest --watch"
+    "test:jest": "pnpm test:codemods && ../../node_modules/.bin/jest --config jest.config.js",
+    "test:jest:dev": "pnpm test:jest --watch"
   },
   "files": [
     "build/lib/*",

diff --git a/packages/solid-query/package.json b/packages/solid-query/package.json
@@ -30,7 +30,7 @@
     "clean": "rm -rf ./build",
     "test:eslint": "../../node_modules/.bin/eslint --ext .ts,.tsx ./src",
     "test:jest": "../../node_modules/.bin/jest --config jest.config.js",
-    "test:jest:dev": "yarn test:jest --watch"
+    "test:jest:dev": "pnpm test:jest --watch"
   },
   "files": [
     "build/lib/*",
-Original file line number
+Diff line change
@@ Expand Up @@
     ```bash
     $ npm i @lukemorales/query-key-factory
     # or
+    $ pnpm add @lukemorales/query-key-factory
+    # or
     $ yarn add @lukemorales/query-key-factory
     ```
@@ Expand Down @@