Make yFiles npm module installation work with yarn, quit early when installation fails

micschro · micschro · commit a262f1a189a6 · 2019-12-13T12:56:52.000+01:00
diff --git a/generators/app/index.js b/generators/app/index.js
@@ -19,6 +19,13 @@ const promptOptions = require("./promptOptions");
 module.exports = class extends Generator {
   initializing() {
     this.minimumModules = [];
+    // Unless this is enabled, installation errors will just be swallowed.
+    this.options["force-install"] = true
+
+    this.on('error', function(e) {
+      this.env.error(e)
+      return false
+    })
   }
 
   prompting() {
@@ -690,7 +697,7 @@ module.exports = class extends Generator {
       const yfilesLibPath = path.join(this.props.yfilesPath, 'lib/es-modules')
       const yFilesPackageJson = require(path.resolve(path.join(yfilesLibPath, 'package.json')))
       const yFilesNpmVersion = yFilesPackageJson.version
-      let yFilesDepPath = path.resolve(yfilesLibPath, 'yfiles-' + yFilesNpmVersion + '.tgz')
+      let yFilesDepPath = path.resolve(yfilesLibPath, `yfiles-${this.props.useYarn ? 'v' : ''}${yFilesNpmVersion}.tgz`)
       extend(pkg, {
         dependencies: {
           yfiles: yFilesDepPath
diff --git a/generators/app/templates/webpack4.config.ejs b/generators/app/templates/webpack4.config.ejs
@@ -28,6 +28,7 @@ const config = {
         exclude: /(node_modules|lib[/\\]yfiles)/,
         loader: 'babel-loader',
         options: {
+          compact: true,
           presets: ['@babel/preset-env', '@babel/preset-typescript']
         }
       },
@@ -45,6 +46,7 @@ const config = {
         exclude: /(node_modules|bower_components|lib)/,
         loader: 'babel-loader',
         options: {
+          compact: true,
           presets: ['@babel/preset-env']
         }
       },
@@ -70,7 +72,11 @@ const config = {
       filename: '[name].css',
       chunkFilename: '[id].css'
     })
-  ]
+  ],
+  performance: {
+    // don't complain about large chunks/assets
+    hints: false
+  }
 };
 
 module.exports = function (env, options) {
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "generator-yfiles-app",
-  "version": "3.0.4",
+  "version": "3.0.5",
   "description": "A generator that scaffolds a yFiles for HTML powered application. Requires local yFiles package.",
   "homepage": "https://www.yworks.com",
   "author": {
diff --git a/test/amd-vscode.js b/test/amd-vscode.js
@@ -10,6 +10,8 @@ const util = require('./support/util');
 const defaultAnswers = require('./support/defaultPromptAnswers');
 const promptOptions = require("../generators/app/promptOptions");
 const defaultInit = require('./support/defaultInit');
+const initTest = require('./support/initTest');
+
 
 const answers = Object.assign({},defaultAnswers, {
   "buildTool": promptOptions.buildTool.NONE,
@@ -25,6 +27,8 @@ describe('AMD + VS Code', function () {
 
   this.timeout(125000)
 
+  before(initTest(answers))
+
   before(function(done) {
     const that = this;
     this.app = helpers
diff --git a/test/esmodules-es6-vscode.js b/test/esmodules-es6-vscode.js
@@ -10,6 +10,7 @@ const util = require('./support/util');
 const defaultAnswers = require('./support/defaultPromptAnswers');
 const promptOptions = require("../generators/app/promptOptions");
 const defaultInit = require('./support/defaultInit');
+const initTest = require('./support/initTest');
 
 const answers = Object.assign({},defaultAnswers, {
   "moduleType": promptOptions.moduleType.ES6_MODULES,
@@ -25,6 +26,8 @@ describe('ES Modules + ES6 + vscode', function () {
 
   this.timeout(125000)
 
+  before(initTest(answers))
+
   before(function(done) {
     const that = this;
     this.app = helpers
@@ -35,7 +38,9 @@ describe('ES Modules + ES6 + vscode', function () {
         'skip-message': true,
         'skip-install': false
       })
-      .withPrompts(answers).then(function(dir) {return defaultInit(__filename, dir)}).then(function(dir) {
+      .withPrompts(answers).then(function(dir) {
+        return defaultInit(__filename, dir)
+      }).then(function(dir) {
         that.dir = dir;
         done();
       })
diff --git a/test/esmodules-es6-webstorm.js b/test/esmodules-es6-webstorm.js
@@ -10,6 +10,7 @@ const util = require('./support/util');
 const defaultAnswers = require('./support/defaultPromptAnswers');
 const promptOptions = require("../generators/app/promptOptions");
 const defaultInit = require('./support/defaultInit');
+const initTest = require('./support/initTest');
 
 const answers = Object.assign({},defaultAnswers, {
   "moduleType": promptOptions.moduleType.ES6_MODULES,
@@ -25,6 +26,8 @@ describe('ES Modules + ES6 + WebStorm', function () {
 
   this.timeout(125000)
 
+  before(initTest(answers))
+
   before(function(done) {
     const that = this;
     this.app = helpers
diff --git a/test/esmodules-typescipt.js b/test/esmodules-typescipt.js
@@ -10,6 +10,7 @@ const util = require('./support/util');
 const defaultAnswers = require('./support/defaultPromptAnswers');
 const promptOptions = require("../generators/app/promptOptions");
 const defaultInit = require('./support/defaultInit');
+const initTest = require('./support/initTest');
 
 const answers = Object.assign({},defaultAnswers, {
   "language": promptOptions.language.TypeScript,
@@ -24,6 +25,8 @@ describe('ES Modules + TypeScript', function () {
 
   this.timeout(125000)
 
+  before(initTest(answers))
+
   before(function(done) {
     const that = this;
     this.app = helpers
@@ -77,9 +80,6 @@ describe('ES Modules + TypeScript', function () {
     it('uses webpack 4', function() {
       assert.fileContent('package.json', /"webpack": "\^?4/)
     })
-    it('uses ts-loader 4', function() {
-      assert.fileContent('package.json', /"ts-loader": "\^?4/)
-    })
 
     it('runs', function (done) {
       util.maybeOpenInBrowser(this.dir,done);
diff --git a/test/npm-es6-vscode.js b/test/npm-es6-vscode.js
@@ -10,6 +10,7 @@ const util = require('./support/util');
 const defaultAnswers = require('./support/defaultPromptAnswers');
 const promptOptions = require("../generators/app/promptOptions");
 const defaultInit = require('./support/defaultInit');
+const initTest = require('./support/initTest');
 
 const answers = Object.assign({},defaultAnswers, {
   "moduleType": promptOptions.moduleType.NPM,
@@ -25,6 +26,8 @@ describe('Local NPM module + ES6 + VSCode', function () {
 
   this.timeout(125000)
 
+  before(initTest(answers))
+
   before(function(done) {
     const that = this;
     this.app = helpers
diff --git a/test/npm-es6.js b/test/npm-es6.js
@@ -10,6 +10,7 @@ const util = require('./support/util');
 const defaultAnswers = require('./support/defaultPromptAnswers');
 const promptOptions = require("../generators/app/promptOptions");
 const defaultInit = require('./support/defaultInit');
+const initTest = require('./support/initTest');
 
 const answers = Object.assign({},defaultAnswers, {
   "moduleType": promptOptions.moduleType.NPM,
@@ -24,6 +25,8 @@ describe('Local NPM module + ES6', function () {
 
   this.timeout(125000)
 
+  before(initTest(answers))
+
   before(function(done) {
     const that = this;
     this.app = helpers
diff --git a/test/npm-typescript.js b/test/npm-typescript.js
@@ -10,6 +10,7 @@ const util = require('./support/util');
 const defaultAnswers = require('./support/defaultPromptAnswers');
 const promptOptions = require("../generators/app/promptOptions");
 const defaultInit = require('./support/defaultInit');
+const initTest = require('./support/initTest');
 
 const answers = Object.assign({},defaultAnswers, {
   "moduleType": promptOptions.moduleType.NPM,
@@ -24,6 +25,8 @@ describe('Local NPM module + TypeScript', function () {
 
   this.timeout(125000)
 
+  before(initTest(answers))
+
   before(function(done) {
     const that = this;
     this.app = helpers
diff --git a/test/support/defaultPromptAnswers.js b/test/support/defaultPromptAnswers.js
@@ -35,11 +35,6 @@ describe('Validate Prompts', function () {
     const validateLicenseResult = validatePrompts.isValidYfilesLicense(licensePath)
     assert((typeof validateLicenseResult) !== "string", validateLicenseResult)
   })
-  /*it('runs in some directory', function(done){
-    console.log("this dir" + this.dir);
-    assert(this.dir);
-    done();
-  })*/
 })
 
 module.exports = answers;
diff --git a/test/support/initTest.js b/test/support/initTest.js
@@ -0,0 +1,19 @@
+const fs = require('fs')
+const path = require('path')
+const {exec} = require('child_process');
+
+module.exports = function (answers) {
+  return function (done) {
+    const packagePath = answers.yfilesPath
+    if (fs.existsSync(packagePath)) {
+      const libPath = path.join(packagePath, 'lib/es-modules')
+      const tgzFiles = fs.readdirSync(libPath).filter(f => f.endsWith('tgz')).map(f => path.join(libPath, f))
+      for (const tgz of tgzFiles) {
+        console.log('Cleaning ', tgz, 'yFiles package.')
+        fs.unlinkSync(tgz)
+      }
+    }
+
+    exec('yarn cache clean', done)
+  }
+}
diff --git a/test/umd-none-amd-es5.js b/test/umd-none-amd-es5.js
@@ -10,6 +10,7 @@ const util = require('./support/util');
 const defaultAnswers = require('./support/defaultPromptAnswers');
 const promptOptions = require("../generators/app/promptOptions");
 const defaultInit = require('./support/defaultInit');
+const initTest = require('./support/initTest');
 
 const answers = Object.assign({},defaultAnswers, {
   "moduleType": promptOptions.moduleType.UMD,
@@ -28,6 +29,8 @@ describe('UMD + ES5', function () {
 
   this.timeout(125000)
 
+  before(initTest(answers))
+
   before(function(done) {
     const that = this;
     this.app = helpers
diff --git a/test/umd-none-amd-es6-idea.js b/test/umd-none-amd-es6-idea.js
@@ -10,6 +10,7 @@ const util = require('./support/util');
 const defaultAnswers = require('./support/defaultPromptAnswers');
 const promptOptions = require("../generators/app/promptOptions");
 const defaultInit = require('./support/defaultInit');
+const initTest = require('./support/initTest');
 
 const answers = Object.assign({},defaultAnswers, {
   "moduleType": promptOptions.moduleType.UMD,
@@ -27,6 +28,8 @@ describe('AMD + Pure ES6 + IDEA', function () {
 
   this.timeout(125000)
 
+  before(initTest(answers))
+
   before(function(done) {
     const that = this;
     this.app = helpers
diff --git a/test/umd-none-amd-es6.js b/test/umd-none-amd-es6.js
@@ -10,6 +10,7 @@ const util = require('./support/util');
 const defaultAnswers = require('./support/defaultPromptAnswers');
 const promptOptions = require("../generators/app/promptOptions");
 const defaultInit = require('./support/defaultInit');
+const initTest = require('./support/initTest');
 
 const answers = Object.assign({},defaultAnswers, {
   "moduleType": promptOptions.moduleType.UMD,
@@ -26,6 +27,8 @@ describe('UMD + None + AMD + ES6', function () {
 
   this.timeout(125000)
 
+  before(initTest(answers))
+
   before(function(done) {
     const that = this;
     this.app = helpers
diff --git a/test/umd-none-script-es5.js b/test/umd-none-script-es5.js
@@ -10,6 +10,7 @@ const util = require('./support/util');
 const defaultAnswers = require('./support/defaultPromptAnswers');
 const promptOptions = require("../generators/app/promptOptions");
 const defaultInit = require('./support/defaultInit');
+const initTest = require('./support/initTest');
 
 const answers = Object.assign({},defaultAnswers, {
   "moduleType": promptOptions.moduleType.UMD,
@@ -26,6 +27,8 @@ describe('Script Tags', function () {
 
   this.timeout(125000)
 
+  before(initTest(answers))
+
   before(function(done) {
     const that = this;
     this.app = helpers
diff --git a/test/umd-none-script-es6.js b/test/umd-none-script-es6.js
@@ -10,6 +10,7 @@ const util = require('./support/util');
 const defaultAnswers = require('./support/defaultPromptAnswers');
 const promptOptions = require("../generators/app/promptOptions");
 const defaultInit = require('./support/defaultInit');
+const initTest = require('./support/initTest');
 
 const answers = Object.assign({},defaultAnswers, {
   "moduleType": promptOptions.moduleType.UMD,
@@ -26,6 +27,8 @@ describe('UMD + None + Script-Tags + ES6', function () {
 
   this.timeout(125000)
 
+  before(initTest(answers))
+
   before(function(done) {
     const that = this;
     this.app = helpers
diff --git a/test/umd-webpack-es6.js b/test/umd-webpack-es6.js
@@ -10,6 +10,7 @@ const util = require('./support/util');
 const defaultAnswers = require('./support/defaultPromptAnswers');
 const promptOptions = require("../generators/app/promptOptions");
 const defaultInit = require('./support/defaultInit');
+const initTest = require('./support/initTest');
 
 const answers = Object.assign({},defaultAnswers, {
   "moduleType": promptOptions.moduleType.UMD,
@@ -22,6 +23,8 @@ describe('UMD + Webpack + ES6', function () {
 
   this.timeout(125000)
 
+  before(initTest(answers))
+
   before(function(done) {
     const that = this;
     this.app = helpers
diff --git a/test/umd-webpack-typescript.js b/test/umd-webpack-typescript.js
@@ -10,6 +10,7 @@ const util = require('./support/util');
 const defaultAnswers = require('./support/defaultPromptAnswers');
 const promptOptions = require("../generators/app/promptOptions");
 const defaultInit = require('./support/defaultInit');
+const initTest = require('./support/initTest');
 
 const answers = Object.assign({},defaultAnswers, {
   "moduleType": promptOptions.moduleType.UMD,
@@ -21,6 +22,8 @@ describe('UMD + Webpack + Typescript', function () {
 
   this.timeout(125000)
 
+  before(initTest(answers))
+
   before(function(done) {
     const that = this;
     helpers
@@ -69,9 +72,6 @@ describe('UMD + Webpack + Typescript', function () {
     it('uses webpack 4', function() {
       assert.fileContent('package.json', /"webpack": "\^?4/)
     })
-    it('uses ts-loader 4', function() {
-      assert.fileContent('package.json', /"ts-loader": "\^?4/)
-    })
 
     it('runs', function (done) {
       const dir = this.dir;

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "generator-yfiles-app",`
`3`		`- "version": "3.0.4",`
	`3`	`+ "version": "3.0.5",`
`4`	`4`	`"description": "A generator that scaffolds a yFiles for HTML powered application. Requires local yFiles package.",`
`5`	`5`	`"homepage": "https://www.yworks.com",`
`6`	`6`	`"author": {`