Merge branch 'master' into extract_vt_features

bin/install-addons.js

@@ -0,0 +1,56 @@
+/**
+ * Copyright (c) 2019 The xterm.js authors. All rights reserved.
+ * @license MIT
+ *
+ * Script to initialize addon packages under "addons/" with outer deps.
+ */
+
+const path = require('path');
+const cp = require('child_process');
+const fs = require('fs');
+
+const PACKAGE_ROOT = path.join(__dirname, '..');
+
+// install addon deps
+const addonsPath = path.join(PACKAGE_ROOT, 'addons');
+if (fs.existsSync(addonsPath)) {
+  console.log('pulling addon dependencies...');
+
+  // whether to use yarn or npm
+  let hasYarn = false;
+  try {
+    cp.execSync('yarn --version').toString();
+    hasYarn = true;
+  } catch(e) {}
+
+  // walk all addon folders
+  fs.readdir(addonsPath, (err, files) => {
+    files.forEach(folder => {
+      const addonPath = path.join(addonsPath, folder);
+
+      // install only if there are dependencies listed
+      let packageJson;
+      try {
+        packageJson = require(path.join(addonPath, 'package.json'));
+      } catch (e) {
+        // swallow as changing branches can leave folders around
+      }
+      if (packageJson
+            && (
+              (packageJson.devDependencies && Object.keys(packageJson.devDependencies).length)
+              || (packageJson.dependencies && Object.keys(packageJson.dependencies).length)
+            )
+          )
+      {
+        console.log('Preparing', folder);
+        if (hasYarn) {
+          cp.execSync('yarn', {cwd: addonPath});
+        } else {
+          cp.execSync('npm install', {cwd: addonPath});
+        }
+      } else {
+        console.log('Skipped', folder);
+      }
+    });
+  });
+}

bin/publish.js

@@ -5,6 +5,7 @@
 
 const cp = require('child_process');
 const fs = require('fs');
+const os = require('os');
 const path = require('path');
 
 // Setup auth
@@ -18,8 +19,9 @@ if (isDryRun) {
 const changedFiles = getChangedFilesInCommit('HEAD');
 
 // Publish xterm if any files were changed outside of the addons directory
+let isStableRelease = false;
 if (changedFiles.some(e => e.search(/^addons\//) === -1)) {
-  checkAndPublishPackage(path.resolve(__dirname, '..'));
+  isStableRelease = checkAndPublishPackage(path.resolve(__dirname, '..'));
 }
 
 // Publish addons if any files were changed inside of the addon
@@ -39,6 +41,11 @@ addonPackageDirs.forEach(p => {
   }
 });
 
+// Publish website if it's a stable release
+if (isStableRelease) {
+  updateWebsite();
+}
+
 function checkAndPublishPackage(packageDir) {
   const packageJson = require(path.join(packageDir, 'package.json'));
 
@@ -76,6 +83,8 @@ function checkAndPublishPackage(packageDir) {
   }
 
   console.groupEnd();
+
+  return isStableRelease;
 }
 
 function getNextBetaVersion(packageJson) {
@@ -88,7 +97,7 @@ function getNextBetaVersion(packageJson) {
   const nextStableVersion = `${stableVersion[0]}.${parseInt(stableVersion[1]) + 1}.0`;
   const publishedVersions = getPublishedVersions(packageJson, nextStableVersion, tag);
   if (publishedVersions.length === 0) {
-    return `${nextStableVersion}-${tag}1`;
+    return `${nextStableVersion}-${tag}.1`;
   }
   const latestPublishedVersion = publishedVersions.sort((a, b) => {
     const aVersion = parseInt(a.substr(a.search(/[0-9]+$/)));
@@ -96,14 +105,14 @@ function getNextBetaVersion(packageJson) {
     return aVersion > bVersion ? -1 : 1;
   })[0];
   const latestTagVersion = parseInt(latestPublishedVersion.substr(latestPublishedVersion.search(/[0-9]+$/)), 10);
-  return `${nextStableVersion}-${tag}${latestTagVersion + 1}`;
+  return `${nextStableVersion}-${tag}.${latestTagVersion + 1}`;
 }
 
 function getPublishedVersions(packageJson, version, tag) {
   const versionsProcess = cp.spawnSync('npm', ['view', packageJson.name, 'versions', '--json']);
   const versionsJson = JSON.parse(versionsProcess.stdout);
   if (tag) {
-    return versionsJson.filter(v => !v.search(new RegExp(`${version}-${tag}[0-9]+`)));
+    return versionsJson.filter(v => !v.search(new RegExp(`${version}-${tag}.[0-9]+`)));
   }
   return versionsJson;
 }
@@ -115,3 +124,12 @@ function getChangedFilesInCommit(commit) {
   const changedFiles = output.split('\n').filter(e => e.length > 0);
   return changedFiles;
 }
+
+function updateWebsite() {
+  console.log('Updating website');
+  const cwd = fs.mkdtempSync(path.join(os.tmpdir(), 'website-'));
+  const packageJson = require(path.join(path.resolve(__dirname, '..'), 'package.json'));
+  if (!isDryRun) {
+    cp.spawnSync('sh', [path.join(__dirname, 'update-website.sh'), packageJson.version], { cwd, stdio: [process.stdin, process.stdout, process.stderr] });
+  }
+}

bin/test.js

@@ -6,6 +6,8 @@
 const cp = require('child_process');
 const path = require('path');
 
+const COVERAGE_LINES_THRESHOLD = 60;
+
 // Add `out` to the NODE_PATH so absolute paths can be resolved.
 const env = { ...process.env };
 env.NODE_PATH = path.resolve(__dirname, '../out');
@@ -15,15 +17,42 @@ let testFiles = [
   './out/**/*test.js'
 ];
 
-// ability to inject particular test files via
-// yarn test [testFileA testFileB ...]
+let flagArgs = [];
+
 if (process.argv.length > 2) {
-  testFiles = process.argv.slice(2);
+  const args = process.argv.slice(2);
+  flagArgs = args.filter(e => e.startsWith('--'));
+  // ability to inject particular test files via
+  // yarn test [testFileA testFileB ...]
+  files = args.filter(e => !e.startsWith('--'));
+  if (files.length) {
+    testFiles = files;
+  }
+}
+
+const checkCoverage = flagArgs.indexOf('--coverage') >= 0;
+
+if (checkCoverage) {
+  flagArgs.splice(flagArgs.indexOf('--coverage'), 1);
+  const executable = npmBinScript('nyc');
+  const args = ['--check-coverage', `--lines=${COVERAGE_LINES_THRESHOLD}`, npmBinScript('mocha'), ...testFiles, ...flagArgs];
+  console.info('executable', executable);
+  console.info('args', args);
+  const run = cp.spawnSync(
+    executable,
+    args,
+    {
+      cwd: path.resolve(__dirname, '..'),
+      env,
+      stdio: 'inherit'
+    }
+  );
+  process.exit(run.status);
 }
 
 const run = cp.spawnSync(
-  path.resolve(__dirname, '../node_modules/.bin/mocha'),
-  testFiles,
+  npmBinScript('mocha'),
+  [...testFiles, ...flagArgs],
   {
     cwd: path.resolve(__dirname, '..'),
     env,
@@ -31,4 +60,8 @@ const run = cp.spawnSync(
   }
 );
 
-process.exit(run.status);
+function npmBinScript(script) {
+  return path.resolve(__dirname, `../node_modules/.bin/` + (process.platform === 'win32' ? `${script}.cmd` : script));
+}
+
+process.exit(run.status);

bin/update-website.sh

@@ -0,0 +1,41 @@
+#!/bin/sh
+
+# Name the arguments
+VERSION=$1
+
+# Clone docs repo and update the documentation
+git clone https://github.com/xtermjs/xtermjs.org
+cd xtermjs.org
+yarn
+./bin/update-docs
+
+# Add changes to index and only proceed if there are changes to commit
+touch test-file
+git add .
+if ! git diff-index --quiet HEAD --; then
+
+  # Delete the upstream branch if it exists for some reason
+  export BRANCH_NAME=update-$VERSION
+  git branch -D $BRANCH_NAME || true
+  git push origin :$BRANCH_NAME || true
+
+  # Create commit and push it to update-x.y.z
+  git checkout -b $BRANCH_NAME
+  git config --global user.name Daniel Imms
+  git config --global user.email tyriar@tyriar.com
+  git commit -m 'Update docs for v$VERSION'
+  git push --set-upstream origin update-4.2.0
+  git push -f
+
+  # Create a PR in the GitHub repo
+  curl \
+    -H "Authorization: token $GITHUB_TOKEN" \
+    -X POST \
+    -d "{\"title\":\"Update docs for v$VERSION\",\"base\":\"master\",\"head\":\"xtermjs:$BRANCH_NAME\"}" \
+    https://api.github.com/repos/xtermjs/xtermjs.org/pulls
+
+else
+
+  echo "No changes to commit"
+
+fi