chore: apply eslint rules

tauzN · Mar 13, 2022 · 54ef34f · 54ef34f
1 parent f9a4c57
commit 54ef34f
Show file tree

Hide file tree

Showing 40 changed files with 388 additions and 283 deletions.
diff --git a/.eslintignore b/.eslintignore
diff --git a/.eslintrc b/.eslintrc
@@ -1,3 +1,6 @@
 {
-  "extends": "@hannoeru"
+  "extends": "@hannoeru",
+  "rules": {
+    "react/function-component-definition": "off"
+  }
 }
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -41,7 +41,7 @@ jobs:
 
   lint:
     runs-on: ubuntu-latest
-    name: "Lint: node-16, ubuntu-latest"
+    name: 'Lint: node-16, ubuntu-latest'
     steps:
       - name: Checkout repo
         uses: actions/checkout@v2

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -3,7 +3,7 @@ name: Publish Package
 on:
   push:
     tags:
-      - "v*"
+      - 'v*'
 
 jobs:
   publish-npm:

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -3,4 +3,4 @@
   "editor.codeActionsOnSave": {
     "source.fixAll.eslint": true
   },
-}
+}
diff --git a/README.md b/README.md
@@ -46,14 +46,14 @@ npm install solid-app-router
 Add to your `vite.config.js`:
 
 ```js
-import Pages from "vite-plugin-pages";
+import Pages from 'vite-plugin-pages'
 
 export default {
   plugins: [
     // ...
     Pages(),
   ],
-};
+}
 ```
 
 ## Overview
@@ -67,13 +67,13 @@ module in your application.
 ### Vue
 
 ```js
-import { createRouter } from "vue-router";
-import routes from "~pages";
+import { createRouter } from 'vue-router'
+import routes from '~pages'
 
 const router = createRouter({
   // ...
   routes,
-});
+})
 ```
 
 **Type**
@@ -89,8 +89,8 @@ const router = createRouter({
 
 ```js
 import {
-  useRoutes,
   BrowserRouter as Router,
+  useRoutes,
 } from 'react-router-dom'
 
 import routes from '~react-pages'
@@ -118,19 +118,20 @@ ReactDOM.render(
 
 **experimental**
 
-```js
+```tsx
 import { render } from 'solid-js/web'
 import { Router, useRoutes } from 'solid-app-router'
 import routes from '~solid-pages'
 
-const Routes = useRoutes(routes)
-
 render(
-  () => (
-    <Router>
-      <Routes />
-    </Router>
-  ),
+  () => {
+    const Routes = useRoutes(routes)
+    return (
+      <Router>
+        <Routes />
+      </Router>
+    )
+  },
   document.getElementById('root') as HTMLElement,
 )
 ```
@@ -149,15 +150,15 @@ plugin:
 
 ```js
 // vite.config.js
-import Pages from "vite-plugin-pages";
+import Pages from 'vite-plugin-pages'
 
 export default {
   plugins: [
     Pages({
-      dirs: "src/views"
+      dirs: 'src/views',
     }),
   ],
-};
+}
 ```
 
 ### dirs
@@ -200,13 +201,13 @@ export default {
   plugins: [
     Pages({
       dirs: [
-        { dir: "src/pages", baseRoute: "" },
-        { dir: "src/features/**/pages", baseRoute: "features" },
-        { dir: "src/admin/pages", baseRoute: "admin" },
+        { dir: 'src/pages', baseRoute: '' },
+        { dir: 'src/features/**/pages', baseRoute: 'features' },
+        { dir: 'src/admin/pages', baseRoute: 'admin' },
       ],
     }),
   ],
-};
+}
 ```
 
 ### extensions
@@ -242,10 +243,10 @@ src/pages/
 export default {
   plugins: [
     Pages({
-      exclude: ["**/components/*.vue"],
+      exclude: ['**/components/*.vue'],
     }),
   ],
-};
+}
 ```
 
 ### importMode
@@ -269,11 +270,11 @@ export default {
     Pages({
       importMode(path) {
         // Load about page synchronously, all other pages are async.
-        return path.includes("about") ? "sync" : "async";
+        return path.includes('about') ? 'sync' : 'async'
       },
     }),
   ],
-};
+}
 ```
 
 ### routeBlockLang
@@ -316,20 +317,20 @@ export default {
   plugins: [
     Pages({
       extendRoute(route, parent) {
-        if (route.path === "/") {
+        if (route.path === '/') {
           // Index is unauthenticated.
-          return route;
+          return route
         }
 
         // Augment the route with meta that indicates that the route requires authentication.
         return {
           ...route,
           meta: { auth: true },
-        };
+        }
       },
     }),
   ],
-};
+}
 ```
 
 ### onRoutesGenerated
@@ -472,18 +473,18 @@ will result in this routes configuration:
 ```json5
 [
   {
-    path: '/users',
-    component: '/src/pages/users.vue',
-    children: [
+    "path": "/users",
+    "component": "/src/pages/users.vue",
+    "children": [
       {
-        path: '',
-        component: '/src/pages/users/index.vue',
-        name: 'users'
+        "path": "",
+        "component": "/src/pages/users/index.vue",
+        "name": "users"
       },
       {
-        path: ':id',
-        component: '/src/pages/users/[id].vue',
-        name: 'users-id'
+        "path": ":id",
+        "component": "/src/pages/users/[id].vue",
+        "name": "users-id"
       }
     ]
   }

diff --git a/examples/react/src/main.tsx b/examples/react/src/main.tsx
@@ -1,8 +1,8 @@
 import React from 'react'
 import ReactDOM from 'react-dom'
 import {
-  useRoutes,
   BrowserRouter as Router,
+  useRoutes,
 } from 'react-router-dom'
 
 import './index.css'

diff --git a/examples/react/src/pages/blog/[id].tsx b/examples/react/src/pages/blog/[id].tsx
@@ -4,9 +4,7 @@ import { useParams } from 'react-router-dom'
 const Component: React.FC = () => {
   const { id } = useParams()
   return (
-    <>
-      <p>blog/[id].tsx: { id }</p>
-    </>
+    <p>blog/[id].tsx: { id }</p>
   )
 }
 

diff --git a/examples/remix-style/src/main.tsx b/examples/remix-style/src/main.tsx
@@ -1,8 +1,8 @@
 import React from 'react'
 import ReactDOM from 'react-dom'
 import {
-  useRoutes,
   BrowserRouter as Router,
+  useRoutes,
 } from 'react-router-dom'
 
 import './index.css'

diff --git a/examples/remix-style/src/pages/__marketing/product.tsx b/examples/remix-style/src/pages/__marketing/product.tsx
@@ -3,7 +3,7 @@ import React from 'react'
 const Component: React.FC = () => {
   return (
     <div>
-        <p>__marketing/product.tsx</p>
+      <p>__marketing/product.tsx</p>
     </div>
   )
 }

diff --git a/examples/remix-style/src/pages/blog/$id.tsx b/examples/remix-style/src/pages/blog/$id.tsx
@@ -4,9 +4,7 @@ import { useParams } from 'react-router-dom'
 const Component: React.FC = () => {
   const { id } = useParams()
   return (
-    <>
-      <p>blog/$id.tsx: { id }</p>
-    </>
+    <p>blog/$id.tsx: { id }</p>
   )
 }
 

diff --git a/examples/remix-style/src/pages/blog/index.tsx b/examples/remix-style/src/pages/blog/index.tsx
@@ -2,9 +2,7 @@ import React from 'react'
 
 const Component: React.FC = () => {
   return (
-    <>
-      <p>blog/index.tsx</p>
-    </>
+    <p>blog/index.tsx</p>
   )
 }
 

diff --git a/examples/solid/src/admin/pages/index.tsx b/examples/solid/src/admin/pages/index.tsx
@@ -1,6 +1,8 @@
 export default function Index() {
-  return <>
-    <p>/admin/index.tsx</p>
-    <p>located in features /admin/pages folder</p>
-  </>
+  return (
+    <>
+      <p>/admin/index.tsx</p>
+      <p>located in features /admin/pages folder</p>
+    </>
+  )
 }
diff --git a/examples/solid/src/features/admin/pages/admin.tsx b/examples/solid/src/features/admin/pages/admin.tsx
@@ -1,6 +1,8 @@
 export default function Admin() {
-  return <>
-    <p>features/admin/pages/admin.tsx</p>
-    <p>located in features/admin/pages folder</p>
-  </>
+  return (
+    <>
+      <p>features/admin/pages/admin.tsx</p>
+      <p>located in features/admin/pages folder</p>
+    </>
+  )
 }
diff --git a/examples/solid/src/features/dashboard/pages/dashboard.tsx b/examples/solid/src/features/dashboard/pages/dashboard.tsx
@@ -1,6 +1,8 @@
 export default function Dashboard() {
-  return <>
-    <p>features/dashboard/pages/dashboard.tsx</p>
-    <p>located in features/dashboard/pages folder</p>
-  </>
+  return (
+    <>
+      <p>features/dashboard/pages/dashboard.tsx</p>
+      <p>located in features/dashboard/pages folder</p>
+    </>
+  )
 }
diff --git a/examples/solid/src/features/dashboard/pages/welcome.tsx b/examples/solid/src/features/dashboard/pages/welcome.tsx
@@ -1,6 +1,8 @@
 export default function Welcome() {
-  return <>
-    <p>features/dashboard/pages/welcome.tsx</p>
-    <p>located in features/dashboard/pages folder</p>
-  </>
+  return (
+    <>
+      <p>features/dashboard/pages/welcome.tsx</p>
+      <p>located in features/dashboard/pages folder</p>
+    </>
+  )
 }
diff --git a/examples/solid/src/index.tsx b/examples/solid/src/index.tsx
@@ -2,13 +2,14 @@ import { render } from 'solid-js/web'
 import { Router, useRoutes } from 'solid-app-router'
 import routes from '~solid-pages'
 
-const Routes = useRoutes(routes)
-
 render(
-  () => (
-    <Router>
-      <Routes />
-    </Router>
-  ),
+  () => {
+    const Routes = useRoutes(routes)
+    return (
+      <Router>
+        <Routes />
+      </Router>
+    )
+  },
   document.getElementById('root') as HTMLElement,
 )
diff --git a/examples/solid/src/pages/[...all].tsx b/examples/solid/src/pages/[...all].tsx
@@ -1,5 +1,3 @@
 export default function All() {
-  return <>
-    <div>...all route</div>
-  </>
+  return <div>...all route</div>
 }
diff --git a/examples/solid/src/pages/[sensor].tsx b/examples/solid/src/pages/[sensor].tsx
@@ -1,8 +1,10 @@
 import { Outlet } from 'solid-app-router'
 
 export default function SensorLayout() {
-  return <>
-    nested dynamic view:
-    <Outlet />
-  </>
+  return (
+    <>
+      nested dynamic view:
+      <Outlet />
+    </>
+  )
 }
diff --git a/examples/solid/src/pages/[sensor]/current.tsx b/examples/solid/src/pages/[sensor]/current.tsx
@@ -1,8 +1,6 @@
 import { useParams } from 'solid-app-router'
 
 export default function Current() {
-  const { sensor } = useParams < {sensor: string}>()
-  return <>
-    <p>/{ sensor}/current.tsx</p>
-  </>
+  const { sensor } = useParams < { sensor: string }>()
+  return <p>/{sensor}/current.tsx</p>
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,7 +3,7 @@ name: Publish Package @@
     on:
       push:
         tags:
-          - "v*"
+          - 'v*'
     jobs:
       publish-npm:
@@ Expand Down @@