Module resolution for gulpfile.ts directory

[tonyhallett]

The docs describe module resolution to a folder named gulpfile.js. Somewhere there should be a mention that this will not work with a folder gulpfile.ts when using gulp-typescript even if it is a given that node module resolution works the same here.

[demurgos]

• For TypeScript, rename to gulpfile.ts and install the ts-node module.

You need ts-node, not gulp-typescript if you want your config file to be written in TS. gulp-typescript is to use gulp to compile TS files from your lib, not the gulpfile itself.

[tonyhallett]

Sorry, that is what I meant. The suggestion to add to the docs remains

[phated]

@tonyhallett how would you phrase that? I believe it would have to go in the "splitting a gulpfile" section and say something like:

If you want to have transpilation support with this strategy, you'll need to name the index.js file to index.ts but keep gulpfile.js as the name of the directory.

That seems a little rough but does it cover the problem you encountered? Also, does my solution actually work? It's abusing a lot of implied behaviors and I don't know how they interact together.

[tonyhallett]

@phated I have just re-read the the docs page that I linked to. It does state 'You can write a gulpfile using a language that requires transpilation, like TypeScript or Babel, by changing the extension on your gulpfile.js to indicate the language and install the matching transpiler module.' Perhaps it should have been a bit clearer that gulpfile.js was not necessarily a file and applied to folders.

I will create a pull request with my suggested changes.