@nsis/dent 0.2.1 → 0.3.0

package/README.md

@@ -10,7 +10,51 @@
 
 `npm install @nsis/dent`
 
+## Usage
+
+```ts
+import { createFormatter } from '@nsis/dent';
+
+const format = createFormatter(/* user options */);
+
+format(`
+	# Look ma, no indentation
+	Name "Demo"
+	Section
+	Nop
+	Section
+`);
+```
+
+### Options
+
+#### `options.endOfLines`
+
+Type: `"crlf" | "lf"`  
+Default: `"crlf"` (Windows), `"lf"` (Linux, macOS)
+
+#### `options.indentSize`
+
+Type: `number`  
+Default: `2`  
+
+#### `options.trimEmptyLines`
+
+Type: `boolean`  
+Default: `true`  
+
+#### `options.useTabs`
+
+Type: `boolean`  
+Default: `true`  
+
+:white_check_mark: [Why defaulting to tabs is good for accessibility](https://github.com/prettier/prettier/issues/7475#issuecomment-668544890)
+
+## Related
+
+- [CLI for `dent`](https://www.npmjs.com/package/@nsis/dent-cli)
+
 ## License
 
 This work is licensed under [The MIT License](LICENSE)
-  
+  

package/dist/index.mjs

@@ -75,31 +75,25 @@ var rules = {
 
 // src/main.ts
 var defaultIndentation = 2;
-var Dent = class {
-  options;
-  constructor(options = {}) {
-    this.options = {
-      endOfLines: platform() === "win32" ? "crlf" : "lf",
-      indentSize: defaultIndentation,
-      trimEmptyLines: true,
-      useTabs: true,
-      ...options
-    };
-    if (options.useTabs === true && options.indentSize) {
-      throw Error("The indentSize option can only be mixed with useTabs");
-    }
-    if (options.useTabs === false && options.indentSize) {
-      if (isNaN(options.indentSize) || options.indentSize <= 0) {
-        throw Error("The indentSize option expects a positive integer");
-      }
+function createFormatter(options = {}) {
+  const mergedOptions = {
+    endOfLines: platform() === "win32" ? "crlf" : "lf",
+    indentSize: defaultIndentation,
+    trimEmptyLines: true,
+    useTabs: true,
+    ...options
+  };
+  if (mergedOptions.useTabs === false && mergedOptions.indentSize) {
+    if (isNaN(mergedOptions.indentSize) || mergedOptions.indentSize <= 0) {
+      throw Error("The indentSize option expects a positive integer");
     }
   }
-  format(fileContents) {
+  function format(fileContents) {
     let indentationLevel = 0;
     let switchIndentationLevel = 0;
-    const lineEndings = this.detectEOL(fileContents);
+    const lineEndings = detectEOL(fileContents);
     const formattedLines = [];
-    const lines = this.options.trimEmptyLines === true ? fileContents.trim().replaceAll(/^(\s*\r?\n){2,}/gm, lineEndings).split(lineEndings) : fileContents.split(lineEndings);
+    const lines = mergedOptions.trimEmptyLines === true ? fileContents.trim().replaceAll(/^(\s*\r?\n){2,}/gm, lineEndings).split(lineEndings) : fileContents.split(lineEndings);
     lines.forEach((line) => {
       const keyword = line.trim().split(" ").at(0) ?? "";
       if (keyword.toLowerCase() === "${Switch}") {
@@ -108,37 +102,37 @@ var Dent = class {
       switch (true) {
         case keyword.toLowerCase() === "${EndSwitch}":
           indentationLevel = switchIndentationLevel;
-          formattedLines.push(this.appendLine(line, indentationLevel));
+          formattedLines.push(appendLine(line, indentationLevel));
           indentationLevel = indentationLevel === 0 ? 0 : indentationLevel - 1;
           break;
         case rules.specialIndenters.includes(keyword.toLowerCase()):
-          formattedLines.push(this.appendLine(line, indentationLevel - 1));
+          formattedLines.push(appendLine(line, indentationLevel - 1));
           break;
         case rules.specialDedenters.includes(keyword.toLowerCase()):
-          formattedLines.push(this.appendLine(line, indentationLevel));
+          formattedLines.push(appendLine(line, indentationLevel));
           indentationLevel--;
           break;
         case rules.indenters.includes(keyword.toLowerCase()):
-          formattedLines.push(this.appendLine(line, indentationLevel));
+          formattedLines.push(appendLine(line, indentationLevel));
           indentationLevel++;
           break;
         case rules.dedenters.includes(keyword.toLowerCase()):
           indentationLevel = indentationLevel === 0 ? 0 : indentationLevel - 1;
-          formattedLines.push(this.appendLine(line, indentationLevel));
+          formattedLines.push(appendLine(line, indentationLevel));
           break;
         default:
-          formattedLines.push(this.appendLine(line, indentationLevel));
+          formattedLines.push(appendLine(line, indentationLevel));
           break;
       }
     });
     return formattedLines.join(lineEndings);
   }
-  appendLine(line, level) {
-    return line.length ? `${this.getIndentChar().repeat(level)}${line.trim()}` : "";
+  function appendLine(line, level) {
+    return line.length ? `${getIndentChar(level)}${line.trim()}` : "";
   }
-  detectEOL(input) {
-    if (this.options.endOfLines) {
-      return this.options.endOfLines === "crlf" ? "\r\n" : "\n";
+  function detectEOL(input) {
+    if (mergedOptions.endOfLines) {
+      return mergedOptions.endOfLines === "crlf" ? "\r\n" : "\n";
     }
     const newLine = detectNewline(input);
     if (newLine !== void 0) {
@@ -147,10 +141,11 @@ var Dent = class {
       return platform() === "win32" ? "\r\n" : "\n";
     }
   }
-  getIndentChar() {
-    return this.options.useTabs ? "	".repeat(this.options.indentSize || defaultIndentation) : " ".repeat(this.options.indentSize || defaultIndentation);
+  function getIndentChar(level) {
+    return (mergedOptions.useTabs ? "	".repeat(mergedOptions.indentSize || defaultIndentation) : " ".repeat(mergedOptions.indentSize || defaultIndentation)).repeat(level);
   }
-};
+  return format;
+}
 export {
-  Dent
+  createFormatter
 };

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@nsis/dent",
-	"version": "0.2.1",
+	"version": "0.3.0",
 	"description": "An opinionated code formatter for NSIS scripts",
 	"license": "MIT",
 	"scripts": {
-		"build": "esbuild src/main.ts --bundle --platform=node --outfile=dist/index.mjs --format=esm --external:detect-newline",
+		"build": "esbuild src/main.ts --bundle --platform=node --outfile=dist/index.mjs --format=esm --external:detect-newline --external:globby",
 		"dev": "npm run start",
 		"fix": "eslint --fix ./src",
 		"lint:json": "eslint ./*.json --ignore-path .gitignore",
@@ -12,21 +12,19 @@
 		"lint": "npm-run-all --parallel lint:*",
 		"prepack": "npm run build",
 		"start": "npm run build -- --watch",
-		"test": "uvu tests",
+		"test": "uvu -r tsm tests",
 		"prepare": "husky install"
 	},
 	"files": [
 		"dist/",
+		"types/",
 		"LICENSE",
+		"package.json",
 		"README.md"
 	],
 	"type": "module",
-	"types": "./src/main.ts",
-	"exports": {
-		".": {
-			"import": "./dist/index.mjs"
-		}
-	},
+	"typings": "types/",
+	"exports": "./dist/index.mjs",
 	"engines": {
 		"node": "^14.13.1 || >=16.0.0"
 	},
@@ -39,21 +37,21 @@
 		"formatter"
 	],
 	"dependencies": {
-		"detect-newline": "^4.0.0",
-		"globby": "^13.1.4"
+		"detect-newline": "^4.0.0"
 	},
 	"devDependencies": {
 		"@types/node": "^20.2.1",
-		"@typescript-eslint/eslint-plugin": "^5.59.6",
-		"@typescript-eslint/parser": "^5.59.6",
-		"esbuild": "^0.17.19",
-		"eslint": "^8.41.0",
+		"@typescript-eslint/eslint-plugin": "^6.0.0",
+		"@typescript-eslint/parser": "^6.0.0",
+		"esbuild": "^0.18.13",
+		"eslint": "^8.45.0",
 		"eslint-plugin-json": "^3.1.0",
 		"husky": "^8.0.3",
-		"lint-staged": "^13.2.2",
-		"npm-run-all2": "^6.0.5",
-		"tslib": "^2.5.2",
-		"typescript": "^5.0.4",
+		"lint-staged": "^13.2.3",
+		"npm-run-all2": "^6.0.6",
+		"tslib": "^2.6.0",
+		"tsm": "^2.3.0",
+		"typescript": "^5.1.6",
 		"uvu": "^0.5.6"
 	},
 	"lint-staged": {

package/types/index.d.ts

@@ -0,0 +1,18 @@
+declare namespace NsisDent {
+	function createFormatter(options?: Options): Formatter;
+
+	type Formatter = {
+		format(fileContents: string): string;
+	}
+
+	type Options = {
+		endOfLines?: 'crlf' | 'lf';
+		indentSize?: number;
+		trimEmptyLines?: boolean;
+		useTabs?: boolean;
+	}
+}
+
+export = NsisDent;
+export as namespace NsisDent;
+

package/dist/.mjs

@@ -1,152 +0,0 @@
-// src/main.ts
-import { detectNewline } from "detect-newline";
-import { platform } from "node:os";
-
-// src/rules.ts
-var rules = {
-  indenters: [
-    "!if",
-    "!ifdef",
-    "!ifmacrodef",
-    "!ifmacrondef",
-    "!ifndef",
-    "!macro",
-    "${Case}",
-    "${Case2}",
-    "${Case3}",
-    "${Case4}",
-    "${Case5}",
-    "${CaseElse}",
-    "${Default}",
-    "${Do}",
-    "${DoUntil}",
-    "${DoWhile}",
-    "${For}",
-    "${ForEach}",
-    "${If}",
-    "${IfNot}",
-    "${MementoSection}",
-    "${MementoUnselectedSection}",
-    "${Select}",
-    "${Switch}",
-    "${Unless}",
-    "Function",
-    "PageEx",
-    "Section",
-    "SectionGroup"
-  ].map((i) => i.toLowerCase()),
-  dedenters: [
-    "!endif",
-    "!macroend",
-    "${EndIf}",
-    "${EndSelect}",
-    "${EndSwitch}",
-    "${EndWhile}",
-    "${Loop}",
-    "${LoopUntil}",
-    "${LoopWhile}",
-    "${MementoSectionEnd}",
-    "${Next}",
-    "${While}",
-    "FunctionEnd",
-    "PageExEnd",
-    "SectionEnd",
-    "SectionGroupEnd"
-  ].map((i) => i.toLowerCase()),
-  specialIndenters: [
-    "!else",
-    "!elseif",
-    "${Else}",
-    "${ElseIf}",
-    "${ElseIfNot}",
-    "${ElseUnless}",
-    "${AndIf}",
-    "${AndIfNot}",
-    "${AndUnless}",
-    "${OrIf}",
-    "${OrIfNot}",
-    "${OrUnless}"
-  ].map((i) => i.toLowerCase()),
-  specialDedenters: [
-    "${Break}"
-  ].map((i) => i.toLowerCase())
-};
-
-// src/main.ts
-var Dent = class {
-  options = {
-    indentSize: 2,
-    trimEmptyLines: true,
-    useTabs: true
-  };
-  constructor(options = {}) {
-    if (options.useTabs === true && options.indentSize) {
-      throw Error("The indentSize option can only be mixed with useTabs");
-    }
-    if (options.useTabs === false && options.indentSize) {
-      if (isNaN(options.indentSize) || options.indentSize <= 0) {
-        throw Error("The indentSize option expects a positive integer");
-      }
-    }
-    this.options = {
-      ...this.options,
-      ...options
-    };
-  }
-  format(fileContents) {
-    let indentationLevel = 0;
-    let switchIndentationLevel = 0;
-    const lineEndings = this.detectEOL(fileContents);
-    const formattedLines = [];
-    const lines = this.options.trimEmptyLines === true ? fileContents.trim().replaceAll(/^(\s*\r?\n){2,}/gm, lineEndings).split(lineEndings) : fileContents.split(lineEndings);
-    lines.forEach((line) => {
-      const keyword = line.trim().split(" ").at(0) ?? "";
-      if (keyword.toLowerCase() === "${Switch}") {
-        switchIndentationLevel = indentationLevel;
-      }
-      switch (true) {
-        case keyword.toLowerCase() === "${EndSwitch}":
-          indentationLevel = switchIndentationLevel;
-          formattedLines.push(this.appendLine(line, indentationLevel));
-          indentationLevel = indentationLevel === 0 ? 0 : indentationLevel - 1;
-          break;
-        case rules.specialIndenters.includes(keyword.toLowerCase()):
-          formattedLines.push(this.appendLine(line, indentationLevel - 1));
-          break;
-        case rules.specialDedenters.includes(keyword.toLowerCase()):
-          formattedLines.push(this.appendLine(line, indentationLevel));
-          indentationLevel--;
-          break;
-        case rules.indenters.includes(keyword.toLowerCase()):
-          formattedLines.push(this.appendLine(line, indentationLevel));
-          indentationLevel++;
-          break;
-        case rules.dedenters.includes(keyword.toLowerCase()):
-          indentationLevel = indentationLevel === 0 ? 0 : indentationLevel - 1;
-          formattedLines.push(this.appendLine(line, indentationLevel));
-          break;
-        default:
-          formattedLines.push(this.appendLine(line, indentationLevel));
-          break;
-      }
-    });
-    return formattedLines.join(lineEndings);
-  }
-  appendLine(line, level) {
-    return line.length ? `${this.getIndentChar(this.options).repeat(level)}${line.trim()}` : "";
-  }
-  detectEOL(input) {
-    const newLine = detectNewline(input);
-    if (newLine !== void 0) {
-      return newLine;
-    } else {
-      return platform() === "win32" ? "\r\n" : "\n";
-    }
-  }
-  getIndentChar(options) {
-    return options.useTabs ? "	" : " ".repeat(options.indentSize);
-  }
-};
-export {
-  Dent
-};

package/dist/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.mjs","sources":["../src/rules.ts","../src/main.ts"],"sourcesContent":[null,null],"names":[],"mappings":";;;AAAA;AACO,MAAM,KAAK,GAAG;AACpB,IAAA,SAAS,EAAE;QACV,KAAK;QACL,QAAQ;QACR,aAAa;QACb,cAAc;QACd,SAAS;QACT,QAAQ;QACR,SAAS;QACT,UAAU;QACV,UAAU;QACV,UAAU;QACV,UAAU;QACV,aAAa;QACb,YAAY;QACZ,OAAO;QACP,YAAY;QACZ,YAAY;QACZ,QAAQ;QACR,YAAY;QACZ,OAAO;QACP,UAAU;QACV,mBAAmB;QACnB,6BAA6B;QAC7B,WAAW;QACX,WAAW;QACX,WAAW;QACX,UAAU;QACV,QAAQ;QACR,SAAS;QACT,cAAc;KACd,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;AAC3B,IAAA,SAAS,EAAE;QACV,QAAQ;QACR,WAAW;QACX,UAAU;QACV,cAAc;QACd,cAAc;QACd,aAAa;QACb,SAAS;QACT,cAAc;QACd,cAAc;QACd,sBAAsB;QACtB,SAAS;QACT,UAAU;QACV,aAAa;QACb,WAAW;QACX,YAAY;QACZ,iBAAiB;KACjB,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;;AAE3B,IAAA,gBAAgB,EAAE;QACjB,OAAO;QACP,SAAS;QACT,SAAS;QACT,WAAW;QACX,cAAc;QACd,eAAe;QACf,UAAU;QACV,aAAa;QACb,cAAc;QACd,SAAS;QACT,YAAY;QACZ,aAAa;KACb,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;AAC3B,IAAA,gBAAgB,EAAE;QACjB,UAAU;KACV,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;CAC3B;;MC3DY,IAAI,CAAA;AAChB,IAAA,OAAO,GAAG;AACT,QAAA,UAAU,EAAE,CAAC;AACb,QAAA,cAAc,EAAE,IAAI;AACpB,QAAA,OAAO,EAAE,IAAI;KACb,CAAC;AAEF,IAAA,WAAA,CAAY,UAAuB,EAAE,EAAA;QACpC,IAAI,OAAO,CAAC,OAAO,KAAK,IAAI,IAAI,OAAO,CAAC,UAAU,EAAE;AACnD,YAAA,MAAM,KAAK,CAAC,sDAAsD,CAAC,CAAC;AACpE,SAAA;QAED,IAAI,OAAO,CAAC,OAAO,KAAK,KAAK,IAAI,OAAO,CAAC,UAAU,EAAE;AACpD,YAAA,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,OAAO,CAAC,UAAU,IAAI,CAAC,EAAE;AACzD,gBAAA,MAAM,KAAK,CAAC,kDAAkD,CAAC,CAAC;AAChE,aAAA;AACD,SAAA;QAED,IAAI,CAAC,OAAO,GAAG;YACd,GAAG,IAAI,CAAC,OAAO;AACf,YAAA,GAAG,OAAO;SACV,CAAC;KACF;AAEM,IAAA,MAAM,CAAC,YAAoB,EAAA;QACjC,IAAI,gBAAgB,GAAG,CAAC,CAAC;QACzB,IAAI,sBAAsB,GAAG,CAAC,CAAC;QAE/B,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QACjD,MAAM,cAAc,GAAa,EAAE,CAAC;QAEpC,MAAM,KAAK,GAAa,IAAI,CAAC,OAAO,CAAC,cAAc,KAAK,IAAI;AAC3D,cAAE,YAAY;AACZ,iBAAA,IAAI,EAAE;AACN,iBAAA,UAAU,CAAC,mBAAmB,EAAE,WAAW,CAAC;iBAC5C,KAAK,CAAC,WAAW,CAAC;AACpB,cAAE,YAAY;iBACZ,KAAK,CAAC,WAAW,CAAC,CAAC;AAEtB,QAAA,KAAK,CAAC,OAAO,CAAC,IAAI,IAAG;YACpB,MAAM,OAAO,GAAW,IAAI;AAC1B,iBAAA,IAAI,EAAE;iBACN,KAAK,CAAC,GAAG,CAAC;AACV,iBAAA,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAEd,YAAA,IAAI,OAAO,CAAC,WAAW,EAAE,KAAK,WAAW,EAAE;gBAC1C,sBAAsB,GAAG,gBAAgB,CAAC;AAC1C,aAAA;AAED,YAAA,QAAQ,IAAI;AACX,gBAAA,KAAK,OAAO,CAAC,WAAW,EAAE,KAAK,cAAc;oBAC5C,gBAAgB,GAAG,sBAAsB,CAAC;AAC1C,oBAAA,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC;oBAC7D,gBAAgB,GAAG,gBAAgB,KAAK,CAAC;AACxC,0BAAE,CAAC;AACH,0BAAE,gBAAgB,GAAG,CAAC,CAAC;oBACxB,MAAM;gBAEP,KAAK,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;AAC1D,oBAAA,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,gBAAgB,GAAG,CAAC,CAAC,CAAC,CAAC;oBACjE,MAAM;gBAEP,KAAK,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;AAC1D,oBAAA,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC;AAC7D,oBAAA,gBAAgB,EAAE,CAAC;oBACnB,MAAM;gBAEP,KAAK,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;AACnD,oBAAA,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC;AAC7D,oBAAA,gBAAgB,EAAE,CAAC;oBACnB,MAAM;gBAEP,KAAK,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;oBACnD,gBAAgB,GAAG,gBAAgB,KAAK,CAAC;AACxC,0BAAE,CAAC;AACH,0BAAE,gBAAgB,GAAG,CAAC,CAAC;AAExB,oBAAA,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC;oBAC7D,MAAM;AAEP,gBAAA;AACC,oBAAA,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC;oBAC7D,MAAM;AACP,aAAA;AACF,SAAC,CAAC,CAAC;AAEH,QAAA,OAAO,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;KACxC;IAEO,UAAU,CAAC,IAAY,EAAE,KAAa,EAAA;QAC7C,QAAQ,IAAI,CAAC,MAAM;cAChB,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA,EAAG,IAAI,CAAC,IAAI,EAAE,CAAE,CAAA;cACjE,EAAE,EACH;KACF;AAEO,IAAA,SAAS,CAAC,KAAa,EAAA;AAC9B,QAAA,MAAM,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;QAErC,IAAI,OAAO,KAAK,SAAS,EAAE;AAC1B,YAAA,OAAO,OAAO,CAAC;AACf,SAAA;AAAM,aAAA;AACN,YAAA,QAAQ,QAAQ,EAAE,KAAK,OAAO;AAC7B,kBAAE,MAAM;kBACN,IAAI,EACL;AACF,SAAA;KACD;AAEO,IAAA,aAAa,CAAC,OAAO,EAAA;QAC5B,QAAO,OAAO,CAAC,OAAO;AACrB,cAAE,IAAI;cACJ,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAC/B;KACF;AACD;;;;"}