generator-nsis 0.8.10 → 0.10.0

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

@@ -1,8 +1,8 @@
 # Generated with generator-nsis
 # https://github.com/idleberg/generator-nsis
 
-# Includes ---------------------------------<% pkg.includes.forEach( include => { %>
-!include "<%= include %>.nsh"<% }); %>
+# Includes ---------------------------------<% pkg.includes?.forEach( include => { %>
+!include "<%= include %>"<% }); %>
 
 # Settings ---------------------------------
 Name "<%- pkg.name %>"<% if (typeof pkg.ampersand_name !== 'undefined') { %> "<%- pkg.ampersand_name %>"<% } %>
@@ -10,40 +10,40 @@ OutFile "<%= pkg.outfile %>.exe"
 Unicode <%= pkg.unicode %>
 SetCompressor <%= pkg.compression %>
 RequestExecutionLevel <%= pkg.elevation %>
-InstallDir "$PROGRAMFILES\<%- pkg.name %>"<% if (!pkg.includes.includes('MUI2') && pkg.pages.includes('license')) { %>
+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') && (pkg.callbacks.includes('"custom.onGUIInit"') || pkg.callbacks.includes('"custom.onUserAbort"'))) { %>
-# Modern UI --------------------------------
-<% if (pkg.callbacks.includes('"custom.onGUIInit"')) { %>!define MUI_CUSTOMFUNCTION_GUIINIT "custom.onGUIInit"<% } %><% if (pkg.callbacks.includes('"custom.onUserAbort"')) { %>
-!define MUI_CUSTOMFUNCTION_ABORT "custom.onUserAbort"<% } %>
+<% 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')) { %>
+!define MUI_CUSTOMFUNCTION_ABORT "MUI.onUserAbort"<% } %>
 <% } %>
 # Pages ------------------------------------
-<% pkg.pages.forEach( page => { %><% if (pkg.includes.includes('MUI2')) { %>!insertmacro MUI_PAGE_<%= page.toUpperCase() %><% if (page === 'license' && typeof pkg.spdxLicense !== 'undefined') { %> "license.txt"<% } %><% } else { %>Page <%= page %><% } %>
+<% pkg.pages?.forEach( page => { %><% if (page?.length) { %><% if (pkg.includes?.includes('MUI2')) { %>!insertmacro MUI_PAGE_<%= page.toUpperCase() %><% if (page === 'license' && typeof pkg.spdxLicense !== 'undefined') { %> "license.txt"<% } %><% } else { %>Page <%= page %><% } %><% } %>
 <% }); %>
 # Languages --------------------------------<% if (unlockAll === false) { %>
-<% if (pkg.includes.includes('MUI2')) { %>!insertmacro MUI_LANGUAGE "English"<% } else { %>LoadLanguageFile "${NSISDIR}\Contrib\Language files\English.nlf"<% } %><% } %><% pkg.languages.forEach( language => { %>
-<% if (pkg.includes.includes('MUI2')) { %>!insertmacro MUI_LANGUAGE "<%= language %>"<% } else { %>LoadLanguageFile "${NSISDIR}\Contrib\Language files\<%= language %>.nlf"<% } %><% }); %>
+<% if (pkg.includes?.includes('MUI2')) { %>!insertmacro MUI_LANGUAGE "English"<% } else { %>LoadLanguageFile "${NSISDIR}\Contrib\Language files\English.nlf"<% } %><% } %><% pkg.languages?.forEach( language => { %>
+<% if (pkg.includes?.includes('MUI2')) { %>!insertmacro MUI_LANGUAGE "<%= language %>"<% } else { %>LoadLanguageFile "${NSISDIR}\Contrib\Language files\<%= language %>.nlf"<% } %><% }); %>
 
 # Sections ---------------------------------<% for (let step = 0; step < parseInt(pkg.sections); step++) { %>
-Section "section" SECTION_<%= step %>
+Section "section" SECTION_<%= step + 1 %>
 SectionEnd
-<% } %><% if (pkg.includes.includes('MUI2')) { %>
+<% } %><% if (pkg.includes?.includes('MUI2')) { %>
 # Descriptions -----------------------------<% for (let step = 0; step < parseInt(pkg.sections); step++) { %><% if (unlockAll === false) { %>
-LangString DESC_SECTION_<%= step %> ${LANG_ENGLISH} "English description for section <%= step %>"<% } %><% pkg.languages.forEach( language => { %>
-LangString DESC_SECTION_<%= step %> ${LANG_<%= language.toUpperCase() %>} "<%= language %> description for section <%= step %>"<% }); %>
+LangString DESC_SECTION_<%= step + 1 %> ${LANG_ENGLISH} "English description for section <%= step + 1%>"<% } %><% pkg.languages?.forEach( language => { %>
+LangString DESC_SECTION_<%= step + 1 %> ${LANG_<%= language.toUpperCase() %>} "<%= language %> description for section <%= step + 1 %>"<% }); %>
 <% } %>
 !insertmacro MUI_FUNCTION_DESCRIPTION_BEGIN<% for (let step = 0; step < parseInt(pkg.sections); step++) { %>
-    !insertmacro MUI_DESCRIPTION_TEXT ${SECTION_<%= step %>} $(DESC_SECTION_<%= step %>)<% } %>
+    !insertmacro MUI_DESCRIPTION_TEXT ${SECTION_<%= step + 1 %>} $(DESC_SECTION_<%= step + 1 %>)<% } %>
 !insertmacro MUI_FUNCTION_DESCRIPTION_END
 <% } %>
-# Functions --------------------------------<% pkg.callbacks.forEach( callback => { %>
+# Functions --------------------------------<% pkg.callbacks?.forEach( callback => { %>
 Function <%- callback %>
 <% if (callback === '.onInit' && pkg.languageDialog) { %>    Call LanguageDialog<%= '\n' %><% } %>FunctionEnd
 <% }); %><% if (pkg.languageDialog) { %>
 Function LanguageDialog
     Push ""
     Push ${LANG_ENGLISH}
-    Push English<% pkg.languages.forEach( language => { %>
+    Push English<% pkg.languages?.forEach( language => { %>
     Push ${LANG_<%- language.toUpperCase() %>}
     Push "<% if (pkg.unicode) { %><%- languageData[language].native %><% } else { %><%- languageData[language].long || language %><% } %>"<% }); %>
     Push A
@@ -53,4 +53,5 @@ Function LanguageDialog
     StrCmp $LANGUAGE "cancel" 0 +2
     Abort
 FunctionEnd
-<% } %>
+<% } %>
+<% JSON.stringify(pkg.callbacks) %>

package/generators/lib/choices.js

@@ -0,0 +1,265 @@
+import terminalLink from 'terminal-link';
+
+const docsURL = 'https://github.com/NSIS-Dev/Documentation/tree/master';
+
+export const binary = [false, true];
+export const elevation = ['user', 'highest', 'admin', 'none'];
+export const compression = ['zlib', 'bzip2', 'lzma'];
+
+export const callbacks = [
+	{
+		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'
+	},
+];
+
+export const includes = [
+	{
+		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: '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() {
+				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
+	}
+];
+
+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

@@ -0,0 +1,70 @@
+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() {
+			return obj;
+		}
+	});
+	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;
+}

package/license.txt

@@ -0,0 +1,7 @@
+<copyright notice>
+
+By obtaining, using, and/or copying this software and/or its associated documentation, you agree that you have read, understood, and will comply with the following terms and conditions:
+
+Permission to use, copy, modify, and distribute this software and its associated documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appears in all copies, and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of the copyright holder not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission.
+
+THE COPYRIGHT HOLDER DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM THE LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/package.json

@@ -1,52 +1,64 @@
 {
   "name": "generator-nsis",
-  "version": "0.8.10",
+  "version": "0.10.0",
   "description": "Yeoman generator for NSIS scripts",
-  "main": "generators/app",
+  "author": "Jan T. Sott",
+  "license": "MIT",
+  "keywords": [
+    "yeoman-generator",
+    "nsis",
+    "nullsoft",
+    "installer",
+    "setup"
+  ],
+  "type": "module",
+  "exports": "./generators/app",
   "files": [
-    "generators"
+    "generators",
+    "LICENSE",
+    "README.md"
   ],
   "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:*",
+    "prepare": "husky",
     "publish": "np --no-yarn",
-    "test": "npm run lint"
+    "test": "uvu --ignore test/__helper.js"
   },
-  "keywords": [
-    "yeoman-generator",
-    "nsis",
-    "nullsoft",
-    "installer",
-    "setup"
-  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/idleberg/generator-nsis"
   },
-  "author": "",
-  "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  },
   "dependencies": {
-    "@nsis/language-data": "^0.9.0",
-    "@sindresorhus/slugify": "^1.1.2",
-    "globby": "^11.1.0",
-    "makensis": "^1.1.3",
-    "semver": "^7.3.7",
-    "spdx-license-list": "^6.6.0",
-    "terminal-link": "^2.1.1",
-    "update-notifier": "^5.1.0",
-    "yeoman-generator": "^4.13.0"
+    "@nsis/language-data": "^0.9.2",
+    "@sindresorhus/slugify": "^2.2.1",
+    "glob": "^10.3.10",
+    "makensis": "^2.0.8",
+    "semver": "^7.5.4",
+    "spdx-license-list": "^6.8.0",
+    "terminal-link": "^3.0.0",
+    "yeoman-generator": "^7.1.1"
   },
   "devDependencies": {
-    "ejs-lint": "^1.2.2",
-    "eslint": "^8.18.0",
+    "@lukeed/uuid": "^2.0.1",
+    "ejs-lint": "^2.0.0",
+    "eslint": "^8.56.0",
     "eslint-plugin-json": "^3.1.0",
-    "esprima": "^4.0.1",
-    "husky": "^8.0.1",
-    "lint-staged": "^13.0.3",
-    "np": "^7.6.2",
-    "npm-run-all": "^4.1.5"
+    "husky": "^9.0.7",
+    "lint-staged": "^15.2.0",
+    "mem-fs": "^4.0.0",
+    "np": "^9.2.0",
+    "npm-run-all2": "^6.1.1",
+    "tsm": "^2.3.0",
+    "uvu": "^0.5.6",
+    "yeoman-assert": "^3.1.1",
+    "yeoman-environment": "^4.3.0",
+    "yeoman-test": "^8.2.0"
   },
   "lint-staged": {
     "*.ejs": "ejslint",