npmエラーzsh: command not found: gulpの対処法

Question

現在下記サイトを参考にGulp、Sassの学習を行なっております。
Gulp で SCSS のコンパイルから bourbon の導入までを試す - Gulp で作る Web フロントエンド開発環境 #1

// package.json
{
  "name": "psyence_media",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "coffee-script": "^1.12.7",
    "gulp": "^3.9.1",
    "gulp-sass": "^3.1.0"
  }
}

gulpダウンロードもうまくいっているはずなのですが、gulp scssやgulp -vなどとやってもzsh: command not found: gulpと返されてしまいます。

ディレクトリ配下キャプチャ

PATHが通っているかの確認

検索しているとPATHが通っていない問題の可能性ともあったので.bash_profile、.bashrc両方にそれらしきPATHも追加してみました。

# =========== .bashrc ===========
git_branch(){
	echo $(git branch --no-color 2>/dev/null | sed -ne "s/^* (.*)$/\1/p")
}
PS1='[\033[36m]\w[\033[0m]:[\033[35m]$(git_branch)[\033[0m]$'

#macportsの設定
export path=/opt/local/bin:/opt/local/sbin:$path
export manpath=/opt/local/man:$manpath
export PATH=/Users/ユーザー名/npm/bin:$PATH # 追加

# =========== .bash_profile ===========
if [ "$TERM_PROGRAM" = "Apple_Terminal" ]; then

    if [ -f ~/.bashrc ]; then
        source ~/.bashrc
    fi
fi

if [-f ~/.bashrc];
  then source ~/.bashrc
fi

#VScode PATHの設定
code () { VSCODE_CWD="$PWD" open -n -b "com.microsoft.VSCode" --args $* ;}

export PATH="/opt/local/bin:/opt/local/sbin:$PATH"
export PATH=/Users/ユーザー名/npm/bin:$PATH # 追加

他に考えられる原因がありましたら教えていただけますと助かります。
よろしくお願いいたします。

質問追記 1/9

$ ls node_modules/.bin | grep gulp
gulp // <- 追加されてる事を確認

$ npm bin
/Users/ユーザー名/Google ドライブ/MyPractice/Gulp/PSYENCE_MEDIA/node_modules/.bin

$ npm install -D gulp
gulpインストール後、下記キャプチャのようになる

$  npm run gulp --version
5.4.2

$ npm run gulp --tasks
npm ERR! missing script: gulp

npm ERR! A complete log of this run can be found in:
npm ERR! 

• npm binをはじめにすればgulpのグローバルインストールの必要がなくなるという解釈で大丈夫でしょうか？
• 手順の通りに進めたつもりではいるのですが、以前としてnot foundのままです。
• "scripts": { ... }はインストールするとpackage.jsonに自動的に記述するのでしょうか？それとも自身でベタ書きでしょうか？

まだまだ理解不足の中での質問で恐縮ですがよろしくお願いします。

質問追記 1/10

npm run gulpのところでエラーを吐かれてしまいます。
この場合どこを修正すればよろしいでしょうか？

# バージョン確認 → npm run gulpの実行結果です

[PSYENCE_MEDIA] npm run gulp --version                                                                                          13:21:09
5.4.2
[PSYENCE_MEDIA] npm run gulp                                                                                                    13:19:29

> psyence_media@1.0.0 gulp /Users/ユーザー名/Google ドライブ/MyPractice/Gulp/PSYENCE_MEDIA
> gulp

[13:20:58] Failed to load external module coffeescript/register
[13:20:58] Requiring external module coffee-script/register
[13:20:58] Using gulpfile ~/Google ドライブ/MyPractice/Gulp/PSYENCE_MEDIA/gulpfile.coffee
[13:20:58] Task 'default' is not in your gulpfile
[13:20:58] Please check the documentation for proper gulpfile formatting
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! psyence_media@1.0.0 gulp: `gulp`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the psyence_media@1.0.0 gulp script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/ユーザー名/.npm/_logs/2018-01-10T04_20_58_200Z-debug.log
[PSYENCE_MEDIA]        

上記エラーキャプチャ

質問追記 1/13

ご返事が遅くなり申し訳ありません。
メモも兼ねて記載させてください。

#gulpfile.coffee
gulp = require 'gulp'
sass = require 'gulp-sass'

gulp.task 'scss', ->
  gulp.src './src/scss/**/*.scss'
    .pipe sass()
    .pipe gulp.dest('./dest/assets/css')

エラー文、Task 'default' is not in your gulpfile、defaultで設定されているものがないためエラーということでしょうか。
その場合だと、今回はgulpfile.coffeeファイルに対してgulp.task 'scss'タスクを設定しています。
今回の場合だとgulp scssで実行するはずだと思いましたがzsh: command not found: gulpとなります。
となるとやはりPATHの問題だと思うのですが、含まれていれば安心というアドバイスなので、npmのPATHを追加するやり方について調べようと思います。

$ npm bin -g
/usr/local/bin

$ echo $PATH
/usr/local/bin:/usr/local/sbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/sbin

質問追記 1/23

{
  "name": "psyence_media",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "gulp": "gulp"  # ご指摘いただいた追加の箇所
  },
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "coffee-script": "^1.12.7",
    "gulp": "^3.9.1",
    "gulp-sass": "^3.1.0"
  }
}

Answer 1

どのようにgulpパッケージを導入しましたか？
npm install --save-dev gulpだと思うのですが合ってますか？

何故聞いたのかというと、超重要だからです。

---

【追記部分】CLIの操作とパスに関して

一旦レベルを落としましょう。
今回の質問はgulpというコマンドが認識されない、認識して欲しいが要件ですからね。
どうなれば条件達成なのかを知るという意味で軽くおさらいしましょう。

ターミナルに打ち込まれたコマンドは誰がどういう順番で解析して、
何が実行されているか確認したことはありますか？

それを紐解く為には環境変数のPATHの理解が必要となります。
まずは貴方のパソコン内の環境変数のPATHを表示してみてください。

• Windows 環境変数 Path の設定方法
• PATHを通すために環境変数の設定を理解する (Mac OS X)

# Windows の場合
$ path
C:\Windows;C:\Windows\System32;....

# MacOS / Linux の場合
$ echo $PATH
/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:...

Windows, MacOS, Linuxなどなど…多少の差異はありますが概ねこんな感じです。
Windowsの場合は;が区切り文字、MacOSやLinuxでは:が区切り文字として扱われます。

コマンドラインで何かしらのコマンドが実行された場合、
この環境変数PATHの文字列の左から順にコマンドあるかな？…と探しにいき、
そのフォルダの配下に実行ファイルがあればそれを使って実行…という流れになっています。

環境変数PATHで記されたいくつかのディレクトリがありますが、
その中の直下にgulpというファイルがなければ
「gulp？そんなコマンドねーよ」というエラーが帰ってきます。

---

【追記部分】npmのグローバルインストールと環境変数PATH

npmのインストールには2つの概念があります。

• グローバル
• ローカル(package.jsonと同階層≒プロジェクトルート)

まずはグローバル領域に関する事をみていきましょう。
npmのグローバル領域はnpm bin -gコマンドで確認することができます。
npm install -g gulp等のコマンドのように-gオプションを付けて実行すると、
npm bin -gで表示されるパスに実行ファイルが設置されます。

ですが、そのnpm bin -gは環境変数のPATHに入っていますか？
本当に？実際に下記2つのコマンドを実行して確認してみてください。

$ npm bin -g
$ echo $PATH

含まれていれば一安心。
含まれていなければ上記の環境変数に関しての記事を閲覧してください。

恐らく質問文の状況はnpm install --save-dev gulpなので、
npm bin -gで表示されるパスには含まれていないと思います。
下記コマンドを実行して追加される事を確認してみてください。

$ ls $(npm bin -g)
// gulp ファイルはありますか？

$ npm install -g gulp

$ ls $(npm bin -g)
gulp

$ gulp --version
5.5.1

---

【プチ加筆】応用編、ローカルを上手く使う

貴方がデザイナー的な立場の人間でNode.jsとかもう使わんし！
…というのであれば前項まで行えば使える様になっているはずです。

ブログやQiitaの記事等を見ればnpm install --save-dev gulpを推奨している記事がありますね。
これを利用すると、package.jsonが存在するディレクトリと同階層にnode_modules/.binというフォルダを作成して、その中にgulpの実行ファイルを投げ込みます。

あれ、ちょっとまって。
環境変数のPATHに通してないコマンドは認識しないってことは、
グローバルインストールしないとgulpコマンド使えないんじゃないの？
意味なくね？

実は開発者用インストールには抜け道があります。
npm で依存もタスクも一元化する

$ npm bin
ぷろじぇくとるーと/node_modules/.bin

$ ls $(npm bin)
// <- gulpファイルはない

$ npm install -D gulp

$ ls 
gulp // <- 追加されてる事を確認

$ $(npm bin)/gulp --version
5.5.1

どのOSでもそうですが、実は環境変数PATHに入っていないプログラムも、
/や./等のディレクトリを指定する文字列から始まるコマンドは、実行ファイルを見つけて直接実行する仕様だからです。

なので、package.jsonが入っているディレクトリの中で
./node_modules/.bin/gulpや$(npm bin)/gulpなどと入力して直接実行ファイルを叩けば実行出来るわけです。

しかしこれではまだ不便ですね。
こんな長ったらしいコマンド毎回打ってられないぞ…なんとかならんか？

---

【加筆修正】応用編、ローカルインストールとnpm-scriptsと併用する

更にpackage.jsonのscriptsからの起動(所謂npm-scripts)を利用した場合、
環境変数のPATHにnpm binが足された状態で起動します。

package.json (の内のscripts内の項目)

"scripts": {
  "gulp": "gulp"
}

なんじゃこのやる気のないnpm-scriptsは？
いやいや、色々出来て便利なんですこれ。
では下記の通りにコマンドを打ち込んでみましょう。

$ ls $(npm bin)
gulp // <- gulpの実行ファイルが存在することを確認

$ npm run gulp --version
5.5.1 // npm-scriptsによって`gulp`コマンドが発火、パスも通ってる！

$ npm run gulp --tasks
// 登録されているタスクの一覧も見れる！

$ npm run gulp build
// ビルド処理がちゃんと動いた！

より実践的には開発者が使いそうなコマンドは別途用意しておいても良いでしょう。

"scripts": {
  "gulp": "gulp",
  "build": "gulp build",
  "watch": "gulp watch"
}

Comments

[roronoazoro]

ご回答ありがとうございます。理解不足の中での質問となり申し訳ありませんが、本文に質問追記しましたのでよろしくお願いいたします。

[roronoazoro]

回答し忘れていましたが、ご指摘の通りnpm install --save-dev gulpとしてインストールしておりました。

[miyabi-sun]

そもそもパソコンがコマンドをどのように実行するか、
これに着目して過不足ないように追記しましたので、少し長くなりました。

`npm root -g`や`npm bin`はパスを表示するだけしかしてくれない、確認用コマンドです。
確認 -> どうすればいいかの順番で解説しています。

[miyabi-sun]

シンプルな解決方法だけ記載すると、
`npm install --save-dev gulp`なので、`ぷろじぇくとるーと/node_modules/.bin`に入っているはずです。
package.jsonのscripts項目に{"gulp": "gulp"}を追加した上で、
`npm run gulp --version`等という風に`npm run gulp`をワンセットで入力すればgulpコマンドを扱えるようになるはずです。

回答文には何故それで上手くいくのかを記載していますので、疑問に思ったら参照してみてください。

[roronoazoro]

詳細なご回答感謝いたします。追って理解していきたいと思います。また、シンプルな解決法のnpm run gulpのところでエラーを吐かれてしまいます。正直エラー文を見てもどこを修正すればいいのか分かりません。たびたび恐縮ですがアドバイスのほどよろしくお願いいたします。再度本文の方へ追記いたしました。

[miyabi-sun]

> 質問追記 1/10
これに関してはエラー文読めが正解ですよ。
gulpはタスクランナーであり、「gulp build」等という風にコマンドの引数に対象のタスクを指定して実行させます。
そうするとgulpfile.jsを読み取って`gulp.task('build', function(){})`の中身を実行し始めます。

では、「gulp」単体で実行したら？
コマンドライン引数が無い。つまり第一引数で指定されているタスクが存在しない事になります。
デフォルトの挙動はどうなると思いますか？
その正解はエラー文にバッチリ記載されています、頑張って読んでみてください。