generator-nsis 0.8.10 → 0.10.0

package/generators/app/index.js

@@ -1,535 +1,233 @@
-const Generator = require('yeoman-generator');
-const pkg = require('../../package.json');
 
-const globby = require('globby');
-const languageData = require('@nsis/language-data').meta;
-const semver = require('semver');
-const slugify = require('@sindresorhus/slugify');
-const spdxLicenseList = require('spdx-license-list/full');
-const terminalLink = require('terminal-link');
-const updateNotifier = require('update-notifier');
-const { nsisDir } = require('makensis');
-const { basename, extname, resolve } = require('path');
-
-// Is there a newer version of this generator?
-updateNotifier({ pkg: pkg }).notify();
-
-// Create array of license choices
-const spdxCodes = Object.getOwnPropertyNames(spdxLicenseList).sort();
-const licenseChoices = spdxCodes.map(obj => {
-  const licenses = {};
-  licenses['name'] = terminalLink(obj, `https://spdx.org/licenses/${obj}.html`, {
-    fallback() {
-      return obj;
-    }
-  });
-  licenses['value'] = obj;
-
-  return licenses;
-});
-
-const docsURL = 'https://github.com/NSIS-Dev/Documentation/tree/master';
-
-const bundledLibraries = [
-  {
-    name: 'Colors.nsh',
-    value: 'Colors',
-    checked: false
-  },
-  {
-    name: terminalLink('FileFunc.nsh', `${docsURL}/Includes/FileFunc`, {
-      fallback() {
-        return 'FileFunc.nsh';
-      }
-    }),
-    value: 'FileFunc',
-    checked: false
-  },
-  {
-    name: 'InstallOptions.nsh',
-    value: 'InstallOptions',
-    checked: false
-  },
-  {
-    name: 'Integration.nsh',
-    value: 'Integration',
-    checked: false
-  },
-  {
-    name: 'LangFile.nsh',
-    value: 'LangFile',
-    checked: false
-  },
-  {
-    name: 'Library.nsh',
-    value: 'Library',
-    checked: false
-  },
-  {
-    name: terminalLink('LogicLib.nsh', `${docsURL}/Includes/LogicLib`, {
-      fallback() {
-        return 'LogicLib.nsh';
-      }
-    }),
-    value: 'LogicLib',
-    checked: false
-  },
-  {
-    name: terminalLink('Memento.nsh', `${docsURL}/Includes/Memento`, {
-      fallback() {
-        return 'Memento.nsh';
-      }
-    }),
-    value: 'Memento',
-    checked: false
-  },
-  {
-    name: 'MUI2.nsh',
-    value: 'MUI2',
-    checked: false
-  },
-  {
-    name: 'MultiUser.nsh',
-    value: 'MultiUser',
-    checked: false
-  },
-  {
-    name: 'nsDialogs.nsh',
-    value: 'nsDialogs',
-    checked: false
-  },
-  {
-    name: 'Sections.nsh',
-    value: 'Sections',
-    checked: false
-  },
-  {
-    name: terminalLink('StrFunc.nsh', `${docsURL}/Includes/StrFunc`, {
-      fallback() {
-        return 'StrFunc.nsh';
-      }
-    }),
-    value: 'StrFunc',
-    checked: false
-  },
-  {
-    name: terminalLink('TextFunc.nsh', `${docsURL}/Includes/TextFunc`, {
-      fallback() {
-        return 'TextFunc.nsh';
-      }
-    }),
-    value: 'TextFunc',
-    checked: false
-  },
-  {
-    name: 'UpgradeDLL.nsh',
-    value: 'UpgradeDLL',
-    checked: false
-  },
-  {
-    name: 'Util.nsh',
-    value: 'Util',
-    checked: false
-  },
-  {
-    name: 'VB6RunTime.nsh',
-    value: 'VB6RunTime',
-    checked: false
-  },
-  {
-    name: 'VPatchLib.nsh',
-    value: 'VPatchLib',
-    checked: false
-  },
-  {
-    name: 'WinCore.nsh',
-    value: 'WinCore',
-    checked: false
-  },
-  {
-    name: 'WinMessages.nsh',
-    value: 'WinMessages',
-    checked: false
-  },
-  {
-    name: terminalLink('WinVer.nsh', `${docsURL}/Includes/WinVer`, {
-      fallback() {
-        return 'WinVer.nsh';
-      }
-    }),
-    value: 'WinVer',
-    checked: false
-  },
-  {
-    name: terminalLink('WordFunc.nsh', `${docsURL}/Includes/WordFunc`, {
-      fallback() {
-        return 'WordFunc.nsh';
-      }
-    }),
-    value: 'WordFunc',
-    checked: false
-  },
-  {
-    name: terminalLink('x64.nsh', `${docsURL}/Includes/x64`, {
-      fallback() {
-        return 'x64.nsh';
-      }
-    }),
-    value: 'x64',
-    checked: false
-  }
-];
-
-const getAllLibraries = async () => {
-  const nsisPath = await nsisDir();
-  const includeDir = resolve(nsisPath, 'Include')
-
-  const excludedFiles = bundledLibraries.map(excludedFiles => {
-    return `!${includeDir}/${excludedFiles.value}.nsh`;
-  });
-
-  const headerFiles = globby.sync([`${includeDir}/*.nsh`,`!${includeDir}/MUI.nsh`, ...excludedFiles]);
-
-  const customHeaders = headerFiles.map(headerFile => {
-    return {
-      name: `${basename(headerFile)} [3rd party]`,
-      value: basename(headerFile, extname(headerFile)),
-      checked: false
-    }
-  });
-
-  const allLibraries = [...bundledLibraries, ...customHeaders];
-
-  return allLibraries.sort((a,b) => a.value.localeCompare(b.value));
-};
-
-module.exports = class extends Generator {
-  constructor(args, opts) {
-    super(args, opts);
-
-    this.option('first-party', { desc: 'Limits library inclusion to first-party', default: false });
-    this.option('loose-version', { desc: `Doesn't enforce semantic versioning`, default: false });
-    this.option('unlock-all', { desc: 'Unlocks all disabled features', default: false });
-
-    this.looseVersion = (this.options.looseVersion ? true : false);
-    this.disabled = (this.options.unlockAll ? false : true);
-    this.firstParty = (this.options.firstParty ? true : false);
-  }
-
-  languageChoices() {
-    const languageChoices = Object.entries(languageData).map(([key, value]) => {
-      const isDisabled = (key === 'English') ? this.disabled : false;
-
-      // Use long names
-      return {
-        name: value.english || key,
-        value: key,
-        disabled: isDisabled
-      };
-    });
-
-    // Sort names
-    languageChoices.sort((a, b) => {
-      if (a.name < b.name) {
-        return -1;
-      }
-      if (a.name > b.name) {
-        return 1;
-      }
-
-      return 0;
-    });
-
-    return languageChoices;
-  }
-
-  languageDialog(isUnicode) {
-    const languageDialog = Object.entries(languageData).map(([key, value]) => {
-      if (key === 'English') return;
-
-      return {
-        constant: `$\{LANG_${key.toUpperCase()}}`,
-        string: (isUnicode) ? value.native : (value.long || key)
-      };
-    });
-
-    return languageDialog;
-  }
-
-  inquirer() {
-    return this.prompt([
-      {
-        name: 'name',
-        message: `Application name`,
-        default: slugify(this.appname),
-        store: true
-      },
-      {
-        name: 'version',
-        message: `Application version`,
-        default: '0.0.0',
-        store: true,
-        validate: version => (this.looseVersion === true || semver.valid(version) !== null) ? true : `Not a valid ${terminalLink('semantic version', 'https://semver.org', {
-          fallback() {
-            return 'semantic version';
-          }
-        })}`
-      },
-      {
-        name: 'unicode',
-        message: 'Unicode installer',
-        type: 'confirm',
-        default: 'true',
-        store: true
-      },
-      {
-        name: 'elevation',
-        message: 'Requested execution level',
-        type: 'list',
-        default: 'user',
-        store: true,
-        choices: [ 'user', 'highest', 'admin', 'none' ]
-      },
-      {
-        name: 'compression',
-        message: 'Set compression',
-        type: 'list',
-        default: 'lzma',
-        store: true,
-        choices: [ 'zlib', 'bzip2', 'lzma' ]
-      },
-      {
-        name: 'pages',
-        message: 'Installer pages',
-        type: 'checkbox',
-        store: true,
-        choices: [
-          {
-            name: 'license',
-            value: 'license',
-          },
-          {
-            name: 'components',
-            value: 'components',
-          },
-          {
-            name: 'directory',
-            value: 'directory',
-          },
-          {
-            name: 'instfiles',
-            value: 'instfiles',
-            checked: true
-          }
-        ]
-      },
-      {
-        name: 'spdxQuestion',
-        message: `Choose a license from ${terminalLink('SPDX License List', 'https://spdx.org/licenses/', {
-          fallback() {
-            return 'SPDX License List'
-          }
-        })}`,
-        type: 'confirm',
-        default: true,
-        store: true,
-        when: answers => answers.pages.includes('license') ? true : false
-      },
-      {
-        name: 'spdxLicense',
-        message: 'Choose a license',
-        type: 'list',
-        default: 'MIT',
-        choices: licenseChoices,
-        store: true,
-        when: answers => (answers.pages.includes('license') && answers.spdxQuestion) ? true : false
-      },
-      {
-        name: 'sections',
-        message: 'Number of sections',
-        default: 1,
-        store: true,
-        validate: number => (Number.isInteger(parseInt(number)) && parseInt(number) > 0) ? true : 'Not a valid integer'
-      },
-      {
-        name: 'callbacks',
-        message: 'Add callback functions',
-        type: 'checkbox',
-        store: true,
-        choices: [
-          {
-            name: terminalLink('.onInit', 'https://github.com/NSIS-Dev/Documentation/blob/master/Callbacks/onInit.md', {
-              fallback() {
-                return '.onInit';
-              }
-            }),
-            value: '.onInit'
-          },
-          {
-            name: terminalLink('.onGUIInit', 'https://github.com/NSIS-Dev/Documentation/blob/master/Callbacks/onGUIInit.md', {
-              fallback() {
-                return '.onGUIInit';
-              }
-            }),
-            value: '.onGUIInit'
-          },
-          {
-            name: terminalLink('.onGUIEnd', 'https://github.com/NSIS-Dev/Documentation/blob/master/Callbacks/onGUIEnd.md', {
-              fallback() {
-                return '.onGUIEnd';
-              }
-            }),
-            value: '.onGUIEnd'
-          },
-          {
-            name: terminalLink('.onInstSuccess', 'https://github.com/NSIS-Dev/Documentation/blob/master/Callbacks/onInstSuccess.md', {
-              fallback() {
-                return '.onInstSuccess';
-              }
-            }),
-            value: '.onInstSuccess'
-          },
-          {
-            name: terminalLink('.onInstFailed', 'https://github.com/NSIS-Dev/Documentation/blob/master/Callbacks/onInstFailed.md', {
-              fallback() {
-                return '.onInstFailed';
-              }
-            }),
-            value: '.onInstFailed'
-          },
-          {
-            name: terminalLink('.onUserAbort', 'https://github.com/NSIS-Dev/Documentation/blob/master/Callbacks/onUserAbort.md', {
-              fallback() {
-                return '.onUserAbort';
-              }
-            }),
-            value: '.onUserAbort'
-          },
-          {
-            name: terminalLink('.onVerifyInstDir', 'https://github.com/NSIS-Dev/Documentation/blob/master/Callbacks/onVerifyInstDir.md', {
-              fallback() {
-                return '.onVerifyInstDir';
-              }
-            }),
-            value: '.onVerifyInstDir'
-          },
-          {
-            name: terminalLink('.onRebootFailed', 'https://github.com/NSIS-Dev/Documentation/blob/master/Callbacks/onRebootFailed.md', {
-              fallback() {
-                return '.onRebootFailed';
-              }
-            }),
-            value: '.onRebootFailed'
-          },
-          {
-            name: terminalLink('.onSelChange', 'https://github.com/NSIS-Dev/Documentation/blob/master/Callbacks/onSelChange.md', {
-              fallback() {
-                return '.onSelChange';
-              }
-            }),
-            value: '.onSelChange'
-          },
-          {
-            name: terminalLink('.onMouseOverSection', 'https://github.com/NSIS-Dev/Documentation/blob/master/Callbacks/onMouseOverSection.md', {
-              fallback() {
-                return '.onMouseOverSection';
-              }
-            }),
-            value: '.onMouseOverSection'
-          },
-        ] },
-      {
-        name: 'includes',
-        message: 'Add libraries',
-        type: 'checkbox',
-        store: true,
-        choices: async () => this.firstParty ? bundledLibraries : await getAllLibraries()
-      },
-      {
-        name: 'languages',
-        message: (this.disabled === true) ? 'Add languages other than English' : 'Add languages',
-        type: 'checkbox',
-        store: true,
-        choices: this.languageChoices()
-      },
-      {
-        name: 'languageDialog',
-        message: 'Add language dialog',
-        type: 'confirm',
-        default: 'true',
-        store: true,
-        when: answers => {
-          switch (true) {
-            case (this.options['unlock-all'] === true && answers.languages.length > 1):
-            case (this.options['unlock-all'] === false && answers.languages.length > 0):
-              return true;
-            default:
-              return false;
-          }
-        }
-      },
-      {
-        name: 'editInstallerScript',
-        message: 'Edit installer script',
-        type: 'confirm',
-        default: 'true',
-        store: true,
-        when: () => {
-          return (process.env.EDITOR) ? true : false;
-        }
-      },
-    ]).then(props => {
-
-      if (typeof props.spdxLicense !== 'undefined') {
-        props.licenseText = spdxLicenseList[props.spdxLicense].licenseText.replace(/\n{3,}/g, '\n\n');
-      }
-
-      if (props.name.includes('&')) {
-        props.ampersand_name = props.name.replace('&', '&&');
-      }
-
-      props.outfile = props.version ? `${slugify(props.name)}-${props.version}-setup` : `${slugify(props.name)}-setup`;
-
-      if (props.languageDialog) {
-        if (!props.callbacks.includes('.onInit')) {
-          props.callbacks.unshift('.onInit');
-        }
-      }
-
-      if (props.includes.includes('MUI2')) {
-        const indexOfonGUIInit = props.callbacks.indexOf('.onGUIInit');
-        const indexOfonUserAbort = props.callbacks.indexOf('.onUserAbort');
-        if (indexOfonGUIInit !== -1) {
-          props.callbacks.splice(indexOfonGUIInit, 1, '"custom.onGUIInit"');
-        }
-        if (indexOfonUserAbort !== -1) {
-          props.callbacks.splice(indexOfonUserAbort, 1, '"custom.onUserAbort"');
-        }
-      }
-
-      this.fs.copyTpl(
-        this.templatePath('installer.nsi.ejs'),
-        this.destinationPath('installer.nsi'),
-        {
-          languageData: languageData,
-          pkg: props,
-          unlockAll: this.options['unlock-all']
-        }
-      );
-
-      if (typeof props.spdxLicense !== 'undefined') {
-        this.fs.copyTpl(
-          this.templatePath('license.txt.ejs'),
-          this.destinationPath('license.txt'),
-          {
-            licenseText: props.licenseText
-          }
-        );
-      }
-
-      if (props.editInstallerScript === true) {
-        this.spawnCommand(process.env.EDITOR, [ 'installer.nsi' ]);
-      }
-    });
-  }
-};
+import { meta as languageData } from '@nsis/language-data';
+
+import { getAllLibraries, getLanguageChoices, licenseChoices } from '../lib/helpers.js';
+import * as choices from '../lib/choices.js';
+import Generator from 'yeoman-generator';
+import semver from 'semver';
+import slugify from '@sindresorhus/slugify';
+import spdxLicenseList from 'spdx-license-list/full.js';
+import terminalLink from 'terminal-link';
+
+export default class extends Generator {
+	constructor(args, opts) {
+		super(args, opts);
+
+		this.option('first-party', { desc: 'Limits library inclusion to first-party', default: false });
+		this.option('loose-version', { desc: `Doesn't enforce semantic versioning`, default: false });
+		this.option('unlock-all', { desc: 'Unlocks all disabled features', default: false });
+		this.option('debug', { desc: 'Prints debug messages', default: false });
+
+		this.looseVersion = (this.options.looseVersion ? true : false);
+		this.disabled = (this.options.unlockAll ? false : true);
+		this.firstParty = (this.options.firstParty ? true : false);
+		this.debug = (this.options.debug ? true : false);
+	}
+
+	// languageDialog(isUnicode) {
+	// 	const languageDialog = Object.entries(languageData).map(([key, value]) => {
+	// 		if (key === 'English') return;
+
+	// 		return {
+	// 			constant: `$\{LANG_${key.toUpperCase()}}`,
+	// 			string: (isUnicode) ? value.native : (value.long || key)
+	// 		};
+	// 	});
+
+	// 	return languageDialog;
+	// }
+
+	inquirer() {
+		return this.prompt([
+			{
+				name: 'name',
+				message: `Application name`,
+				default: slugify(this.appname),
+				store: true,
+				validate: name => (name.trim().length > 0) ? true : 'Not a valid name'
+			},
+			{
+				name: 'version',
+				message: `Application version`,
+				default: '0.0.0',
+				store: true,
+				validate: version => (this.looseVersion === true || semver.valid(version) !== null) ? true : `Not a valid ${terminalLink('semantic version', 'https://semver.org', {
+					fallback() {
+						return 'semantic version';
+					}
+				})}`
+			},
+			{
+				name: 'unicode',
+				message: 'Unicode installer',
+				type: 'confirm',
+				default: 'true',
+				store: true
+			},
+			{
+				name: 'elevation',
+				message: 'Requested execution level',
+				type: 'list',
+				default: 'user',
+				store: true,
+				choices: choices.elevation
+			},
+		{
+				name: 'compression',
+				message: 'Set compression',
+				type: 'list',
+				default: 'lzma',
+				store: true,
+				choices: choices.compression
+			},
+			{
+				name: 'pages',
+				message: 'Installer pages',
+				type: 'checkbox',
+				store: true,
+				default: [ 'instfiles' ],
+				choices: choices.pages
+			},
+			{
+				name: 'spdxQuestion',
+				message: `Choose a license from ${terminalLink('SPDX License List', 'https://spdx.org/licenses/', {
+					fallback() {
+						return 'SPDX License List'
+					}
+				})}`,
+				type: 'confirm',
+				default: true,
+				store: true,
+				when: answers => answers.pages?.includes('license') ? true : false
+			},
+			{
+				name: 'spdxLicense',
+				message: 'Choose a license',
+				type: 'list',
+				default: 'MIT',
+				choices: licenseChoices,
+				store: true,
+				when: answers => answers.pages?.includes('license') && answers.spdxQuestion ? true : false
+			},
+			{
+				name: 'sections',
+				message: 'Number of sections',
+				default: 1,
+				store: true,
+				validate: number => (Number.isInteger(parseInt(number)) && parseInt(number) > 0) ? true : 'Not a valid integer'
+			},
+			{
+				name: 'callbacks',
+				message: 'Add callback functions',
+				type: 'checkbox',
+				store: true,
+				default: [],
+				choices: choices.callbacks
+			},
+			{
+				name: 'includes',
+				message: 'Add libraries',
+				type: 'checkbox',
+				store: true,
+				default: [],
+				choices: async () => this.firstParty ? choices.includes : await getAllLibraries(),
+				validate: callbacks => (callbacks.includes('MUI') && callbacks.includes('MUI2')) ? 'Don\'t mix MUI versions' : true
+			},
+			{
+				name: 'languages',
+				message: (this.disabled === true) ? 'Add languages other than English' : 'Add languages',
+				type: 'checkbox',
+				store: true,
+				default: [],
+				choices: getLanguageChoices(this.disabled)
+			},
+			{
+				name: 'languageDialog',
+				message: 'Add language dialog',
+				type: 'confirm',
+				default: 'true',
+				store: true,
+				when: answers => {
+					switch (true) {
+						case (this.options['unlock-all'] === true && answers.languages?.length > 1):
+						case (this.options['unlock-all'] === false && answers.languages?.length > 0):
+							return true;
+
+						default:
+							return false;
+					}
+				}
+			},
+			{
+				name: 'editInstallerScript',
+				message: 'Edit installer script',
+				type: 'confirm',
+				default: 'true',
+				store: true,
+				when: () => {
+					return (process.env.EDITOR) ? true : false;
+				}
+			},
+		]).then(async props => {
+
+			if (this.options.debug) {
+				console.log(props);
+			}
+
+			if (typeof props.spdxLicense !== 'undefined') {
+				props.licenseText = spdxLicenseList[props.spdxLicense].licenseText.replace(/\n{3,}/g, '\n\n');
+			}
+
+			if (props.name.includes('&')) {
+				props.ampersand_name = props.name.replace('&', '&&');
+			}
+
+			props.outfile = props.version ? `${slugify(props.name)}-${props.version}-setup` : `${slugify(props.name)}-setup`;
+
+			if (props.languageDialog) {
+				if (!props.callbacks.includes('.onInit')) {
+					props.callbacks.unshift('.onInit');
+				}
+			}
+
+			if (props.includes?.includes('MUI2')) {
+				const includesOnGUIInit = props.callbacks.indexOf('.onGUIInit');
+
+				if (includesOnGUIInit !== -1) {
+					props.callbacks.splice(includesOnGUIInit, 1, 'MUI.onGUIInit');
+				}
+
+				const includesOnUserAbort = props.callbacks.indexOf('.onUserAbort');
+
+				if (includesOnUserAbort !== -1) {
+					props.callbacks.splice(includesOnUserAbort, 1, 'MUI.onUserAbort');
+				}
+			}
+
+			await this.fs.copyTplAsync(
+				this.templatePath('installer.nsi.ejs'),
+				this.destinationPath('installer.nsi'),
+				{
+					languageData: languageData,
+					pkg: props,
+					unlockAll: this.options['unlock-all'],
+					debug: this.options.debug
+				}
+			);
+
+			if (typeof props.spdxLicense !== 'undefined') {
+				await this.fs.copyTplAsync(
+					this.templatePath('license.txt.ejs'),
+					this.destinationPath('license.txt'),
+					{
+						licenseText: props.licenseText
+					}
+				);
+			}
+
+			if (props.editInstallerScript === true) {
+				this.spawnCommand(process.env.EDITOR, [ 'installer.nsi' ]);
+			}
+		});
+	}
+}