Getting Started Improvements Needed

[jeremy-farrance]

Note: I am doing this in VS Code not Visual Studio.

On a clean machine with not much installed beyond VS Code setup with my short-list of required extensions, I wanted to kick the tired on nvQT-Tw. Hopefully these problems and solutions can be turned in to improved defaults or config changes so other avoid these "speed bumps."

For David P, here is a link to our Slack convo in case there is a detail or context there that I left out.

First bump:

After running npm install, trying gulp (or gulp build) simply results in gulp: The term 'gulp' is not recognized as...

To fix this either:

• install gulp-cli globally, npm install -g gulp-cli
• add to package.json, "gulp-cli": "^2.3.0", (and re-run npm install)

The gulp@4 docs seem to recommend installing gulp-cli globally. So since its really not a dev dependency, maybe just include setup requirements, have the user verify both Gulp and Gulp-CLI are installed by typing > gulp --v

Second bump

Then running gulp build results in:

[12:07:53] Requiring external module ts-node/register
Error: Cannot find module 'jshint/src/cli'

Checked docs on gulp-jshint@2 and it does say the install is now, npm install jshint gulp-jshint --save-dev - so you just need to add "jshint": "^2.13.4", to package.json.

Other

Also, I have a suggestion, a lot of folks (like me) expect to type npm run build and npm run watch - so maybe update package.json:

  "scripts": {
    "build": "gulp build",
    "package": "gulp packageTheme"
  },

Further, if you want to completely avoid the Gulp-CLI thing, add a "preinstall" script like this:

  "scripts": {
    "build": "gulp build",
    "watch": "",
    "package": "gulp packageTheme",
    "preinstall": "npm install -g gulp-cli"
  },

Then Gulp-CLI gets installed (or updated) globally during npm install.

You can check out my fork here, https://github.com/jeremy-farrance/nvQuickTheme-Tailwind

[jeremy-farrance]

Didn't realize fixing it in my fork and mentioning the issue would close it. So, reopening.

[david-poindexter]

Thank you for documenting this @jeremy-farrance!