From 9f5d7e48a69491b7a75437e632adf20eafe5d79b Mon Sep 17 00:00:00 2001 From: leejooy96 Date: Tue, 11 Jun 2024 18:01:38 +0900 Subject: [PATCH] docs: fix typo --- .github/workflows/app-test.yml | 4 ++-- .gitignore | 2 +- docs/src/electron-how-to/main-and-renderer-process.md | 8 ++++---- docs/src/project-structures/project-structure.md | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/app-test.yml b/.github/workflows/app-test.yml index f39fe62e..068a015d 100644 --- a/.github/workflows/app-test.yml +++ b/.github/workflows/app-test.yml @@ -18,7 +18,7 @@ on: jobs: app-test: runs-on: ${{ matrix.os }} - name: Test NodeJS ${{ matrix.node_version }} on ${{ matrix.os }} + name: Test Node.js ${{ matrix.node_version }} on ${{ matrix.os }} strategy: fail-fast: false matrix: @@ -35,7 +35,7 @@ jobs: run: | sudo apt install -y -q --no-install-recommends xvfb - - name: Setup NodeJS ${{ matrix.node_version }} + - name: Setup Node.js ${{ matrix.node_version }} uses: actions/setup-node@v4 with: node-version: ${{ matrix.node_version }} diff --git a/.gitignore b/.gitignore index f2e874d5..443ac0a8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ -# .gitignore for NodeJS Projects +# .gitignore for Node.js Projects # ---------- Start of common ignore files # Node artifact files diff --git a/docs/src/electron-how-to/main-and-renderer-process.md b/docs/src/electron-how-to/main-and-renderer-process.md index 9869c9af..a360f3c8 100644 --- a/docs/src/electron-how-to/main-and-renderer-process.md +++ b/docs/src/electron-how-to/main-and-renderer-process.md @@ -4,17 +4,17 @@ A **Vutron** application is divided into code into a Main process and a Renderer **"Main"** is the code of `src/main` and is mainly the process code handled by Electron. **"Renderer"** is the code of `src/renderer`, mainly for front-end rendering process like Vue. -In general, **NodeJS** scripts cannot be run in the renderer process. Examples include modules that contain APIs used by NodeJS, or native modules of **NodeJS** such as `path` or `net`, `os` or `crypto`. +In general, **Node.js** scripts cannot be run in the renderer process. Examples include modules that contain APIs used by Node.js, or native modules of **Node.js** such as `path` or `net`, `os` or `crypto`. -Preload scripts are run before the renderer is loaded. It creates a bridge to the main process to keep the execution of NodeJS scripts in the renderer area separate and isolated for security reasons. +Preload scripts are run before the renderer is loaded. It creates a bridge to the main process to keep the execution of Node.js scripts in the renderer area separate and isolated for security reasons. For secure script execution, it is recommended that the main process executes the Node scripts, and the renderer receives the execution results via messaging. This can be implemented via **IPC communication**. For more information on this, see the following articles: https://www.electronjs.org/docs/latest/tutorial/ipc -### How to run NodeJS on a renderer? +### How to run Node.js on a renderer? -If you want to skip the security issues and use NodeJS scripts in your renderer, you need to set `nodeIntegration` to `true` in your `vite.config.ts` file. +If you want to skip the security issues and use Node.js scripts in your renderer, you need to set `nodeIntegration` to `true` in your `vite.config.ts` file. ```javascript rendererPlugin({ diff --git a/docs/src/project-structures/project-structure.md b/docs/src/project-structures/project-structure.md index 6902bcc9..f5c93ddf 100644 --- a/docs/src/project-structures/project-structure.md +++ b/docs/src/project-structures/project-structure.md @@ -60,7 +60,7 @@ order: 1 ├─ .prettierrc - Prettier rule configurations ├─ CODE_OF_CONDUCT.md - Files used only on GitHub ├─ LICENSE - Project license file -├─ package.json - NodeJS package configurations +├─ package.json - Node.js package configurations ├─ package-lock.json ├─ playwright.config.ts - Playwright test rules configurations ├─ tsconfig.json - TypeScript configurations