Version 0.6.0

.codesandbox/ci.json

@@ -1,5 +1,5 @@
 {
   "buildCommand": "compile",
   "sandboxes": ["new", "react-typescript-react-ts"],
-  "node": "14"
+  "node": "18"
 }

.eslintrc.cjs

@@ -0,0 +1,39 @@
+/* eslint-env node */
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint'],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:import/recommended',
+    'plugin:import/typescript',
+    'plugin:react/recommended',
+    'plugin:react/jsx-runtime',
+    'plugin:react-hooks/recommended',
+    'plugin:jsx-a11y/recommended',
+    'prettier',
+  ],
+  ignorePatterns: ['dist/'],
+  settings: {
+    'import/resolver': {
+      typescript: true,
+    },
+    react: { version: 'detect' },
+  },
+  rules: {
+    'import/no-unresolved': ['error', { ignore: ['jotai-relay'] }],
+    '@typescript-eslint/no-unused-vars': [
+      'error',
+      {
+        args: 'all',
+        argsIgnorePattern: '^_',
+        caughtErrors: 'all',
+        caughtErrorsIgnorePattern: '^_',
+        destructuredArrayIgnorePattern: '^_',
+        varsIgnorePattern: '^_',
+        ignoreRestSiblings: true,
+      },
+    ],
+  },
+};

.github/workflows/cd.yml

@@ -9,36 +9,19 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-
-      - name: Setup Node
-        uses: actions/setup-node@v1
+      - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
         with:
-          node-version: '14.x'
-          registry-url: 'https://registry.npmjs.org'
-
-      - name: Get yarn cache
-        id: yarn-cache
-        run: echo "::set-output name=dir::$(yarn cache dir)"
-
-      - name: Cache dependencies
-        uses: actions/cache@v1
+          version: 8.2.0
+      - uses: actions/setup-node@v3
         with:
-          path: ${{ steps.yarn-cache.outputs.dir }}
-          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-yarn-
-
-      - name: Install dependencies
-        run: yarn install
-
-      - name: Test
-        run: yarn test
-
-      - name: Compile
-        run: yarn run compile
-
-      - name: Publish
-        run: npm publish
+          node-version: 18
+          registry-url: 'https://registry.npmjs.org'
+          cache: 'pnpm'
+          cache-dependency-path: '**/pnpm-lock.yaml'
+      - run: pnpm install --frozen-lockfile
+      - run: npm test
+      - run: npm run compile
+      - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/ci.yml

@@ -8,27 +8,14 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-
-      - name: Setup Node
-        uses: actions/setup-node@v1
+      - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
         with:
-          node-version: '14.x'
-
-      - name: Get yarn cache
-        id: yarn-cache
-        run: echo "::set-output name=dir::$(yarn cache dir)"
-
-      - name: Cache dependencies
-        uses: actions/cache@v1
+          version: 8.2.0
+      - uses: actions/setup-node@v3
         with:
-          path: ${{ steps.yarn-cache.outputs.dir }}
-          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-yarn-
-
-      - name: Install dependencies
-        run: yarn install
-
-      - name: Test
-        run: yarn test
+          node-version: 18
+          cache: 'pnpm'
+          cache-dependency-path: '**/pnpm-lock.yaml'
+      - run: pnpm install --frozen-lockfile
+      - run: npm test

.prettierignore

@@ -0,0 +1,2 @@
+/pnpm-lock.yaml
+/dist

CHANGELOG.md

@@ -1,11 +1,22 @@
 # Change Log
 
 ## [Unreleased]
+
+## [0.6.0] - 2023-06-06
+
+### Added
+
+- feat: update dependencies to latest versions
+- feat: add ChatGPT-generated JSDoc documentation
+
 ## [0.5.0] - 2023-03-04
+
 ### Added
-- feat: mark internal atoms as private
 
+- feat: mark internal atoms as private
 
 ## [0.4.0] - 2023-01-31
+
 ### Added
+
 - Migrate to Jotai v2 API #3

examples/01_minimal/package.json

@@ -1,26 +1,30 @@
 {
   "name": "jotai-relay-example",
   "version": "0.1.0",
+  "type": "commonjs",
   "private": true,
   "dependencies": {
     "babel-plugin-relay": "latest",
     "jotai": "latest",
     "jotai-relay": "latest",
     "relay-runtime": "latest",
     "react": "latest",
-    "react-dom": "latest",
-    "react-scripts": "latest"
+    "react-dom": "latest"
   },
-  "scripts": {
-    "start": "react-scripts start",
-    "build": "react-scripts build",
-    "test": "react-scripts test",
-    "eject": "react-scripts eject"
+  "devDependencies": {
+    "@types/react": "latest",
+    "@types/react-dom": "latest",
+    "@types/relay-runtime": "latest",
+    "typescript": "latest",
+    "vite": "latest"
   },
   "browserslist": [
     ">0.2%",
     "not dead",
     "not ie <= 11",
     "not op_mini all"
-  ]
+  ],
+  "scripts": {
+    "dev": "vite"
+  }
 }

examples/01_minimal/relay.config.js

@@ -1,6 +1,9 @@
+// eslint-disable-next-line no-undef
 module.exports = {
   language: 'typescript',
+  // eslint-disable-next-line no-undef
   src: `${__dirname}/src`,
+  // eslint-disable-next-line no-undef
   schema: `${__dirname}/data/schema.graphql`,
   exclude: ['**/node_modules/**', '**/__mocks__/**', '**/__generated__/**'],
 };

examples/01_minimal/src/App.js → examples/01_minimal/src/app.tsx

@@ -1,9 +1,16 @@
-import React, { Suspense } from 'react';
+import { Suspense } from 'react';
 import { Provider, useAtom } from 'jotai/react';
 import { createStore } from 'jotai/vanilla';
 import { environmentAtom, atomWithQuery } from 'jotai-relay';
-import { Environment, Network, RecordSource, Store } from 'relay-runtime';
-import graphql from 'babel-plugin-relay/macro';
+import {
+  Environment,
+  Network,
+  RecordSource,
+  Store,
+  graphql,
+} from 'relay-runtime';
+
+import type { appCountriesQuery } from './__generated__/AppCountriesQuery.graphql';
 
 const myEnvironment = new Environment({
   network: Network.create(async (params, variables) => {
@@ -22,9 +29,9 @@ const myEnvironment = new Environment({
   store: new Store(new RecordSource()),
 });
 
-const countriesAtom = atomWithQuery(
+const countriesAtom = atomWithQuery<appCountriesQuery>(
   graphql`
-    query AppCountriesQuery {
+    query appCountriesQuery {
       countries {
         name
       }
@@ -35,10 +42,11 @@ const countriesAtom = atomWithQuery(
 
 const Main = () => {
   const [data] = useAtom(countriesAtom);
+
   return (
     <ul>
-      {data.countries.map(({ name }) => (
-        <li key={name}>{name}</li>
+      {data.countries.map((country: { name: string }) => (
+        <li key={country.name}>{country.name}</li>
       ))}
     </ul>
   );