Merge pull request #85 from alexwkleung/v0.2.0-dev-6.0

v0.2.0-dev-6.0

Author: alexwkleung

.eslintignore

@@ -1,4 +1,3 @@
-**/*.js
 node_modules
 dist
 out

.eslintrc.json

@@ -4,21 +4,30 @@
         "es2021": true
     },
     "extends": [
-        "eslint:recommended",
-        "plugin:@typescript-eslint/recommended"
+        "eslint:recommended"
     ],
-    "parser": "@typescript-eslint/parser",
-    "plugins": [
-        "@typescript-eslint"
-    ],
-    "rules": {
-        "@typescript-eslint/explicit-function-return-type": "error",
-        "@typescript-eslint/no-inferrable-types": "off",
-        "@typescript-eslint/no-explicit-any": "warn",
-        "@typescript-eslint/no-namespace": "off"
-    },
     "parserOptions": {
         "ecmaVersion": "latest",
         "sourceType": "module"
-    }
+    },
+    "overrides": [{
+        "files": ["*.ts", "*.mts", "*.d.ts"],
+        "extends": [
+            "plugin:@typescript-eslint/recommended",
+            "prettier"
+        ],
+        "parser": "@typescript-eslint/parser",
+        "plugins": [
+            "@typescript-eslint",
+            "eslint-plugin-prettier",
+            "prettier"
+        ],
+        "rules": {
+            "@typescript-eslint/explicit-function-return-type": "error",
+            "@typescript-eslint/no-inferrable-types": "off",
+            "@typescript-eslint/no-explicit-any": "warn",
+            "@typescript-eslint/no-namespace": "off",
+            "prettier/prettier": "error"
+        }
+    }]
 }

.gitignore

@@ -2,4 +2,5 @@
 node_modules
 dist
 out
-*.log*
+*.log*
+.hmr_pid.txt

.prettierignore

@@ -0,0 +1,17 @@
+**/*.json
+**/*.
+**/*.md
+**/*.js
+**/*.html
+**/*.css
+**/*.yml
+vite.config.ts
+src/vite.d.ts
+out
+dist
+build
+node_modules
+resources
+screenshots
+test
+fs-mod

.prettierrc.json

@@ -0,0 +1,7 @@
+{
+    "trailingComma": "es5",
+    "tabWidth": 4,
+    "semi": true,
+    "singleQuote": false,
+    "printWidth": 120
+}

README.md

@@ -31,8 +31,6 @@ The app is currently in early development and may not be 100% stable for daily u
 
 Only macOS installers are supplied in the early development phase. Other platforms will be supported in the official release.
 
-v0.2.0 will mark the first official build for Iris. There will be a handful of dev builds that users can install to get a feel of the application before release.
-
 You can use the [GitHub Discussions](https://github.com/alexwkleung/Iris/discussions) for communication. Other mediums will be created in the near future.
 
 # Installation
@@ -43,6 +41,8 @@ If you want to build the app directly from source, follow the instructions in [D
 
 # Development 
 
+The recommended editor for development is [VS Code](https://code.visualstudio.com/)
+
 Install [Node.js](https://nodejs.org/en/download)
 
 Install [Rust](https://www.rust-lang.org/tools/install)
@@ -88,6 +88,16 @@ Install npm dependencies. Only do this in the *root* of the project. Do not `npm
 npm install 
 ```
 
+It recommended to add these to your VS Code `settings.json`:
+
+```json
+"editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "always",
+    "editor.formatOnSave": "always",
+},
+"prettier.enable": true,
+```
+
 Build native modules
 
 ```bash
@@ -149,7 +159,7 @@ npm run build:linux
 
 Here are a list of ways you can contribute to Iris:
 
-1. [Submit a Pull Request](https://github.com/alexwkleung/Iris/pulls)
+1. [Submit a pull request](https://github.com/alexwkleung/Iris/pulls)
 2. [Create or answer issues](https://github.com/alexwkleung/Iris/issues)
 3. [Create or answer discussion posts](https://github.com/alexwkleung/Iris/discussions)
 4. Show your interest by sharing Iris to others :)

build/notarize.js

@@ -0,0 +1,62 @@
+#!/usr/bin/env node
+
+import chokidar from 'chokidar'
+import { exec } from 'child_process'
+import * as fs from 'fs'
+import process from 'process'
+
+const chokidarPaths = [
+    'index.html', 
+    'src/is-main.mts',
+    'src/main.ts',
+    'src/preload/**/*.mts',
+    'src/renderer/**/*.ts',
+    'src/renderer/**/*.mts',
+    'src/**/*'
+];
+
+const chokidarPathsIgnore = [
+    'src/**/*.css'
+]
+
+const chokidarDev = () => {
+    fs.open('.hmr_pid.txt', 'w', (err, fd) => {
+        if(!err) {
+            fs.close(fd, (err) => {
+                if(err) {
+                    throw console.error(err);
+                }
+            })
+        } else {
+            throw console.error(err);
+        }
+    })
+
+    console.log("HMR is active");
+
+    chokidar.watch(chokidarPaths, { ignored: chokidarPathsIgnore }).on('all', (event, path) => {
+        if(event === 'change' && path !== null && path !== undefined) {
+            console.log("File changed: " + path);
+
+            console.log("Rebuilding files...");
+
+            try {                  
+                exec('npm run build').on('exit', () => {
+                    fs.readFile('.hmr_pid.txt', { encoding: 'utf-8' }, (err, data) => {
+                        if(!err) {
+                            process.kill(data);
+                        } else {
+                            throw console.error(err);
+                        }
+                    })
+
+                    console.log("Restarting Electron process...");
+                    exec('npm run electron');
+                });
+            } catch(e) {
+                throw console.error(e);
+            }    
+        }
+    })
+}
+chokidarDev();

cli.js

@@ -5,7 +5,6 @@ directories:
 files:
   - '!**/.vscode/*'
   - '!src/*'
-  - '!electron.vite.config.{js,ts,mjs,cjs}'
   - '!{.eslintignore,.eslintrc.js,.prettierignore,.prettierrc.yaml,dev-app-update.yml,CHANGELOG.md,README.md}'
   - '!{.env,.env.*,.npmrc,pnpm-lock.yaml}'
   - '!{tsconfig.json,tsconfig.node.json,tsconfig.web.json}'
@@ -19,9 +18,18 @@ files:
   - '!**/fs-mod/src/*'
   - '!node_modules/*'
   - '!dist/*'
+  - './out/**/*'
+  - 'out/**/*'
+  - 'out/index.html'
+  - 'out/assets/*'
+  - 'out/assets/**/*'
+  - './out/main.js'
+  - 'out/renderer/renderer.js'
+  - 'out/renderer/**/*.js'
+  - 'out/preload/preload.mjs'
+  - 'out/preload/**/*.mjs'
 asarUnpack:
   - resources/**
-afterSign: build/notarize.js
 win:
   executableName: Iris
 nsis:
@@ -47,4 +55,4 @@ appImage:
 npmRebuild: false
 publish:
   provider: generic
-  url: https://example.com/auto-updates
+  url: https://example.com/auto-updates

electron-builder.yml

@@ -7,10 +7,8 @@
     <meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self' 'unsafe-inline'; style-src 'self' 'unsafe-inline'; style-src-elem data: 'self' 'unsafe-inline'; img-src https: data: 'self' local: data: 'self'; font-src data: 'self' 'unsafe-inline'">
   </head>
   <body>
-    <link rel="stylesheet" href="./assets/global.css">
+    <link rel="stylesheet" href="./src/assets/global.css">
 
-    <script type="module" src="./app.ts"></script>
-    <script type="module" src="./src/renderer.ts"></script>
-    <script async="false" type="module" src="./listener-main.ts"></script>
+    <script type="module" src="./src/renderer/renderer.ts"></script>
   </body>
 </html>