-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* npm workspacesの構成一式をMarisから移植 * mockについてmaia固有のコードに戻し * フロントエンドCIについてモノレポ構成に対応 * openapi-generatorのバージョンアップ確認CIについて、モノレポ構成に対応 * バックエンドのポート番号はmaia固有なので、env.devを戻し * Vue.js編にワークスペースの導入方法を追記 * mono-repoに関する説明の参照を削除 * Open API Generatorの設定において、"openapi-client:generate"のパスを修正 --------- Co-authored-by: kentah <158997636+KentaHizume@users.noreply.github.com>
- Loading branch information
1 parent
f68e110
commit 27f4276
Showing
152 changed files
with
5,132 additions
and
10,715 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
154 changes: 154 additions & 0 deletions
154
...s/_materials/images/guidebooks/how-to-develop/vue-js/project-folder-structure-dark.drawio
Large diffs are not rendered by default.
Oops, something went wrong.
154 changes: 154 additions & 0 deletions
154
.../_materials/images/guidebooks/how-to-develop/vue-js/project-folder-structure-light.drawio
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
75 changes: 75 additions & 0 deletions
75
documents/contents/guidebooks/how-to-develop/vue-js/setting-workspaces.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| --- | ||
| title: Vue.js 開発手順 | ||
| description: Vue.js を用いた クライアントサイドアプリケーションの 開発手順を説明します。 | ||
| --- | ||
|
|
||
| # ワークスペースの設定 {#top} | ||
|
|
||
| [ブランクプロジェクトの作成](./create-vuejs-blank-project.md) で作成したルートプロジェクトとワークスペースについて、 | ||
| 追加で必要な設定をします。 | ||
|
|
||
| ## ワークスペースの定義 {#definition-workspaces} | ||
|
|
||
| ワークスペースの名称は、ルートプロジェクトの package.json の `workspaces` プロパティで定義し、この値はワークスペースの package.json の `name` プロパティと一致している必要があります。 | ||
| [ブランクプロジェクトの作成](./create-vuejs-blank-project.md) に従って初期設定した場合は、自動的に構成されます。 | ||
|
|
||
| ``` json title="package.json（ルート）" | ||
| "workspaces": [ | ||
| "workspace-name" | ||
| ] | ||
| ``` | ||
|
|
||
| ``` json title="package.json（ワークスペース）" | ||
| { | ||
| "name": "workspace-name", | ||
| } | ||
| ``` | ||
|
|
||
| ## ルートプロジェクトの設定 {#setting-route-project} | ||
|
|
||
| ルートプロジェクトの package-json に `"type": "module"`と`"private": "true"`を追加します。 | ||
| CJS 形式のファイルを正しく読み込むために、 `"type": "module"` は設定が必須です。 | ||
| `"private": "true"`は、誤ってルートプロジェクトが公開されることを防ぐため、設定を推奨します。 | ||
|
|
||
| ```json title="package.json（ルート）" hl_lines="6 7" | ||
| { | ||
| "name": "project-name", | ||
| "version": "1.0.0", | ||
| "description": "", | ||
| "main": "index.js", | ||
| "type": "module", | ||
| "private": "true", | ||
| "scripts": { | ||
| "test": "echo \"Error: no test specified\" && exit 1" | ||
| }, | ||
| "keywords": [], | ||
| "author": "", | ||
| "license": "ISC" | ||
| } | ||
| ``` | ||
|
|
||
| ## スクリプトの登録 {#register-npm-scripts} | ||
|
|
||
| CI パイプラインで使用するために、ルートプロジェクトの package.json にスクリプトを登録します。 | ||
| `-w` オプションでワークスペース名を指定することで、指定したワークスペースの package.json に存在するスクリプトを実行できます。 | ||
| 設定例を下記に示します。 | ||
|
|
||
| ``` json title="package.json（ルート）" | ||
| { | ||
| "scripts": { | ||
| "lint:ci:workspace-name": "npm run lint:ci -w workspace-name", | ||
| "type-check:workspace-name": "npm run type-check -w workspace-name", | ||
| "build-only:dev:workspace-name": "npm run build-only:dev -w workspace-name", | ||
| "build:prod:workspace-name": "npm run build:prod -w workspace-name", | ||
| "test:unit:workspace-name": "npm run test:unit -w workspace-name", | ||
| "dev:workspace-name": "npm run dev -w workspace-name" | ||
| }, | ||
| } | ||
| ``` | ||
|
|
||
| ## パッケージの依存関係の管理 {#manage-package-dependency} | ||
|
|
||
| パッケージのバージョンは、ルートプロジェクトの package-lock.json で管理されます。各ワークスペースには package-lock.json は作成されません。 | ||
| パッケージのインストール・バージョン更新は、 npm workspaces を使用しない場合と同様に、各ワークスペースで `npm install` を行います。 | ||
| しかし、インストールしたパッケージの依存関係は、ルートプロジェクトの package-lock.json に記録されます。 | ||
| また、各ワークスペースの package.json でバージョンを指定することで、ワークスペース間で異なるバージョンのパッケージを使用できます。 |
Oops, something went wrong.