generator-nsis 0.11.0 → 0.11.2

package/README.md

@@ -13,12 +13,12 @@
 - Modern UI-aware
 - adds sections
 - adds core libraries (”Useful Headers”)
-- adds callback functions
+- adds lifecycle functions
 - adds translations
 - adds languages (with optional dialog)
 - defaults to SemVer
 - SPDX license support
-   
+
 ## Prerequisites
 
 You need [Node.js](https://nodejs.org/en/) installed and available in your `PATH` [environment variable](http://superuser.com/a/284351/195953). Use your preferred Node package manager to install the Yeoman CLI tool.
@@ -29,7 +29,7 @@ $ npm install -g yo
 
 ## Installation
 
- Use your preferred package manager to install this generator
+Use your preferred package manager to install this generator
 
 ```sh
 $ npm i generator-nsis -g
@@ -43,7 +43,7 @@ Run the generator and follow its instructions. Use `--help` for available flags.
 $ yo nsis
 ```
 
-*“That's all Folks!”*
+_“That's all Folks!”_
 
 ## License
 

package/generators/app/index.js

@@ -1,7 +1,7 @@
 import { meta as languageData } from '@nsis/language-data';
 
-import { getAllLibraries, getLanguageChoices, licenseChoices } from '../lib/helpers.js';
-import * as choices from '../lib/choices.js';
+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';
@@ -21,6 +21,8 @@ export default class extends Generator {
 		this.disabled = this.options.unlockAll ? false : true;
 		this.firstParty = this.options.firstParty ? true : false;
 		this.debug = this.options.debug ? true : false;
+
+		globalThis.console.log(/* let it breathe */);
 	}
 
 	inquirer() {
@@ -30,14 +32,14 @@ export default class extends Generator {
 				message: `Application name`,
 				default: slugify(this.appname),
 				store: true,
-				validate: name => (name.trim().length > 0 ? true : 'Not a valid name'),
+				validate: (name) => (name.trim().length > 0 ? true : 'Not a valid name'),
 			},
 			{
 				name: 'version',
 				message: `Application version`,
 				default: '0.0.0',
 				store: true,
-				validate: version =>
+				validate: (version) =>
 					this.looseVersion === true || semver.valid(version) !== null
 						? true
 						: `Not a valid ${terminalLink('semantic version', 'https://semver.org', {
@@ -83,7 +85,7 @@ export default class extends Generator {
 				type: 'confirm',
 				default: true,
 				store: true,
-				when: answers => (answers.pages?.includes('license') ? true : false),
+				when: (answers) => (answers.pages?.includes('license') ? true : false),
 			},
 			{
 				name: 'spdxLicense',
@@ -92,22 +94,23 @@ export default class extends Generator {
 				default: 'MIT',
 				choices: licenseChoices,
 				store: true,
-				when: answers => (answers.pages?.includes('license') && answers.spdxQuestion ? true : false),
+				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'),
+				validate: (number) =>
+					Number.isInteger(parseInt(number)) && parseInt(number) > 0 ? true : 'Not a valid integer',
 			},
 			{
-				name: 'callbacks',
-				message: 'Add callback functions',
+				name: 'lifecycles',
+				message: 'Add lifecycle functions',
 				type: 'checkbox',
 				store: true,
 				default: [],
-				choices: choices.callbacks,
+				choices: choices.lifecycles,
 			},
 			{
 				name: 'includes',
@@ -116,8 +119,8 @@ export default class extends Generator {
 				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,
+				validate: (lifecycles) =>
+					lifecycles.includes('MUI') && lifecycles.includes('MUI2') ? "Don't mix MUI versions" : true,
 			},
 			{
 				name: 'languages',
@@ -133,7 +136,7 @@ export default class extends Generator {
 				type: 'confirm',
 				default: 'true',
 				store: true,
-				when: answers => {
+				when: (answers) => {
 					switch (true) {
 						case this.options['unlock-all'] === true && answers.languages?.length > 1:
 						case this.options['unlock-all'] === false && answers.languages?.length > 0:
@@ -144,9 +147,9 @@ export default class extends Generator {
 					}
 				},
 			},
-		]).then(async props => {
+		]).then(async (props) => {
 			if (this.options.debug) {
-				console.log(props);
+				globalThis.console.log(props);
 			}
 
 			if (typeof props.spdxLicense !== 'undefined') {
@@ -165,22 +168,22 @@ export default class extends Generator {
 			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.lifecycles.includes('.onInit')) {
+					props.lifecycles.unshift('.onInit');
 				}
 			}
 
 			if (props.includes?.includes('MUI2')) {
-				const includesOnGUIInit = props.callbacks.indexOf('.onGUIInit');
+				const includesOnGUIInit = props.lifecycles.indexOf('.onGUIInit');
 
 				if (includesOnGUIInit !== -1) {
-					props.callbacks.splice(includesOnGUIInit, 1, 'MUI.onGUIInit');
+					props.lifecycles.splice(includesOnGUIInit, 1, 'MUI.onGUIInit');
 				}
 
-				const includesOnUserAbort = props.callbacks.indexOf('.onUserAbort');
+				const includesOnUserAbort = props.lifecycles.indexOf('.onUserAbort');
 
 				if (includesOnUserAbort !== -1) {
-					props.callbacks.splice(includesOnUserAbort, 1, 'MUI.onUserAbort');
+					props.lifecycles.splice(includesOnUserAbort, 1, 'MUI.onUserAbort');
 				}
 			}
 

package/generators/app/templates/installer.nsi.ejs

@@ -13,8 +13,8 @@ RequestExecutionLevel <%= pkg.elevation %>
 InstallDir "$PROGRAMFILES\<%- pkg.name %>"<% if (!pkg.includes?.includes('MUI2') && pkg.pages?.includes('license')) { %>
 LicenseData "<% if (typeof pkg.spdxLicense !== 'undefined') { %>license.txt<% } %>"<% } %>
 <% if (pkg.includes?.includes('MUI2')) { %>
-# Modern UI --------------------------------<% if (pkg.callbacks?.includes('MUI.onGUIInit')) { %>
-!define MUI_CUSTOMFUNCTION_GUIINIT "MUI.onGUIInit"<% } %><% if (pkg.callbacks?.includes('MUI.onUserAbort')) { %>
+# Modern UI --------------------------------<% if (pkg.lifecycles?.includes('MUI.onGUIInit')) { %>
+!define MUI_CUSTOMFUNCTION_GUIINIT "MUI.onGUIInit"<% } %><% if (pkg.lifecycles?.includes('MUI.onUserAbort')) { %>
 !define MUI_CUSTOMFUNCTION_ABORT "MUI.onUserAbort"<% } %>
 <% } %>
 # Pages ------------------------------------
@@ -36,9 +36,9 @@ LangString DESC_SECTION_<%= step + 1 %> ${LANG_<%= language.toUpperCase() %>} "<
     !insertmacro MUI_DESCRIPTION_TEXT ${SECTION_<%= step + 1 %>} $(DESC_SECTION_<%= step + 1 %>)<% } %>
 !insertmacro MUI_FUNCTION_DESCRIPTION_END
 <% } %>
-# Functions --------------------------------<% pkg.callbacks?.forEach( callback => { %>
-Function <%- callback %>
-<% if (callback === '.onInit' && pkg.languageDialog) { %>    Call LanguageDialog<%= '\n' %><% } %>FunctionEnd
+# Functions --------------------------------<% pkg.lifecycles?.forEach( lifecycle => { %>
+Function <%- lifecycle %>
+<% if (lifecycle === '.onInit' && pkg.languageDialog) { %>    Call LanguageDialog<%= '\n' %><% } %>FunctionEnd
 <% }); %><% if (pkg.languageDialog) { %>
 Function LanguageDialog
     Push ""
@@ -54,4 +54,4 @@ Function LanguageDialog
     Abort
 FunctionEnd
 <% } %>
-<% JSON.stringify(pkg.callbacks) %>
+<% JSON.stringify(pkg.lifecycles) %>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generator-nsis",
-  "version": "0.11.0",
+  "version": "0.11.2",
   "description": "Yeoman generator for NSIS scripts",
   "author": "Jan T. Sott",
   "license": "MIT",
@@ -26,32 +26,37 @@
     "node": ">=18"
   },
   "dependencies": {
-    "@nsis/language-data": "^0.9.2",
+    "@nsis/language-data": "^0.9.3",
     "@sindresorhus/slugify": "^2.2.1",
-    "glob": "^10.3.12",
-    "makensis": "^3.0.0-alpha.3",
-    "semver": "^7.6.0",
-    "spdx-license-list": "^6.9.0",
-    "terminal-link": "^3.0.0",
-    "yeoman-generator": "^7.1.1"
+    "glob": "^11.0.3",
+    "makensis": "3.0.0",
+    "semver": "^7.7.2",
+    "spdx-license-list": "^6.10.0",
+    "terminal-link": "^4.0.0",
+    "yeoman-generator": "^7.5.1"
   },
   "devDependencies": {
+    "@eslint/js": "^9.29.0",
     "@lukeed/uuid": "^2.0.1",
-    "ejs-lint": "^2.0.0",
-    "eslint": "^8.57.0",
-    "eslint-plugin-json": "^3.1.0",
-    "husky": "^9.0.11",
-    "lint-staged": "^15.2.2",
-    "mem-fs": "^4.1.0",
-    "np": "^10.0.2",
-    "npm-run-all2": "^6.1.2",
-    "prettier": "^3.2.5",
-    "rimraf": "^5.0.5",
+    "@types/node": "^22.15.33",
+    "concurrently": "^9.2.0",
+    "ejs-lint": "^2.0.1",
+    "eslint": "9.29.0",
+    "eslint-plugin-jsonc": "^2.20.1",
+    "eslint-plugin-unicorn": "^59.0.1",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.1.2",
+    "mem-fs": "^4.1.2",
+    "np": "^10.2.0",
+    "prettier": "^3.6.1",
+    "rimraf": "^6.0.1",
     "tsm": "^2.3.0",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "8.35.0",
     "uvu": "^0.5.6",
     "yeoman-assert": "^3.1.1",
-    "yeoman-environment": "^4.4.0",
-    "yeoman-test": "^8.2.0"
+    "yeoman-environment": "^4.4.3",
+    "yeoman-test": "^10.1.1"
   },
   "lint-staged": {
     "*.ejs": "ejslint",
@@ -60,12 +65,11 @@
       "prettier --write"
     ]
   },
-  "packageManager": "pnpm@8.15.2+sha256.90bb5d6382cb2cb8b8d4959a076b3953d84d1d94121717097bcd41c71344fa14",
   "scripts": {
     "lint:ejs": "ejslint generators/**/*.ejs",
-    "lint:js": "eslint generators/**/*.js --ignore-path .gitignore",
-    "lint:json": "eslint ./*.json --ignore-path .gitignore",
-    "lint": "npm-run-all --parallel lint:*",
-    "test": "uvu --ignore test/__helper.js"
+    "lint:code": "eslint **/*.json ./generators/**/*.js --no-warn-ignored",
+    "lint": "concurrently --prefix '{name}' -c 'green,blue' 'npm:lint:*'",
+    "publish:npm": "np --any-branch",
+    "test": "uvu --ignore tests/__helper.js"
   }
 }

package/generators/lib/choices.js

@@ -1,229 +0,0 @@
-import terminalLink from 'terminal-link';
-
-const docsURL = 'https://github.com/NSIS-Dev/Documentation/tree/main/docs/';
-
-export const binary = [false, true];
-export const elevation = ['user', 'highest', 'admin', 'none'];
-export const compression = ['zlib', 'bzip2', 'lzma'];
-
-export const callbacks = [
-	{
-		name: terminalLink('.onInit', `${docsURL}/Callbacks/onInit.md`, {
-			fallback: false,
-		}),
-		value: '.onInit',
-	},
-	{
-		name: terminalLink('.onGUIInit', `${docsURL}/Callbacks/onGUIInit.md`, {
-			fallback: false,
-		}),
-		value: '.onGUIInit',
-	},
-	{
-		name: terminalLink('.onGUIEnd', `${docsURL}/Callbacks/onGUIEnd.md`, {
-			fallback: false,
-		}),
-		value: '.onGUIEnd',
-	},
-	{
-		name: terminalLink('.onInstSuccess', `${docsURL}/Callbacks/onInstSuccess.md`, {
-			fallback: false,
-		}),
-		value: '.onInstSuccess',
-	},
-	{
-		name: terminalLink('.onInstFailed', `${docsURL}/Callbacks/onInstFailed.md`, {
-			fallback: false,
-		}),
-		value: '.onInstFailed',
-	},
-	{
-		name: terminalLink('.onUserAbort', `${docsURL}/Callbacks/onUserAbort.md`, {
-			fallback: false,
-		}),
-		value: '.onUserAbort',
-	},
-	{
-		name: terminalLink('.onVerifyInstDir', `${docsURL}/Callbacks/onVerifyInstDir.md`, {
-			fallback: false,
-		}),
-		value: '.onVerifyInstDir',
-	},
-	{
-		name: terminalLink('.onRebootFailed', `${docsURL}/Callbacks/onRebootFailed.md`, {
-			fallback: false,
-		}),
-		value: '.onRebootFailed',
-	},
-	{
-		name: terminalLink('.onSelChange', `${docsURL}/Callbacks/onSelChange.md`, {
-			fallback: false,
-		}),
-		value: '.onSelChange',
-	},
-	{
-		name: terminalLink('.onMouseOverSection', `${docsURL}/Callbacks/onMouseOverSection.md`, {
-			fallback: false,
-		}),
-		value: '.onMouseOverSection',
-	},
-];
-
-export const includes = [
-	{
-		name: 'Colors.nsh',
-		value: 'Colors',
-		checked: false,
-	},
-	{
-		name: terminalLink('FileFunc.nsh', `${docsURL}/Includes/FileFunc`, {
-			fallback: false,
-		}),
-		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: false,
-		}),
-		value: 'LogicLib',
-		checked: false,
-	},
-	{
-		name: terminalLink('Memento.nsh', `${docsURL}/Includes/Memento`, {
-			fallback: false,
-		}),
-		value: 'Memento',
-		checked: false,
-	},
-	{
-		name: 'MUI.nsh',
-		value: 'MUI',
-		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: false,
-		}),
-		value: 'StrFunc',
-		checked: false,
-	},
-	{
-		name: terminalLink('TextFunc.nsh', `${docsURL}/Includes/TextFunc`, {
-			fallback: false,
-		}),
-		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: false,
-		}),
-		value: 'WinVer',
-		checked: false,
-	},
-	{
-		name: terminalLink('WordFunc.nsh', `${docsURL}/Includes/WordFunc`, {
-			fallback: false,
-		}),
-		value: 'WordFunc',
-		checked: false,
-	},
-	{
-		name: terminalLink('x64.nsh', `${docsURL}/Includes/x64`, {
-			fallback: false,
-		}),
-		value: 'x64',
-		checked: false,
-	},
-];
-
-export const pages = [
-	{
-		name: 'license',
-		value: 'license',
-	},
-	{
-		name: 'components',
-		value: 'components',
-	},
-	{
-		name: 'directory',
-		value: 'directory',
-	},
-	{
-		name: 'instfiles',
-		value: 'instfiles',
-		checked: true,
-	},
-];

package/generators/lib/helpers.js

@@ -1,68 +0,0 @@
-import { basename, extname, resolve } from 'node:path';
-import { includes as bundledLibraries } from './choices.js';
-import { glob } from 'glob';
-import { meta as languageData } from '@nsis/language-data';
-import { nsisDir } from 'makensis';
-import spdxLicenseList from 'spdx-license-list/full.js';
-import terminalLink from 'terminal-link';
-
-const spdxCodes = Object.getOwnPropertyNames(spdxLicenseList).sort();
-
-export const licenseChoices = spdxCodes.map(obj => {
-	const licenses = {};
-	licenses['name'] = terminalLink(obj, `https://spdx.org/licenses/${obj}.html`, {
-		fallback: true,
-	});
-	licenses['value'] = obj;
-
-	return licenses;
-});
-
-export const getAllLibraries = async () => {
-	const nsisPath = await nsisDir();
-	const includeDir = resolve(nsisPath, 'Include');
-
-	const headerFiles = await glob([`${includeDir}/*.nsh`, `!${includeDir}/MUI.nsh`], {
-		ignore: bundledLibraries.map(excludedFile => `${includeDir}/${excludedFile.value}.nsh`),
-	});
-
-	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, z) => a.value.localeCompare(z.value));
-};
-
-export function getLanguageChoices(disabled) {
-	const languageChoices = Object.entries(languageData).map(([key, value]) => {
-		const isDisabled = key === 'English' ? disabled : false;
-
-		// Use long names
-		return {
-			name: value.english || key,
-			value: key,
-			disabled: isDisabled,
-		};
-	});
-
-	// Sort names
-	languageChoices.sort((a, z) => {
-		if (a.name < z.name) {
-			return -1;
-		}
-
-		if (a.name > z.name) {
-			return 1;
-		}
-
-		return 0;
-	});
-
-	return languageChoices;
-}