Node.js プロジェクト の 作成

0 件のコメント

今更ですが… Node.js プロジェクト を始めるにあたり最初の準備手順をまとめました。

はじめに

通常の Visual Studio であれば Node.js を扱うプロジェクトがあるためそれを利用すればよいのですが、 Visual Studio Code だとそのようなものはないので手作業で準備することになります。

…とはいえ、 Node.js プロジェクト自体はあまり準備することもなく、以下にあげている「フォルダ作成」と「package.json作成」の2つくらいです。

以下ではそれぞれについて順に見ていきます。

プロジェクトフォルダ 作成

結論から言うとどこでもよいのでディレクトリを作成してしまえば大丈夫です。

参考までに…個人的には以下のような構成をとることが多いです。 D:\ 直下から D:\workspace\project1 のようにすることが多いです。 また、ディレクトリ作成する際は、そのパス中に「日本語文字列」と「空白」のどちらとも含まれないように注意しています。 最近ではあまり遭遇しないですが、「日本語文字列(全角文字)」と「空白」は思わぬトラブルの原因になることが多いのであえて避けています。

[ルート]
  │
  └ [ワークディレクトリ]
       │
       ├ [プロジェクトディレクトリ 1]
       ├ [プロジェクトディレクトリ 2]
       ・
       ・
       ・
       └ [プロジェクトディレクトリ N]

package.json 作成

上記で作成したプロジェクトディレクトリへ移動し、コマンドプロンプトを立ち上げ、以下のコマンドを実行します。 後はウィザードに従って答えていくと package.json というプロジェクト構成ファイルが作成されます。

npm init

ウィザード中に質問される内容は以下のようになっています。

質問 説明
name

プロジェクト名を指定します。 デフォルトはフォルダ名になります。

version

バージョンを指定します。 指定できるバージョン文字列はセマンティックバージョニングに従った文字列になります。

description

プロジェクトの概要を指定します。 入力しないこともできますが、パッケージインストールするたび警告が出るので入力しておくことをオススメします。

entry point エントリーポイントとなるソースファイルを指定します。
test command

npm test で実行されるタスクを指定します。

git repository

GitリポジトリへのURLを指定します。 指定なしだとパッケージインストールするたび警告が出るので入力しておくことをオススメします。

keywords

作成するプロジェクトのキーワードを指定します。 複数ある場合はカンマ区切りで指定します。

author

プロジェクトの作成者名を指定します。

license

ライセンスを指定します。 指定できるライセンス識別子は SPDXライセンス識別子 になります。

About to write to <package.json>

上記までの回答に従って作成される package.json が示されますので、問題なければOKとして作成します。

package.json のその他のオプションについては 「package.json の 仕様 (日本語)」 を参照してください。