npmの設定の属性の一覧を作成したのですが、思ったより長くなってしまったので別の記事にしました。
注:勉強+メモ目的で内容の保証はできません。
名前既定値、型、説明
always-auth
既定値: false
属性型: Boolean
npmレジストリにアクセスする際、GETリクエスト時も含め、認証を強制します。
browser
既定値: "open" (OS X), "google-chrome" (その他)
属性型: String
npm docsを実行しウェブサイトを開く際のブラウザを指定します。
ca
既定値: npm のCA証明書
属性型: String or null
レジストリへのSSL接続において信頼される、CA署名証明書を指定します。nullを指定すると既知のレジストラのみ許可され、特定のCA証明書を指定した場合に特定の署名権限での信頼します。strict-ssl属性も参照してください。
cache
既定値: %APPDATA%\npm-cache (Windows), ~/.npm (Posix)
属性型: path
npmのキャッシュディレクトリを指定します。manドキュメントのcache(1)を参照してください。
cache-lock-stale
既定値: 60000 (1分)
属性型: Number
キャッシュのロックファイルの期限切れとみなす時間をミリ秒単位で指定します。
cache-lock-retries
既定値: 10
属性型: Number
キャッシュのロックファイルにおいて、ロックを獲得するために再試行する回数を指定します。
cache-lock-wait
既定値: 10000 (10秒)
属性型: Number
キャッシュのロックファイルの待機時間の期限をミリ秒単位で指定します。
cache-max
既定値: Infinity
属性型: Number
レジストリキャッシュ内の項目を再チェックするまでの最大時間を秒単位で指定します。キャッシュはGETリクエストのみで使用され、npm cache cleanコマンドを明示的に使用しない限り、削除はされ無いことに注意してください。
cache-min
既定値: 0
属性型: Number
レジストリキャッシュ内の項目を再チェックするまでの最小時間を秒単位で指定します。キャッシュはGETリクエストのみで使用され、npm cache cleanコマンドを明示的に使用しない限り、削除はされ無いことに注意してください。
color
既定値: true (Posix)、false (Windows)
属性型: Boolean or "always"
false の時、色は無くなり、"always"の時は、常に色付きになります。trueのときはttyファイル記述子への出力の時だけ色付きになります。
coverage
既定値: false
属性型: Boolean
テストハーネスに対しnpm_config_coverage環境変数に応答する場合に、coverageオプション有効として実行させます。
depth
既定値: Infinity
属性型: Number
npm ls と npm cache ls のディレクトリの再帰探索を行う深さを指定します.
description
既定値: true
属性型: Boolean
npm searchにおいて、説明(description)を表示します。
dev
既定値: false
属性型: Boolean
開発版依存パッケージ (dev-dependencies) をインストールします。dev-dependenciesはnpatが設定されている場合もインストールされます。
editor
既定値: 環境変数 EDITOR の値、または "vi" (Posix) または "notepad" (Windows)
属性型: path
npm edit、または npm config edit の時に実行されるコマンドを指定します。
engine-strict
既定値: false
属性型: Boolean
trueの時、 npm は現在のNode.js のバージョンと互換性が無いパッケージのインストールを、強く拒否 (または熟考) します。
force
既定値: false
属性型: Boolean
種々のコマンドをより強制的に行います。ライフサイクルスクリプトが失敗した場合でも、動作を止めません。公開の際は以前のバージョンを上書きします。レジストリへのリクエストはキャッシュを使いません。npm以外のファイルに対する上書き確認も行いません。
fetch-retries
既定値: 2
属性型: Number
npmレジストリからの取得に使用されるリトライモジュールの "retries" の設定。
fetch-retry-factor
既定値: 10
属性型: Number
npmレジストリからの取得に使用されるリトライモジュールの "factor" の設定。
fetch-retry-mintimeout
既定値: 10000 (10秒)
属性型: Number
npmレジストリからの取得に使用されるリトライモジュールの "minTimeout" の設定。
fetch-retry-maxtimeout
既定値: 60000 (1分)
属性型: Number
npmレジストリからの取得に使用されるリトライモジュールの "maxTimeout" の設定。
git
既定値: "git"
属性型: String
gitコマンドとして使用されるコマンドを指定します。gitがインストールされているが、PATHにない場合に、gitバイナリのフルパスを指定してください。
global
既定値: false
属性型: Boolean
"global"モードとして実行します。パッケージは作業ディレクトリの代わりに、プレフィックスディレクトリにインストールされます。動作の違いについての詳細はnpmのmanのfolders(1) を参照してください。作業ディレクトリの代わりに、プレフィックスディレクトリを基準として、パッケージは./node_modulesにインストールされ、binファイル群は./binへ、man-pagesは./share/manにリンクされます。
globalconfig
既定値: {prefix}/etc/npmrc
属性型: path
グローバル設定ファイルとして読み込むファイルを指定します。
globalignorefile
既定値: {prefix}/etc/npmignore
属性型: path
全ユーザーとプロジェクトに適用されるグローバルignoreパターンファイルを指定します。同一ディレクトリにgitignoreが存在し、パターンファイルが存在しない場合、代わりにgitignoreが使用されます。
group
既定値: 現在のプロセスのGID
属性型: String または Number
パッケージスクリプトを実行する際に使用されるグループを指定します。グローバルモードではrootになります。
https-proxy
既定値: 環境変数 (HTTPS_PROXY、https_proxy、HTTP_PROXY、http_proxy)
属性型: url
外向きのhttpsリクエストへ使用するプロキシサーバーを指定します。
user-agent
既定値: npm/{npm.version} node/{process.version}
属性型: String
リクエストヘッダのUser-Agentを指定します。
ignore
既定値: ""
属性型: string
tarアーカイブをビルドする際に、パッケージから常に除外するファイルを、空白区切りのglobパターンのリストとして指定します。
init-module
既定値: ~/.npm-init.js
属性型: path
npm initコマンドで読み込まれるモジュールを指定します。init-package-jsonモジュールのドキュメントか、npmのmanのinit(1)を参照してください。
init.version
既定値: "0.0.0"
属性型: semver
npm initの際に使用される、パッケージバージョンの既定値を指定します。
init.author.name
既定値: ""
属性型: String
npm initの際に使用される、パッケージ作者の名称の既定値を指定します。
init.author.email
既定値: ""
属性型: String
npm initの際に使用される、パッケージ作者の電子メールアドレスの既定値を指定します。
init.author.url
既定値: ""
属性型: String
npm initの際に使用される、パッケージ作者のホームページアドレスの既定値を指定します。
json
既定値: false
属性型: Boolean
通常の出力の代わりに、json出力を行うかどうか指定します。この機能は現在試験的なもので、多くのコマンドでは出力データ構造はJSONとして実装されていないか、変更されません。現在は npm ls --json の出力のみ有効です。
link
既定値: false
属性型: Boolean
trueの時、グローバルインストールに適合するパッケージがあれば、ローカルインストールはそのリンクとなります。適合するパッケージがない場合は、グローバルインストールはローカルにインストールされるものと同一となります。
loglevel
既定値: "http"
属性型: String
"silent"、"win"、"error"、"warn"、"http"、"info"、"verbose"、"silly"のうちのどれかの値を指定します。報告されるログのレベルを指定します。無効な場合は全てのログが作業ディレクトリのnpm-debug.logに出力されます。設定値より高いレベルのログが表示されます。既定値は"http"で、これは http、warn、そしてerrorを出力します。
logstream
既定値: process.stderr
属性型: Stream
実行時にnpmlogモジュールに渡されるストリームを指定します。コマンドラインからは指定できません。プログラム上でnpmを使用する場合に限り、stderr以外のどこかにログを出力させたい場合に指定します。color属性がtrueで、ストリームがTTYの場合、色付きでの出力となります。
long
既定値: false
属性型: Boolean
npm lsでのより広範な情報を表示します。
message
既定値: "%s"
属性型: String
npm versionによって作成時に使用される、バージョンコミットのコミットメッセージを指定します。メッセージ内の全ての "%s" はバージョン番号に置き換えられます。
node-version
既定値: process.version
属性型: semver または false
パッケージの "engines" ハッシュのチェックに使用される node のバージョンを指定します。
npat
既定値: false
属性型: Boolean
インストールのテストを実行し、結果をnpaturlに報告します。
npaturl
既定値: 未実装
属性型: url
npat テストの結果の報告先を指定します。
onload-script
既定値: false
属性型: path
npmのロード時にrequireを介して読み込むnodeのモジュールを指定します。プログラム上からnpmを操作する場合に有用です。
optional
既定値: true
属性型: Boolean
optionalDependenciesハッシュ内のパッケージのインストールを試みます。これらのパッケージのインストールが失敗しても、インストールプロセス自体は中止されません。
parseable
既定値: false
属性型: Boolean
コマンドの標準出力の結果を、解析可能な形式にして出力します。
prefix
既定値: nodeのプロセス、installPrefix
属性型: path
グローバルなアイテムのインストール先を指定します。コマンドラインで指定された場合、指定ディレクトリでの非グローバルなコマンドとして強制的に実行されます。
production
既定値: false
属性型: Boolean
trueの時、"production"モードで実行します。ローカルな引数なしのnpm installを実行する場合、devDependenciesはtopmostレベルではインストールされません。ライフサイクルスクリプトは NODE_ENV="production" と設定してください。
proprietary-attribs
既定値: true
属性型: Boolean
npmによって作成されるtarアーカイブ内にプロプライエタリ拡張属性を含むかどうかを指定します。npmではなく別のプログラム (特に昔のtar実装) でのtarアーカイブの展開を想定している場合でなければ、trueにしておいてください。
proxy
既定値: 環境変数 HTTP_PROXY、http_proxy または null
属性型: url
外向きのhttpリクエストのためのプロキシを指定します。
rebuild-bundle
既定値: true
属性型: Boolean
インストール後にバンドルされた依存パッケージを再ビルドするかどうかを指定します。
registry
既定値: https://registry.npmjs.org/
属性型: url
npm パッケージレジストリの基準URLを指定します。
rollback
既定値: true
属性型: Boolean
失敗したインストールを削除するかどうか指定します。
save
既定値: false
属性型: Boolean
インストール済みパッケージを package.json ファイル内に dependencies として保存します。npm rmコマンド使用時には、dependenciesハッシュから削除されます。package.jsonファイルがある場合に限り動作します。
save-bundle
既定値: false
属性型: Boolean
インストール時に--save、--save-dev、または--save-optionalの使用によってパッケージが保存された場合、 bundleDependenciesリストにも設定されます。npm rmコマンドと共に使用された場合、bundledDependenciesリストから削除されます。
save-dev
既定値: false
属性型: Boolean
インストール済みパッケージを package.json ファイル内に devDependencies として保存します。npm rmコマンド使用時には、devDependencies ハッシュから削除されます。package.jsonファイルがある場合に限り動作します。
save-optional
既定値: false
属性型: Boolean
インストール済みパッケージを package.json ファイル内に optionalDependencies として保存します。npm rmコマンド使用時には、optionalDependencies ハッシュから削除されます。package.jsonファイルがある場合に限り動作します。
searchopts
既定値: ""
属性型: String
searchの際に常に使用される、空白区切りのオプション群を指定します。
searchexclude
既定値: ""
属性型: String
searchの結果を限定するための、空白区切りのオプション群を指定します。
searchsort
既定値: "name"
属性型: String
"name", "-name", "date", "-date", "description", "-description", "keywords", "-keywords"のうち、いずれかの値を指定します。検索結果の表示でソートを行うフィールドを指定します。接頭に'-'文字があるものは逆順になります。
shell
既定値: 環境変数SHELL、または "bash" (Posix)、または "cmd" (Windows)
属性型: path
npm exploreコマンドの際に実行されるシェルを指定します。
sign-git-tag
既定値: false
属性型: Boolean
trueの時、npm versionコマンドは-sを使用した署名付きのバージョンのタグを行います。この機能を適切に動作させるためには、事前にGPGキーをgitに設定しておく必要があります。
strict-ssl
既定値: true
属性型: Boolean
httpsを介したレジストリへのリクエストにおいて、SSL鍵のバリデーションを行うかどうかを指定します。ca configも参照してください。
tag
既定値: latest
属性型: String
npmに対しパッケージインストールを指定せず、またバージョンを指定しない場合、指定のタグをインストールします。明示的なタグが無い場合、npm tagコマンドで指定された package@version が追加されます。
tmp
既定値: 環境変数 TMPDIR、または "/tmp"
属性型: path
一時ファイルの保存先を指定します。全ての一時ファイルは成功時に削除されますが、失敗時は証拠目的として残されます。
unicode
既定値: true
属性型: Boolean
trueの時、npmはツリー出力の際にUnicode文字を使用します。falseの時、ツリーの描画にASCII文字を使用します。
unsafe-perm
既定値: rootとして実行すつ場合にfalse、その他の場合true
属性型: Boolean
trueの時、パッケージスクリプトの実行時のUID/GID切り替えを抑制します。明示的にfalseが指定された場合、root以外でのインストールは失敗します。
usage
既定値: false
属性型: Boolean
help (1) を実行した際、全体のヘルプを出力する代わりに、-H 出力のような短い使用法を出力します。
user
既定値: "nobody"
属性型: String または Number
rootとしてパッケージスクリプトを実行した場合のUIDを指定します。
username
既定値: null
属性型: String
npmレジストリのユーザー名を指定します。npm adduserと共に使用してください。
userconfig
既定値: ~/.npmrc
属性型: path
ユーザーレベル設定ファイルのパスを指定します。
userignorefile
既定値: ~/.npmignore
属性型: path
全パッケージに適用される、ユーザーレベルignoreファイルのパスを指定します。同一ディレクトリに.gitignoreが存在し、ignoreファイルが存在しない場合、代わりに.gitignoreが使用されます。
umask
既定値: 022
属性型: 8進数の数値文字列
ファイル、フォルダに対する作成時のモードを"umask"値として指定します。フォルダと実行ファイルは値に対し、0777のマスクが適用されます。その他のファイルは、値に対し、0666のマスクが適用されます。したがって、既定値はそれぞれ 0755 と 0644 となります。
version
既定値: false
属性型: boolean
trueの時、npmのバージョンを出力して正常終了します。コマンドラインでの明示的な指定を行ってください。
versions
既定値: false
属性型: boolean
trueの時、npmのバージョンを node のprocess.versionsハッシュのように出力し、正常終了します。コマンドラインでの明示的な指定を行ってください。
viewer
既定値: "man" (Posix), "browser" (Windows)
属性型: path
ヘルプの内容を表示するプログラムを指定します。"browser"を指定すると既定のブラウザでHTMLのヘルプを表示します。
yes
既定値: null
属性型: Boolean または null
nullの時、ユーザーに確認応答を行う場合があります。そのような応答において、trueの時は全て"yes"、falseの時は全て"no"と答えます。