@nsis/dent-cli 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Jan T. Sott
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,39 @@
+# @nsis/dent-cli
+
+> An opinionated code formatter for NSIS scripts
+
+[![License](https://img.shields.io/github/license/idleberg/node-dent-cli?color=blue&style=for-the-badge)](https://github.com/idleberg/node-dent-cli/blob/main/LICENSE)
+[![npm](https://img.shields.io/npm/v/@nsis/dent-cli?style=for-the-badge)](https://www.npmjs.org/package/@nsis/dent-cli)
+[![Build](https://img.shields.io/github/actions/workflow/status/idleberg/node-dent-cli/default.yml?style=for-the-badge)](https://github.com/idleberg/node-dent-cli/actions)
+
+## Prerequisites
+
+This is a TypeScript applicaiton that dependes on a [NodeJS](https://nodejs.org) runtime installed on your computer.
+
+## Usage
+
+### Installation
+
+You could install the `dent` CLI globally
+
+```sh
+$ npm install --global @nsis/dent-cli`
+$ dent --help
+```
+
+### Single use
+
+Download and execute the latest version using [`npx`](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b).
+
+```sh
+$ npx dent --help
+```
+
+## Related
+
+- [`dent` Library](https://www.npmjs.com/package/@nsis/dent)
+
+## License
+
+This work is licensed under [The MIT License](LICENSE)
+  

package/bin/cli.mjs

@@ -0,0 +1,88 @@
+import { Command } from 'commander';
+import { fileURLToPath } from 'node:url';
+import { dirname, resolve } from 'node:path';
+import { promises } from 'node:fs';
+import { Dent } from '@nsis/dent';
+import { glob } from 'glob';
+import logSymbols from 'log-symbols';
+import colors from 'picocolors';
+
+await main();
+async function main() {
+    const program = new Command();
+    const version = await getVersion();
+    program
+        .version(version)
+        .description('CLI tool to format NSIS scripts')
+        .arguments('<file...>')
+        .option('--eol <"crlf"|"lf">', 'control how line-breaks are represented', value => ['crlf', 'lf'].includes(value))
+        .option('-i, --indent-size <number>', 'number of units per indentation level', value => parseInt(value, 10), 2)
+        .option('-s, --use-spaces', 'indent with spaces instead of tabs', false)
+        .option('--trim', 'trim empty lines', true)
+        .option('--write', 'edit files in-place', false)
+        .option('--quiet', 'suppress output', false)
+        .option('--debug', 'prints additional debug messages', false)
+        .parse(process.argv);
+    const options = program.opts();
+    const args = Array.isArray(program.args)
+        ? program.args
+        : [program.args];
+    if (!args.length) {
+        program.help();
+    }
+    if (options.debug) {
+        console.log('\nCLI parameters:', { args, options });
+    }
+    const dent = new Dent({
+        endOfLines: options.eol,
+        indentSize: options.indent,
+        trimEmptyLines: options.trim,
+        useTabs: !options.useSpaces
+    });
+    const files = await glob(args);
+    const isVerbose = options.write && !options.quiet;
+    if (isVerbose && !options.debug) {
+        console.log( /* let it breathe */);
+    }
+    console.time('\nCompleted');
+    await Promise.all(files.map(async (file) => {
+        if (isVerbose) {
+            console.time(`${logSymbols.success} ${colors.blue(file)}`);
+        }
+        const rawContents = (await promises.readFile(file)).toString();
+        const formattedContents = dent.format(rawContents);
+        if (options.debug) {
+            console.log('\nConversion:', {
+                raw: rawContents,
+                formatted: formattedContents
+            });
+        }
+        if (options.write) {
+            try {
+                await promises.writeFile(file, formattedContents, {
+                    encoding: 'utf-8'
+                });
+                if (isVerbose) {
+                    console.timeEnd(`${logSymbols.success} ${colors.blue(file)}`);
+                }
+            }
+            catch (error) {
+                if (isVerbose) {
+                    console.error(`${logSymbols.error} ${colors.blue(file)}\n${colors.dim(error instanceof Error ? error.message : error)}`);
+                }
+            }
+        }
+        else {
+            console.log(formattedContents);
+        }
+    }));
+    if (isVerbose) {
+        console.timeEnd(`\nCompleted`);
+    }
+}
+async function getVersion() {
+    const __filename = fileURLToPath(import.meta.url);
+    const __dirname = dirname(__filename);
+    const { version } = JSON.parse(await promises.readFile(resolve(__dirname, '../package.json'), 'utf8'));
+    return version || 'dev';
+}

package/index.mjs

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import './bin/cli.mjs';

package/package.json

@@ -0,0 +1,63 @@
+{
+	"name": "@nsis/dent-cli",
+	"version": "0.1.0",
+	"description": "An opinionated code formatter for NSIS scripts",
+	"license": "MIT",
+	"scripts": {
+		"build": "rollup --config",
+		"dev": "npm run start",
+		"fix": "eslint --fix ./src",
+		"lint:json": "eslint ./*.json --ignore-path .gitignore",
+		"lint:ts": "eslint ./src --ignore-path .gitignore",
+		"lint": "npm-run-all --parallel lint:*",
+		"prepack": "npm run build",
+		"start": "npm run build -- --watch",
+		"prepare": "husky install"
+	},
+	"files": [
+		"bin/",
+		"LICENSE",
+		"README.md"
+	],
+	"type": "module",
+	"bin": {
+		"dent": "index.mjs"
+	},
+	"engines": {
+		"node": "^14.13.1 || >=16.0.0"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/idleberg/node-dent.git"
+	},
+	"keywords": [
+		"nsis",
+		"formatter"
+	],
+	"dependencies": {
+		"@nsis/dent": "^0.2.0",
+		"commander": "^10.0.1",
+		"glob": "^10.2.6",
+		"log-symbols": "^5.1.0",
+		"picocolors": "^1.0.0"
+	},
+	"devDependencies": {
+		"@rollup/plugin-commonjs": "^25.0.0",
+		"@rollup/plugin-json": "^6.0.0",
+		"@rollup/plugin-typescript": "^11.1.1",
+		"@types/node": "^20.2.3",
+		"@typescript-eslint/eslint-plugin": "^5.59.6",
+		"@typescript-eslint/parser": "^5.59.6",
+		"eslint": "^8.41.0",
+		"eslint-plugin-json": "^3.1.0",
+		"husky": "^8.0.3",
+		"lint-staged": "^13.2.2",
+		"npm-run-all2": "^6.0.5",
+		"rollup": "^3.23.0",
+		"tslib": "^2.5.2",
+		"typescript": "^5.0.4"
+	},
+	"lint-staged": {
+		"*.(json|ts)": "eslint --cache --fix"
+	}
+}