Merge pull request #351 from phovea/release-5.0.0

Christian Lehner · web-flow · commit 6b8ea8b30cad · 2020-03-18T07:48:31.000+01:00
Release 5.0.0
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# generator-phovea [![Phovea][phovea-image]][phovea-url] [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]
+# generator-phovea [![Phovea][phovea-image]][phovea-url] [![NPM version][npm-image]][npm-url]
 
 helper generator for phovea
 
@@ -51,7 +51,3 @@ This repository is part of **[Phovea](http://phovea.caleydo.org/)**, a platform
 [phovea-url]: https://phovea.caleydo.org
 [npm-image]: https://badge.fury.io/js/generator-phovea.svg
 [npm-url]: https://npmjs.org/package/generator-phovea
-[travis-image]: https://travis-ci.org/phovea/generator-phovea.svg?branch=master
-[travis-url]: https://travis-ci.org/phovea/generator-phovea
-[daviddm-image]: https://david-dm.org/phovea/generator-phovea.svg?theme=shields.io
-[daviddm-url]: https://david-dm.org/phovea/generator-phovea
diff --git a/generators/_init-hybrid/templates/package.tmpl.json b/generators/_init-hybrid/templates/package.tmpl.json
@@ -34,7 +34,7 @@
     "predist:web": "npm run build:web && npm run docs:web",
     "predist:python": "npm run build:python && npm run docs:python",
     "predist": "echo hybrid",
-    "dist:web": "mkdirp dist && cd build && tar cvzf ../dist/<%-name%>.tar.gz *",
+    "dist:web": "mkdir dist && cd build && tar cvzf ../dist/<%-name%>.tar.gz *",
     "dist:python": "python setup.py sdist bdist_wheel",
     "dist": "npm run dist:web && npm run dist:python"
   }
diff --git a/generators/_init-python/templates/plain/requirements_dev.txt b/generators/_init-python/templates/plain/requirements_dev.txt
@@ -1,6 +1,6 @@
-flake8==3.5.0
-pep8-naming==0.8.2
-pytest==3.5.0
-pytest-runner==4.2
-Sphinx==1.7.2
+flake8==3.7.9
+pep8-naming==0.9.1
+pytest==5.3.5
+pytest-runner==5.2
+Sphinx==2.4.2
 recommonmark==0.6.0
diff --git a/generators/_init-web/templates/package.tmpl.json b/generators/_init-web/templates/package.tmpl.json
@@ -28,7 +28,7 @@
     "release:minor": "npm version minor && npm publish && git push --follow-tags",
     "release:patch": "npm version patch && npm publish && git push --follow-tags",
     "predist": "npm run build && npm run docs",
-    "dist": "mkdirp dist && cd build && tar cvzf ../dist/<%-name%>.tar.gz *"
+    "dist": "mkdir dist && cd build && tar cvzf ../dist/<%-name%>.tar.gz *"
   },
   "devDependencies": {
     "@types/jasmine": "2.5.47",
@@ -39,7 +39,7 @@
     "extract-loader": "0.1.0",
     "ifdef-loader": "2.0.0",
     "file-loader": "0.11.1",
-    "fork-ts-checker-webpack-plugin": "0.4.1",
+    "fork-ts-checker-webpack-plugin": "0.4.4",
     "html-loader": "0.4.5",
     "imports-loader": "0.7.1",
     "jasmine": "2.5.3",
@@ -51,18 +51,17 @@
     "karma-junit-reporter": "2.0.0",
     "karma-sourcemap-loader": "0.3.7",
     "karma-webpack": "2.0.3",
-    "mkdirp": "0.5.1",
-    "node-sass": "^4.12.0",
+    "node-sass": "^4.13.1",
     "null-loader": "0.1.1",
     "raw-loader": "0.5.1",
     "sass-loader": "6.0.7",
     "style-loader": "0.16.1",
     "thread-loader": "1.1.2",
     "ts-loader": "4.0.1",
-    "tslib": "1.9.0",
+    "tslib": "~1.11.0",
     "tslint": "5.9.1",
-    "typedoc": "0.11.1",
-    "typescript": "2.8.1",
+    "typedoc": "~0.16.10",
+    "typescript": "~3.8.2",
     "url-loader": "0.5.8",
     "webpack": "2.3.3",
     "webpack-dev-server": "2.4.2"
diff --git a/generators/_init-web/templates/plain/tsconfig.json b/generators/_init-web/templates/plain/tsconfig.json
@@ -7,6 +7,7 @@
     "moduleResolution": "node",
     "jsx": "react",
     "experimentalDecorators": true,
+    "downlevelIteration": true, // required as long as target is `es5`
     "lib": [
       "dom",
       "es2015",
diff --git a/generators/_init-web/templates/plain/tsconfig_dev.json b/generators/_init-web/templates/plain/tsconfig_dev.json
@@ -1,6 +1,17 @@
 {
   "extends": "./tsconfig",
   "compilerOptions": {
-    "target": "es6"
-  }
+    "target": "es6",
+    "jsx": "react"
+  },
+  "include": [
+    "src/**/*.ts",
+    "src/**/*.tsx",
+    "tests/**/*.ts",
+    "index.ts",
+    "tsd.d.ts",
+    "../*/src/**/*.ts",
+    "../*/src/**/*.tsx",
+    "../*/tests/**/*.ts"
+  ]
 }
diff --git a/generators/_init-web/templates/plain/webpack.config.js b/generators/_init-web/templates/plain/webpack.config.js
@@ -55,7 +55,9 @@ const tsLoaderDev = [
     options: {
       happyPackMode: true, // IMPORTANT! use happyPackMode mode to speed-up compilation and reduce errors reported to webpack,
       compilerOptions: {
-        target: 'es6'
+        target: 'es6',
+        jsx: 'react',
+        jsxFactory: 'h',
       }
     }
   }
@@ -185,7 +187,7 @@ function generateWebpack(options) {
         'process.env.NODE_ENV': JSON.stringify(options.isProduction ? 'production' : 'development'),
         __VERSION__: JSON.stringify(pkg.version),
         __LICENSE__: JSON.stringify(pkg.license),
-        __BUILD_ID__: buildId,
+        __BUILD_ID__: JSON.stringify(buildId),
         __DEBUG__: options.isDev || options.isTest,
         __TEST__: options.isTest,
         __PRODUCTION__: options.isProduction,
diff --git a/generators/_node/templates/README.tmpl.md b/generators/_node/templates/README.tmpl.md
@@ -1,4 +1,4 @@
-<%- name %> [![Phovea][phovea-image]][phovea-url] [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]
+<%- name %> [![Phovea][phovea-image]][phovea-url] [![NPM version][npm-image]][npm-url]
 =====================
 
 <%- longDescription %>
@@ -43,7 +43,3 @@ This repository is part of **[Phovea](http://phovea.caleydo.org/)**, a platform
 [phovea-url]: https://phovea.caleydo.org
 [npm-image]: https://badge.fury.io/js/<%= name %>.svg
 [npm-url]: https://npmjs.org/package/<%= name %>
-[travis-image]: https://travis-ci.org/<%-githubAccount%>/<%-name%>.svg?branch=master
-[travis-url]: https://travis-ci.org/<%-githubAccount%>/<%-name%>
-[daviddm-image]: https://david-dm.org/<%-githubAccount%>/<%-name%>/status.svg
-[daviddm-url]: https://david-dm.org/<%-githubAccount%>/<%-name%>
diff --git a/generators/add-extension/index.js b/generators/add-extension/index.js
@@ -110,10 +110,13 @@ class Generator extends Base {
   }
 
   _injectWebExtension(d) {
-    const file = this.destinationPath('phovea.js');
+    const importFunction = fs.existsSync('src/phovea.ts') ? 'System.import' : 'import'; // TODO remove System.import for Typescript case when switching to Webpack 4 (see https://github.com/phovea/generator-phovea/issues/286#issuecomment-566553497)
+    const pathToRegistry = fs.existsSync('src/phovea.ts') ? 'src/phovea.ts' : 'phovea.js'; // check if the project has a phovea.ts file in src folder or a phovea.js in plugin root
+    const file = this.destinationPath(pathToRegistry);
+
     const old = this.fs.read(file);
     const absFile = d.module.startsWith('~') ? d.module.slice(1) : `./src/${d.module.includes('.') ? d.module.slice(0, d.module.lastIndexOf('.')) : d.module}`;
-    const text = `\n\n  registry.push('${d.type}', '${d.id}', function() { return import('${absFile}'); }, ${d.stringify(d.extras, ' ')});\n  // generator-phovea:end`;
+    const text = `\n\n  registry.push('${d.type}', '${d.id}', function() { return ${importFunction}('${absFile}'); }, ${d.stringify(d.extras, ' ')});\n  // generator-phovea:end`;
     const new_ = old.replace('  // generator-phovea:end', text);
     this.fs.write(file, new_);
 
diff --git a/generators/init-product/templates/package.tmpl.json b/generators/init-product/templates/package.tmpl.json
@@ -2,17 +2,16 @@
   "scripts": {
     "build": "node build.js --skipTests",
     "predist": "npm run build",
-    "dist": "mkdirp dist && cd build && tar cvzf ../dist/<%-name%>.tar.gz *"
+    "dist": "mkdir dist && cd build && tar cvzf ../dist/<%-name%>.tar.gz *"
   },
   "dependencies": {
-    "bluebird": "3.4.6",
-    "chalk": "1.1.3",
-    "fs-extra": "^1.0.0",
-    "generator-phovea": "^2.0.0",
-    "lodash": "4.17.14",
-    "mkdirp": "0.5.1",
-    "yamljs": "0.2.8",
-    "yargs-parser": "4.2.0",
-    "yeoman-environment": "1.6.6"
+    "bluebird": "3.7.2",
+    "chalk": "3.0.0",
+    "fs-extra": "^8.1.0",
+    "generator-phovea": "^4.0.0",
+    "lodash": "4.17.15",
+    "yamljs": "0.3.0",
+    "yargs-parser": "18.0.0",
+    "yeoman-environment": "2.8.0"
   }
 }
diff --git a/generators/init-product/templates/plain/.circleci/config.yml b/generators/init-product/templates/plain/.circleci/config.yml
@@ -59,16 +59,16 @@ jobs:
           name: Build and deploy
           command: |
             . ~/venv/bin/activate
-            case $CIRCLE_BRANCH in
+            case "${CIRCLE_BRANCH}${CIRCLE_TAG}" in
             master)
               awsTag="latest"
               ;;
             *)
-              awsTag="${CIRCLE_BRANCH}"
+              awsTag="${CIRCLE_BRANCH//\//_}${CIRCLE_TAG}" # replace `/` with `_` in branch name
               ;;
             esac
             echo "using tag: --${awsTag}--"
-            node build.js --skipSaveImage --noDefaultTags --pushExtra=${awsTag} --pushTo=922145058410.dkr.ecr.eu-central-1.amazonaws.com/caleydo
+            node build.js --injectVersion --skipSaveImage --noDefaultTags --pushExtra=${awsTag} --pushTo=922145058410.dkr.ecr.eu-central-1.amazonaws.com/caleydo
       - store_artifacts:
           path: build
           destination: build
@@ -87,7 +87,7 @@ jobs:
             export AWS_DEFAULT_REGION=eu-central-1
             # cleanup name by removing the _product suffix
             baseName=${CIRCLE_PROJECT_REPONAME%_product}
-            awsFamily="${baseName}-${CIRCLE_BRANCH}"
+            awsFamily="${baseName}-${CIRCLE_BRANCH//\//_}" # replace `/` with `_` in branch name
             echo "awsFamily --${awsFamily}--"
             tasksExists=$(aws --output text ecs list-task-definitions --family-prefix ${awsFamily})
             echo "existsTaskDefinition? --${tasksExists}--"
diff --git a/generators/init-product/templates/plain/build.js b/generators/init-product/templates/plain/build.js
@@ -14,7 +14,7 @@ const quiet = argv.quiet !== undefined;
 
 const now = new Date();
 const prefix = (n) => n < 10 ? ('0' + n) : n.toString();
-const buildId = `${now.getUTCFullYear()}${prefix(now.getUTCMonth())}${prefix(now.getUTCDate())}-${prefix(now.getUTCHours())}${prefix(now.getUTCMinutes())}${prefix(now.getUTCSeconds())}`;
+const buildId = `${now.getUTCFullYear()}${prefix(now.getUTCMonth()+1)}${prefix(now.getUTCDate())}-${prefix(now.getUTCHours())}${prefix(now.getUTCMinutes())}${prefix(now.getUTCSeconds())}`;
 pkg.version = pkg.version.replace('SNAPSHOT', buildId);
 const env = Object.assign({}, process.env);
 const productName = pkg.name.replace('_product', '');
@@ -635,6 +635,13 @@ function installWebDependencies(p) {
   return npm(p.additional.length > 0 ? p.tmpDir : (`${p.tmpDir}/${p.name}`), 'install');
 }
 
+function showWebDependencies(p) {
+  // `npm ls` fails if some peerDependencies are not installed
+  // since this function is for debug purposes only, we catch possible errors of `npm()` and resolve it with status code `0`.
+  return npm(p.additional.length > 0 ? p.tmpDir : (`${p.tmpDir}/${p.name}`), 'list --depth=1')
+    .catch(() => Promise.resolve(0)) // status code = 0
+}
+
 function cleanUpWebDependencies(p) {
   return fs.emptyDirAsync(p.additional.length > 0 ? `${p.tmpDir}/node_modules` : (`${p.tmpDir}/${p.name}/node_modules`));
 }
@@ -672,6 +679,12 @@ function installPythonTestDependencies(p) {
     .then(() => spawn('pip', 'install --no-cache-dir -r requirements_dev.txt', {cwd: p.tmpDir}));
 }
 
+function showPythonTestDependencies(p) {
+  // since this function is for debug purposes only, we catch possible errors and resolve it with status code `0`.
+  return spawn('pip', 'list', {cwd: p.tmpDir})
+    .catch(() => Promise.resolve(0)) // status code = 0
+}
+
 function buildServer(p) {
   let act = npm(`${p.tmpDir}/${p.name}`, `run build${p.isHybridType ? ':python' : ''}`);
   for (const pi of p.additional) {
@@ -797,13 +810,17 @@ if (require.main === module) {
       }
     }
 
-    const needsWorskpace = (isWeb && hasAdditional) || isServer;
-    steps[`prepare:${suffix}`] = needsWorskpace ? () => catchProductBuild(p, createWorkspace(p)) : null;
+    const needsWorkspace = (isWeb && hasAdditional) || isServer;
+    if(needsWorkspace) {
+      steps[`prepare:${suffix}`] = () => catchProductBuild(p, createWorkspace(p));
+    }
 
     if (isWeb) {
       steps[`install:${suffix}`] = () => catchProductBuild(p, installWebDependencies(p));
+      steps[`show:${suffix}`] = () => catchProductBuild(p, showWebDependencies(p));
     } else { // server
       steps[`install:${suffix}`] = argv.skipTests ? () => null : () => catchProductBuild(p, installPythonTestDependencies(p));
+      steps[`show:${suffix}`] = () => catchProductBuild(p, showPythonTestDependencies(p));
     }
     steps[`test:${suffix}`] = isWeb && hasAdditional ? () => catchProductBuild(p, resolvePluginTypes(p).then(() => testWebAdditionals(p))) : () => null;
     steps[`build:${suffix}`] = isWeb ? () => catchProductBuild(p, resolvePluginTypes(p).then(() => buildWeb(p))) : () => catchProductBuild(p, resolvePluginTypes(p).then(() => buildServer(p)));
@@ -812,8 +829,12 @@ if (require.main === module) {
     steps[`image:${suffix}`] = () => catchProductBuild(p, buildDockerImage(p));
     steps[`save:${suffix}`] = () => catchProductBuild(p, dockerSave(p.image, `build/${p.label}_image.tar.gz`));
 
-    subSteps.push(`prepare:${suffix}`);
+    if(needsWorkspace) {
+      subSteps.push(`prepare:${suffix}`);
+    }
     subSteps.push(`install:${suffix}`);
+    subSteps.push(`show:${suffix}`);
+
     if (!argv.skipTests) {
       subSteps.push(`test:${suffix}`);
     }
@@ -837,7 +858,7 @@ if (require.main === module) {
   // create some meta steps
   {
     const stepNames = Object.keys(steps);
-    for (const meta of ['clone', 'prepare', 'build', 'test', 'postbuild', 'image', 'product', 'install']) {
+    for (const meta of ['clone', 'prepare', 'build', 'test', 'postbuild', 'image', 'product', 'install', 'show']) {
       const sub = stepNames.filter((d) => d.startsWith(`${meta}:`));
       if (sub.length <= 0) {
         continue;
diff --git a/generators/prepare-release/index.js b/generators/prepare-release/index.js
@@ -257,9 +257,16 @@ class Generator extends Base {
               req[key] = '==' + version;
             } else {
               return new Promise((resolve) => {
-                const request = require('request');
-                console.log(`https://pypi.python.org/pypi/${key}/json`);
-                request(`https://pypi.python.org/pypi/${key}/json`, (error, response, data) => resolve(data));
+                const https = require('https');
+                console.log(`https://pypi.org/pypi/${key}/json`);
+                https.get(`https://pypi.org/pypi/${key}/json`, (res) => {
+                  var body = '';
+                  res.on('data', (chunk) => { body += chunk; });
+                  res.on('end', () => { resolve(body); });
+                })
+                .on('error', (e) => {
+                  this.log(`The request was not successful: ${e}`);
+                });
               }).then((data) => {
                 const infos = JSON.parse(data);
                 const versions = Object.keys(infos.releases).sort(semver.compare);
@@ -330,10 +337,10 @@ class Generator extends Base {
   }
 
   _createPullRequest(ctx) {
-    const opn = require('opn');
+    const open = require('open');
     const base = simplifyRepoUrl(ctx.repo);
     const url = `https://github.com/${base}/compare/release_${ctx.version}?expand=1`;
-    return opn(url, {
+    return open(url, {
       wait: false
     }).then(() => ctx);
   }
@@ -360,10 +367,10 @@ class Generator extends Base {
   }
 
   _openReleasePage(ctx) {
-    const opn = require('opn');
+    const open = require('open');
     const base = simplifyRepoUrl(ctx.repo);
     const url = `https://github.com/${base}/releases/tag/v${ctx.version}`;
-    return opn(url, {
+    return open(url, {
       wait: false
     }).then(() => ctx);
   }
diff --git a/generators/workspace/templates/plain/tsconfig.json b/generators/workspace/templates/plain/tsconfig.json
@@ -7,6 +7,7 @@
     "moduleResolution": "node",
     "jsx": "react",
     "experimentalDecorators": true,
+    "downlevelIteration": true, // required as long as target is `es5`
     "lib": [
       "dom",
       "es2015"
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@`
`34`	`34`	`"predist:web": "npm run build:web && npm run docs:web",`
`35`	`35`	`"predist:python": "npm run build:python && npm run docs:python",`
`36`	`36`	`"predist": "echo hybrid",`
`37`		`- "dist:web": "mkdirp dist && cd build && tar cvzf ../dist/<%-name%>.tar.gz *",`
	`37`	`+ "dist:web": "mkdir dist && cd build && tar cvzf ../dist/<%-name%>.tar.gz *",`
`38`	`38`	`"dist:python": "python setup.py sdist bdist_wheel",`
`39`	`39`	`"dist": "npm run dist:web && npm run dist:python"`
`40`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,9 @@ const tsLoaderDev = [`
`55`	`55`	`options: {`
`56`	`56`	`happyPackMode: true, // IMPORTANT! use happyPackMode mode to speed-up compilation and reduce errors reported to webpack,`
`57`	`57`	`compilerOptions: {`
`58`		`- target: 'es6'`
	`58`	`+ target: 'es6',`
	`59`	`+ jsx: 'react',`
	`60`	`+ jsxFactory: 'h',`
`59`	`61`	`}`
`60`	`62`	`}`
`61`	`63`	`}`
`@@ -185,7 +187,7 @@ function generateWebpack(options) {`
`185`	`187`	`'process.env.NODE_ENV': JSON.stringify(options.isProduction ? 'production' : 'development'),`
`186`	`188`	`__VERSION__: JSON.stringify(pkg.version),`
`187`	`189`	`__LICENSE__: JSON.stringify(pkg.license),`
`188`		`- __BUILD_ID__: buildId,`
	`190`	`+ __BUILD_ID__: JSON.stringify(buildId),`
`189`	`191`	`__DEBUG__: options.isDev \|\| options.isTest,`
`190`	`192`	`__TEST__: options.isTest,`
`191`	`193`	`__PRODUCTION__: options.isProduction,`