From 681e36d41722891d270abf6fec0aba094ccbd7d9 Mon Sep 17 00:00:00 2001 From: Tony Hallett Date: Wed, 27 Mar 2019 19:33:02 +0000 Subject: [PATCH] To be more explicit regarding transpilation closes #2311 --- docs/getting-started/2-javascript-and-gulpfiles.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/2-javascript-and-gulpfiles.md b/docs/getting-started/2-javascript-and-gulpfiles.md index 6ccc8161a..aaf1bbeda 100644 --- a/docs/getting-started/2-javascript-and-gulpfiles.md +++ b/docs/getting-started/2-javascript-and-gulpfiles.md @@ -15,7 +15,7 @@ A gulpfile is a file in your project directory titled `gulpfile.js` (or capitali ## Transpilation -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. +You can write a gulpfile using a language that requires transpilation, like TypeScript or Babel, by changing the extension on your `gulpfile.js` file or folder ( see Splitting a gulpfile ) to indicate the language and install the matching transpiler module. * For TypeScript, rename to `gulpfile.ts` and install the [ts-node][ts-node-module] module. * For Babel, rename to `gulpfile.babel.js` and install the [@babel/register][babel-register-module] module. @@ -28,7 +28,7 @@ Many users start by adding all logic to a gulpfile. If it ever grows too big, it Each task can be split into its own file, then imported into your gulpfile for composition. Not only does this keep things organized, but it allows you to test each task independently or vary composition based on conditions. -Node's module resolution allows you to replace your `gulpfile.js` file with a directory named `gulpfile.js` that contains an `index.js` file which is treated as a `gulpfile.js`. This directory could then contain your individual modules for tasks. +Node's module resolution allows you to replace your `gulpfile.js` file with a directory named `gulpfile.js` that contains an `index.js` file which is treated as a `gulpfile.js`. This directory could then contain your individual modules for tasks. If you are using a transpiler then name the folder and file accordingly. [gulpfile-transpilation-advanced]: ../documentation-missing.md [ts-node-module]: https://www.npmjs.com/package/ts-node