From 6b3c182dc41213a1b1ee7db8104889485063140e Mon Sep 17 00:00:00 2001 From: RyoNakagawa Date: Fri, 11 Oct 2024 11:09:17 +0900 Subject: [PATCH 1/3] =?UTF-8?q?VSCode=E3=81=AB=E3=82=A4=E3=83=B3=E3=82=B9?= =?UTF-8?q?=E3=83=88=E3=83=BC=E3=83=AB=E3=81=99=E3=81=B9=E3=81=8D=E6=8B=A1?= =?UTF-8?q?=E5=BC=B5=E6=A9=9F=E8=83=BD=E3=81=AB=E3=81=A4=E3=81=84=E3=81=A6?= =?UTF-8?q?=E8=AA=AC=E6=98=8E=E3=82=92=E8=BF=BD=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../how-to-develop/java/preparation.md | 34 +++++++++++++++++ .../how-to-develop/local-environment/index.md | 38 ++++++------------- .../how-to-develop/vue-js/preparation.md | 36 ++++++++++++++++++ documents/mkdocs.yml | 1 + 4 files changed, 83 insertions(+), 26 deletions(-) create mode 100644 documents/contents/guidebooks/how-to-develop/java/preparation.md diff --git a/documents/contents/guidebooks/how-to-develop/java/preparation.md b/documents/contents/guidebooks/how-to-develop/java/preparation.md new file mode 100644 index 000000000..58bd5bbd9 --- /dev/null +++ b/documents/contents/guidebooks/how-to-develop/java/preparation.md @@ -0,0 +1,34 @@ +--- +title: Java 編 +description: バックエンドで動作する Java アプリケーションの 開発手順を解説します。 +--- + +# 事前準備 {#top} + +## ローカル開発環境の構築 {#create-dev-environment} + +ローカル開発環境の構築について [ローカル開発環境の構築](../local-environment/index.md) を参照し、最低限必要なソフトウェアをインストールしてください。 + +## Visual Studio Code の拡張機能インストール {#install-extensions} + +Visual Studio Code を利用する場合、 Java アプリケーションを開発するために以下の拡張機能をインストールします。 + +- [Spring Boot Extension Pack :material-open-in-new:](https://marketplace.visualstudio.com/items?itemName=vmware.vscode-boot-dev-pack){ target=_blank } + + Spring Boot アプリケーションの開発とデプロイを提供します。 + +- [Extension Pack for Java :material-open-in-new:](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack){ target=_blank } + + Java アプリケーションの作成、テスト、デバッグの機能を提供します。 + +- [Gradle for Java :material-open-in-new:](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-gradle){ target=_blank } + + Gradle ビルド用のビジュアルインターフェイスを提供します。 + +- [Language Support for Java(TM) by Red Hat :material-open-in-new:](https://marketplace.visualstudio.com/items?itemName=redhat.java){ target=_blank } + + Java アプリケーション開発における、コード補完やエラーレポート、リファクタリングなどの拡張機能を提供します。 + +- [Lombok Annotations Support for VS Code :material-open-in-new:](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-lombok){ target=_blank } + + Java アプリケーションにおける Lombok アノテーションのサポートを提供します。 diff --git a/documents/contents/guidebooks/how-to-develop/local-environment/index.md b/documents/contents/guidebooks/how-to-develop/local-environment/index.md index 5022d1a70..89d6f671a 100644 --- a/documents/contents/guidebooks/how-to-develop/local-environment/index.md +++ b/documents/contents/guidebooks/how-to-develop/local-environment/index.md @@ -54,9 +54,7 @@ AlesInfiny Maia の各ドキュメントは、本節に記載されている環 ### Visual Studio Code のインストール {#install-vscode} -1. 以下のサイトから、コンピューターの環境にあった Visual Studio Code(以下 VS Code) のインストーラーをダウンロードします。 - - +1. [こちらのサイト :material-open-in-new:](https://code.visualstudio.com/){ target=_blank } から、コンピューターの環境にあった Visual Studio Code(以下 VS Code) のインストーラーをダウンロードします。 1. ダウンロードしたインストーラーを実行します。 @@ -66,9 +64,12 @@ AlesInfiny Maia の各ドキュメントは、本節に記載されている環 1. 以下の拡張機能をインストールします。 - - [Japanese Language Pack for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=MS-CEINTL.vscode-language-pack-ja) + - [Japanese Language Pack for Visual Studio Code :material-open-in-new:](https://marketplace.visualstudio.com/items?itemName=MS-CEINTL.vscode-language-pack-ja){ target=_blank } + + バックエンドアプリケーションやフロントエンドアプリケーションの開発に利用する VS Code の拡張機能は、以下を確認してください。 - - [Vue - Official](https://marketplace.visualstudio.com/items?itemName=Vue.volar)[^1] + - [バックエンドアプリケーション開発の事前準備](../java/preparation.md#install-extensions) + - [フロントエンドアプリケーション開発の事前準備](../vue-js/preparation.md#install-extensions) ### Git for Windows のインストール {#install-git-for-windows} @@ -77,9 +78,7 @@ AlesInfiny Maia の各ドキュメントは、本節に記載されている環 Git for Windows のインストール中に、既定のエディターを選択する必要があります。 VS Code をインストールしている場合、 VS Code を既定のエディターとして設定できます。 -1. 以下のサイトから、コンピューターの環境にあった Git for Windows のインストーラーをダウンロードします。 - - +1. [こちらのサイト :material-open-in-new:](https://git-scm.com/){ target=_blank } から、コンピューターの環境にあった Git for Windows のインストーラーをダウンロードします。 1. ダウンロードしたインストーラーを実行します。 @@ -95,23 +94,15 @@ AlesInfiny Maia の各ドキュメントは、本節に記載されている環 JDK の取得先は実行環境に合わせて選択します。 -- Azure：Microsoft Build for OpenJDK - - - -- AWS：Amazon Corretto +- [Azure：Microsoft Build for OpenJDK :material-open-in-new:](https://www.microsoft.com/openjdk/){ target=_blank } - +- [AWS：Amazon Corretto :material-open-in-new:](https://aws.amazon.com/jp/corretto/){ target=_blank } - オンプレミス/その他クラウドサービス（下記のいずれか） - - Adoptium + - [Adoptium :material-open-in-new:](https://adoptium.net/){ target=_blank } - - - - Oracle JDK - - + - [Oracle JDK :material-open-in-new:](https://www.oracle.com/java/){ target=_blank } 本ドキュメントは Adoptium を前提に記載しています。 @@ -124,11 +115,6 @@ JDK のインストール時のカスタムセットアップで設定済みで ### Node.js のインストール {#install-node} -1. 以下のサイトからインストーラーを取得します。 - - +1. [こちらのサイト :material-open-in-new:](https://nodejs.org/en/){ target=_blank } からインストーラーを取得します。 1. インストーラーを実行します。カスタムセットアップにて、 npm のインストールと PATH の追加をするよう設定することを推奨します ( 既定値のままインストールすると npm のインストールと PATH の設定が行われます ) 。 - -[^1]: - Vue.js アプリケーションの開発に推奨されている拡張機能です。詳細は [公式ドキュメント :material-open-in-new:](https://ja.vuejs.org/guide/scaling-up/tooling#ide-support){ target=_blank }を参照してください。 diff --git a/documents/contents/guidebooks/how-to-develop/vue-js/preparation.md b/documents/contents/guidebooks/how-to-develop/vue-js/preparation.md index dbd25e468..acb92e1a9 100644 --- a/documents/contents/guidebooks/how-to-develop/vue-js/preparation.md +++ b/documents/contents/guidebooks/how-to-develop/vue-js/preparation.md @@ -8,3 +8,39 @@ description: Vue.js を用いた クライアントサイドアプリケーシ ## ローカル開発環境の構築 {#create-dev-environment} ローカル開発環境の構築について [ローカル開発環境の構築](../local-environment/index.md) を参照し、最低限必要なソフトウェアをインストールしてください。 + +## Visual Studio Code の拡張機能インストール {#install-extensions} + +Visual Studio Code を利用する場合、クライアントサイドアプリケーションの開発のために以下の拡張機能をインストールします。 + +- [Vue - Official :material-open-in-new:](https://marketplace.visualstudio.com/items?itemName=Vue.volar){ target=_blank } + + Vue.js アプリケーションの開発に推奨されている拡張機能です。 + 詳細は [公式ドキュメント :material-open-in-new:](https://ja.vuejs.org/guide/scaling-up/tooling#ide-support){ target=_blank }を参照してください。 + +- [EditorConfig for VS Code :material-open-in-new:](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig){ target=_blank } + + アプリケーションのコーディングスタイルを維持する機能を提供します。 + +- [ESLint :material-open-in-new:](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint){ target=_blank } + + TypeScript のコード品質を向上させるための拡張機能です。 + リアルタイムでのコードのエラーを検出する機能を提供します。 + +- [Stylelint :material-open-in-new:](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint){ target=_blank } + + CSS のコード品質を向上させるための拡張機能です。 + リアルタイムでのコードのエラーを検出する機能を提供します。 + +- [Prettier - Code formatter :material-open-in-new:](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode){ target=_blank } + + EditorConfig や ESLint 、 StyleLint と連携して、より詳細なコーディングルールを適用する機能を提供します。 + +- [language-postcss :material-open-in-new:](https://marketplace.visualstudio.com/items?itemName=cpylua.language-postcss){ target=_blank } + + PostCSS で記述されたコードの可読性を向上させる機能を提供します。 + また、 StyleLint と連携することで、 PostCSS のコードのエラーを検出できます。 + +- [Code Spell Checker :material-open-in-new:](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker){ target=_blank } + + コードやテキストの一般的なスペルの誤りを検知する機能を提供します。 diff --git a/documents/mkdocs.yml b/documents/mkdocs.yml index 90576d224..10264d57c 100644 --- a/documents/mkdocs.yml +++ b/documents/mkdocs.yml @@ -72,6 +72,7 @@ nav: - Java 編: - guidebooks/how-to-develop/java/index.md - アプリケーションの全体構造: guidebooks/how-to-develop/java/application-structure.md + - 事前準備: guidebooks/how-to-develop/java/preparation.md - プロジェクトの雛型作成: guidebooks/how-to-develop/java/create-project.md - プロジェクトの共通設定: guidebooks/how-to-develop/java/common-project-settings.md - サブプロジェクトの個別設定: guidebooks/how-to-develop/java/sub-project-settings.md From 426cb1665c6f70b0e80ada50e6555f2809af787b Mon Sep 17 00:00:00 2001 From: RyoNakagawa Date: Fri, 11 Oct 2024 16:26:54 +0900 Subject: [PATCH 2/3] =?UTF-8?q?=E4=BA=8B=E5=89=8D=E6=BA=96=E5=82=99?= =?UTF-8?q?=E3=81=AE=E3=83=9A=E3=83=BC=E3=82=B8=E3=82=92=E6=AD=A3=E3=81=97?= =?UTF-8?q?=E3=81=84=E9=85=8D=E7=BD=AE=E3=81=A8=E9=81=B7=E7=A7=BB=E3=81=AB?= =?UTF-8?q?=E4=BF=AE=E6=AD=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- documents/contents/guidebooks/how-to-develop/java/index.md | 4 ++-- documents/mkdocs.yml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/documents/contents/guidebooks/how-to-develop/java/index.md b/documents/contents/guidebooks/how-to-develop/java/index.md index e0665c30b..3b146dc00 100644 --- a/documents/contents/guidebooks/how-to-develop/java/index.md +++ b/documents/contents/guidebooks/how-to-develop/java/index.md @@ -9,9 +9,9 @@ description: バックエンドで動作する Java アプリケーションの AlesInfiny Maia OSS Edition として推奨する設定や、共通的に使用する実装コードを中心に、プロジェクトの初期構築に必要な情報を提供します。 業務機能の開発方法については解説しません。 -1. 事前準備 +1. [事前準備](./preparation.md) - 「[ローカル開発環境の構築](../../how-to-develop/local-environment/index.md)」を参照し、 Java アプリケーションの開発に必要なローカル開発環境を構築してください。 + Java アプリケーションの開発に必要なローカル開発環境について解説します。 1. [アプリケーションの全体構造](./application-structure.md) diff --git a/documents/mkdocs.yml b/documents/mkdocs.yml index 10264d57c..a24bb4906 100644 --- a/documents/mkdocs.yml +++ b/documents/mkdocs.yml @@ -71,8 +71,8 @@ nav: - guidebooks/how-to-develop/index.md - Java 編: - guidebooks/how-to-develop/java/index.md - - アプリケーションの全体構造: guidebooks/how-to-develop/java/application-structure.md - 事前準備: guidebooks/how-to-develop/java/preparation.md + - アプリケーションの全体構造: guidebooks/how-to-develop/java/application-structure.md - プロジェクトの雛型作成: guidebooks/how-to-develop/java/create-project.md - プロジェクトの共通設定: guidebooks/how-to-develop/java/common-project-settings.md - サブプロジェクトの個別設定: guidebooks/how-to-develop/java/sub-project-settings.md From 3ce9a9e927c4f93c599c1b79413d4e10e5c63f85 Mon Sep 17 00:00:00 2001 From: RyoNakagawa Date: Fri, 11 Oct 2024 17:19:23 +0900 Subject: [PATCH 3/3] =?UTF-8?q?=E6=8B=A1=E5=BC=B5=E6=A9=9F=E8=83=BD?= =?UTF-8?q?=E3=81=AE=E8=AA=AC=E6=98=8E=E3=82=92=E7=A7=BB=E5=8B=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../contents/guidebooks/how-to-develop/java/index.md | 2 +- .../guidebooks/how-to-develop/java/preparation.md | 10 ++++------ .../how-to-develop/local-environment/index.md | 6 ++++++ .../guidebooks/how-to-develop/vue-js/preparation.md | 8 -------- 4 files changed, 11 insertions(+), 15 deletions(-) diff --git a/documents/contents/guidebooks/how-to-develop/java/index.md b/documents/contents/guidebooks/how-to-develop/java/index.md index 3b146dc00..b6ef5bcb1 100644 --- a/documents/contents/guidebooks/how-to-develop/java/index.md +++ b/documents/contents/guidebooks/how-to-develop/java/index.md @@ -11,7 +11,7 @@ AlesInfiny Maia OSS Edition として推奨する設定や、共通的に使用 1. [事前準備](./preparation.md) - Java アプリケーションの開発に必要なローカル開発環境について解説します。 + Java アプリケーションの開発に必要なローカル開発環境について解説します。 1. [アプリケーションの全体構造](./application-structure.md) diff --git a/documents/contents/guidebooks/how-to-develop/java/preparation.md b/documents/contents/guidebooks/how-to-develop/java/preparation.md index 58bd5bbd9..17295d1c3 100644 --- a/documents/contents/guidebooks/how-to-develop/java/preparation.md +++ b/documents/contents/guidebooks/how-to-develop/java/preparation.md @@ -19,15 +19,13 @@ Visual Studio Code を利用する場合、 Java アプリケーションを開 - [Extension Pack for Java :material-open-in-new:](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack){ target=_blank } - Java アプリケーションの作成、テスト、デバッグの機能を提供します。 + Java アプリケーションの作成、テスト、デバッグ等の基本的な機能を提供します。 -- [Gradle for Java :material-open-in-new:](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-gradle){ target=_blank } + - Gradle ビルド用のビジュアルインターフェイスを提供します。 + アプリケーションの起動で利用する [Gradle for Java :material-open-in-new:](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-gradle){ target=_blank } やコード補完やエラーレポートを提供する [Language Support for Java(TM) by Red Hat :material-open-in-new:](https://marketplace.visualstudio.com/items?itemName=redhat.java){ target=_blank } といったの拡張機能が追加でインストールされます。 -- [Language Support for Java(TM) by Red Hat :material-open-in-new:](https://marketplace.visualstudio.com/items?itemName=redhat.java){ target=_blank } - - Java アプリケーション開発における、コード補完やエラーレポート、リファクタリングなどの拡張機能を提供します。 + - [Lombok Annotations Support for VS Code :material-open-in-new:](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-lombok){ target=_blank } diff --git a/documents/contents/guidebooks/how-to-develop/local-environment/index.md b/documents/contents/guidebooks/how-to-develop/local-environment/index.md index 89d6f671a..49616258e 100644 --- a/documents/contents/guidebooks/how-to-develop/local-environment/index.md +++ b/documents/contents/guidebooks/how-to-develop/local-environment/index.md @@ -66,6 +66,12 @@ AlesInfiny Maia の各ドキュメントは、本節に記載されている環 - [Japanese Language Pack for Visual Studio Code :material-open-in-new:](https://marketplace.visualstudio.com/items?itemName=MS-CEINTL.vscode-language-pack-ja){ target=_blank } + VS Code のユーザーインターフェースを日本語にローカライズする機能を提供します。 + + - [EditorConfig for VS Code :material-open-in-new:](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig){ target=_blank } + + アプリケーションのコーディングスタイルを維持する機能を提供します。 + バックエンドアプリケーションやフロントエンドアプリケーションの開発に利用する VS Code の拡張機能は、以下を確認してください。 - [バックエンドアプリケーション開発の事前準備](../java/preparation.md#install-extensions) diff --git a/documents/contents/guidebooks/how-to-develop/vue-js/preparation.md b/documents/contents/guidebooks/how-to-develop/vue-js/preparation.md index acb92e1a9..c5f02792d 100644 --- a/documents/contents/guidebooks/how-to-develop/vue-js/preparation.md +++ b/documents/contents/guidebooks/how-to-develop/vue-js/preparation.md @@ -18,10 +18,6 @@ Visual Studio Code を利用する場合、クライアントサイドアプリ Vue.js アプリケーションの開発に推奨されている拡張機能です。 詳細は [公式ドキュメント :material-open-in-new:](https://ja.vuejs.org/guide/scaling-up/tooling#ide-support){ target=_blank }を参照してください。 -- [EditorConfig for VS Code :material-open-in-new:](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig){ target=_blank } - - アプリケーションのコーディングスタイルを維持する機能を提供します。 - - [ESLint :material-open-in-new:](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint){ target=_blank } TypeScript のコード品質を向上させるための拡張機能です。 @@ -40,7 +36,3 @@ Visual Studio Code を利用する場合、クライアントサイドアプリ PostCSS で記述されたコードの可読性を向上させる機能を提供します。 また、 StyleLint と連携することで、 PostCSS のコードのエラーを検出できます。 - -- [Code Spell Checker :material-open-in-new:](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker){ target=_blank } - - コードやテキストの一般的なスペルの誤りを検知する機能を提供します。