Merge branch 'release/v8'

.babelrc

@@ -1,9 +1,7 @@
 {
-  "presets": [
-    "@babel/preset-typescript"
-  ],
+  "presets": ["@babel/preset-typescript"],
   "plugins": [
-    "@babel/plugin-proposal-class-properties",
-    "@babel/plugin-proposal-object-rest-spread"
+    "@babel/plugin-transform-class-properties",
+    "@babel/plugin-transform-object-rest-spread"
   ]
 }

.eslintignore

@@ -0,0 +1,9 @@
+node_modules
+/pnpm-lock.yaml
+
+# nextron
+bin
+workspace
+
+# examples
+examples

.eslintrc.json

@@ -0,0 +1,14 @@
+{
+  "root": true,
+  "extends": [
+    "eslint:recommended",
+    "next/core-web-vitals",
+    "plugin:@typescript-eslint/recommended",
+    "prettier"
+  ],
+  "plugins": ["@typescript-eslint"],
+  "rules": {
+    "@typescript-eslint/no-unused-vars": "error",
+    "@typescript-eslint/no-explicit-any": "error"
+  }
+}

.github/workflows/codeql-analysis.yml

@@ -9,14 +9,14 @@
 # the `language` matrix defined below to confirm you have the correct set of
 # supported CodeQL languages.
 #
-name: "CodeQL"
+name: 'CodeQL'
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ main ]
+    branches: [main]
   schedule:
     - cron: '45 21 * * 3'
 
@@ -32,40 +32,40 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'javascript' ]
+        language: ['javascript']
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
         # Learn more:
         # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
+      - name: Checkout repository
+        uses: actions/checkout@v2
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v1
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v1
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
 
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
 
-    #- run: |
-    #   make bootstrap
-    #   make release
+      #- run: |
+      #   make bootstrap
+      #   make release
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1

.gitignore

@@ -1,9 +1,15 @@
 node_modules
+
+# nextron
 bin
 workspace
+
+# examples
 examples/**/yarn.lock
 examples/**/package-lock.json
 examples/**/pnpm-lock.yaml
 examples/**/renderer/next-env.d.ts
+
+# misc
 .idea
 .DS_Store

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged

.npmrc

@@ -0,0 +1 @@
+enable-pre-post-scripts=true

.prettierignore

@@ -0,0 +1,9 @@
+node_modules
+/pnpm-lock.yaml
+
+# nextron
+bin
+workspace
+
+# examples
+examples

.prettierrc.json

@@ -0,0 +1,7 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "useTabs": false,
+  "tabWidth": 2
+}

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  },
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "typescript.tsdk": "node_modules/typescript/lib"
+}

README.md

@@ -138,9 +138,9 @@ module.exports = {
   // main process' webpack config
   webpack: (config, env) => {
     // do some stuff here
-    return config;
+    return config
   },
-};
+}
 ```
 
 ## Custom Babel Config for the Main Process
@@ -166,21 +166,21 @@ If we want to use some libraries that don't support SSR, we should check if the
 ```jsx
 // pages/home.jsx
 
-import electron from 'electron';
+import electron from 'electron'
 
 const Home = () => {
   // we can't use `electron.ipcRenderer` directly!
-  const ipcRenderer = electron.ipcRenderer;
+  const ipcRenderer = electron.ipcRenderer
 
   // we should check it like this
-  const ipcRenderer = electron.ipcRenderer || false;
+  const ipcRenderer = electron.ipcRenderer || false
   if (ipcRenderer) {
     // we can use `electron.ipcRenderer`
     // because this scope is the client webpack process
   }
-};
+}
 
-export default Home;
+export default Home
 ```
 
 ### The Basic of React Hooks :)
@@ -190,8 +190,8 @@ As mentioned above, we should check if the webpack process is a client because t
 ```jsx
 // pages/home.jsx
 
-import electron from 'electron';
-import React from 'react';
+import electron from 'electron'
+import React from 'react'
 
 const Home = () => {
   // In this scope, both of server and client processes are running
@@ -201,17 +201,17 @@ const Home = () => {
     // componentDidMount() like
 
     // In this scope, only the client process is running
-    window.alert('wow');
+    window.alert('wow')
 
     return () => {
       // componentWillUnmount() like
-    };
-  }, []);
+    }
+  }, [])
 
-  return <p>Hello Nextron</p>;
-};
+  return <p>Hello Nextron</p>
+}
 
-export default Home;
+export default Home
 ```
 
 ## Examples
@@ -403,18 +403,22 @@ $ pnpm dev <EXAMPLE-FOLDER-NAME>
 ### Developing for your own project
 
 1. Install development version of nextron
+
 ```
 $ cd nextron
 $ npm install
 $ npm run build
-$ npm link 
+$ npm link
 ```
+
 2. Install linked nextron in your project
+
 ```
 $ cd your-project
 $ npm install -D @babel/runtime-corejs3 # required for nextron
 $ npm link nextron
 ```
+
 3. On every change in nextron, run `npm run build` in nextron folder and restart your project
 
 ## Maintainers ⚡

babel.js

@@ -1,25 +1,34 @@
 module.exports = (api) => {
-  api.cache(() => process.env.NODE_ENV === 'production');
+  api.cache(() => process.env.NODE_ENV === 'production')
   return {
     presets: [
-      [require('@babel/preset-env'), {
-        targets: {
-          node: true,
+      [
+        require('@babel/preset-env'),
+        {
+          targets: {
+            node: true,
+          },
         },
-      }],
+      ],
       require('@babel/preset-typescript'),
     ],
     plugins: [
-      require('@babel/plugin-proposal-class-properties'),
-      [require('@babel/plugin-proposal-object-rest-spread'), {
-        useBuiltIns: true,
-      }],
-      [require('@babel/plugin-transform-runtime'), {
-        corejs: 3,
-        helpers: true,
-        regenerator: true,
-        useESModules: false,
-      }],
+      require('@babel/plugin-transform-class-properties'),
+      [
+        require('@babel/plugin-transform-object-rest-spread'),
+        {
+          useBuiltIns: true,
+        },
+      ],
+      [
+        require('@babel/plugin-transform-runtime'),
+        {
+          corejs: 3,
+          helpers: true,
+          regenerator: true,
+          useESModules: false,
+        },
+      ],
     ],
-  };
-};
+  }
+}