Tweaks to the gulpfile and nightly build (#85)

- Include README in the package
- Adds message to README for nightly
- Tweak grammar

Author: roblourens

README.nightly.md

@@ -0,0 +1 @@
+> **This is a nightly version of this extension for early feedback and testing. This extension works best with [VS Code Insiders](https://code.visualstudio.com/insiders)**

gulpfile.js

@@ -108,6 +108,14 @@ gulp.task('compile:ts', () =>
     .pipe(gulp.dest(buildSrcDir)),
 );
 
+async function fixNightlyReadme() {
+  const readmePath = `${buildDir}/README.md`;
+  const readmeText = await readFile(readmePath);
+  const readmeNightlyText = await readFile(`README.nightly.md`);
+
+  await writeFile(readmePath, readmeNightlyText + '\n' + readmeText);
+}
+
 gulp.task('compile:dynamic', async () => {
   const [contributions, strings] = await Promise.all([
     runBuildScript('generate-contributions'),
@@ -119,8 +127,10 @@ gulp.task('compile:dynamic', async () => {
   if (isNightly) {
     const date = new Date();
     const monthMinutes = (date.getDate() - 1) * 24 * 60 + date.getHours() * 60 + date.getMinutes();
-    packageJson.displayName += ' Nightly';
+    packageJson.displayName += ' (Nightly)';
     packageJson.version = `${date.getFullYear()}.${date.getMonth() + 1}.${monthMinutes}`;
+
+    await fixNightlyReadme();
   }
 
   Object.assign(packageJson.contributes, contributions);
@@ -134,7 +144,7 @@ gulp.task('compile:dynamic', async () => {
 gulp.task('compile:static', () =>
   merge(
     gulp.src(['LICENSE', 'package.json']).pipe(replaceNamespace()),
-    gulp.src('resources/**/*', { base: '.' }),
+    gulp.src(['resources/**/*', 'README.md'], { base: '.' }),
   ).pipe(gulp.dest(buildDir)),
 );
 
@@ -188,7 +198,7 @@ gulp.task('package:webpack-bundle', async () => {
 /** Copy the extension static files */
 gulp.task('package:copy-extension-files', () =>
   merge(
-    gulp.src([`${buildDir}/LICENSE`, `${buildDir}/package.json`, `${buildDir}/resources/**/*`], {
+    gulp.src([`${buildDir}/LICENSE`, `${buildDir}/package.json`, `${buildDir}/resources/**/*`, `${buildDir}/README.md`], {
       base: buildDir,
     }),
     gulp.src(`${buildDir}/src/**/*.sh`).pipe(rename({ dirname: 'src' })),

package.json

@@ -1,12 +1,12 @@
 {
   "name": "js-debug",
-  "displayName": "VSCode JavaScript Debugger",
+  "displayName": "VS Code JavaScript Debugger",
   "version": "0.9.0",
   "publisher": "ms-vscode",
   "author": {
     "name": "Microsoft Corporation"
   },
-  "description": "An extension for debugger Node.js programs and Chrome.",
+  "description": "An extension for debugging Node.js programs and Chrome.",
   "license": "MIT",
   "engines": {
     "vscode": "^1.30.0-insider",