littoral-templates 0.4.2-alpha.0 → 0.5.0-beta.0

package/CHANGELOG.md

@@ -1,9 +1,16 @@
 # CHANGELOG
 
+## 0.5.0 [not yet released]
+
+* Separated out `setEOLStyleFromOS` to a separate package `littoral-templates-node`.
+* Expose the `setEOLExplicitly` function.
+
+
 ## 0.4.2
 
-* Synchronous style of `setEOLStyleFromOS` caused problems with bundlers — in particular: Vite.
-  That function is now synchronous again, and gives clearer warnings on the console.
+* Synchronous style of `setEOLStyleFromOS` caused problems with web bundlers — in particular: Vite’s.
+  That function is now asynchronous again, so should typically be `await`ed.
+  It also should give warnings on the console when `setEOLStyleFromOS` is called when running in a browser.
 
 
 ## 0.4.1

package/README.md

@@ -170,7 +170,7 @@ EOLs – AKA “newlines” or “line endings” – vary between OS’s: Windo
 Not taking that into account can cause content being generated differently across OS’s, potentially confusing tools like Git — especially if these are not configured correctly.
 Since generated content is often large, this causes additional confusion and friction in the software development process.
 
-To prevent such issues, you can set the EOL style by calling the `setEOLStyleFromOS` function before any calls to `asString`.
+To prevent such issues, you can set the EOL style by calling the `setEOLStyleFromOS` function (which resides in the separate `littoral-templates-node` package) before any calls to `asString`.
 The default value for the EOL style is `lf` – meaning `\n`.
 I’ll use the notation `<eol>` for the currently-set EOL value throughout the rest of the documentation.
 

package/dist/eol.d.ts

@@ -12,10 +12,6 @@ export declare const eolStyles: {
  * The value of the EOL string: typically, either "\n" (=LF-style, compatible with POSIX/Linux/macOS), or "\r\n" (=CRLF-style, compatible with Windows).
  */
 export declare let eol: string;
-/**
- * Sets the EOL to the OS-dependent value.
- */
-export declare const setEOLStyleFromOS: () => Promise<void>;
 /**
  * Sets the EOL explicitly to the given value.
  * (This is especially useful for testing.)

package/dist/eol.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"eol.d.ts","sourceRoot":"","sources":["../src/eol.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,eAAO,MAAM,SAAS;;;CAGZ,CAAA;AAGV;;GAEG;AACH,eAAO,IAAI,GAAG,EAAE,MAAqB,CAAA;AAGrC;;GAEG;AACH,eAAO,MAAM,iBAAiB,qBAoB7B,CAAA;AAGD;;;GAGG;AACH,eAAO,MAAM,gBAAgB,WAAY,MAAM,SAE9C,CAAA;AAKD;;;GAGG;AACH,eAAO,MAAM,UAAU,QAAS,MAAM,KAAG,MAAM,EACtB,CAAA"}
+{"version":3,"file":"eol.d.ts","sourceRoot":"","sources":["../src/eol.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,eAAO,MAAM,SAAS;;;CAGZ,CAAA;AAGV;;GAEG;AACH,eAAO,IAAI,GAAG,EAAE,MAAqB,CAAA;AAGrC;;;GAGG;AACH,eAAO,MAAM,gBAAgB,WAAY,MAAM,SAE9C,CAAA;AAKD;;;GAGG;AACH,eAAO,MAAM,UAAU,QAAS,MAAM,KAAG,MAAM,EACtB,CAAA"}

package/dist/eol.js

@@ -1,42 +1,6 @@
 /**
  * EOL-related constants and functions.
  */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
 /**
  * Common EOL styles.
  */
@@ -48,41 +12,6 @@ export var eolStyles = {
  * The value of the EOL string: typically, either "\n" (=LF-style, compatible with POSIX/Linux/macOS), or "\r\n" (=CRLF-style, compatible with Windows).
  */
 export var eol = eolStyles.lf;
-/**
- * Sets the EOL to the OS-dependent value.
- */
-export var setEOLStyleFromOS = function () { return __awaiter(void 0, void 0, void 0, function () {
-    var printWarningOnConsole;
-    return __generator(this, function (_a) {
-        switch (_a.label) {
-            case 0:
-                printWarningOnConsole = function () {
-                    console.error("The \"os\" package was not available for import, so couldn't set EOL from OS \u2014 previous value is kept. Are you executing this in the browser, by any chance?");
-                };
-                return [4 /*yield*/, import("os")
-                        .then(function (osPackage) {
-                        if (osPackage) {
-                            eol = osPackage.EOL;
-                        }
-                        else {
-                            printWarningOnConsole();
-                        }
-                    })
-                        .catch(function (reason) {
-                        if (reason instanceof TypeError && reason.message.indexOf("'os'") > -1) {
-                            printWarningOnConsole();
-                        }
-                        else {
-                            console.error("Couldn't set EOL from OS after trying to import \"os\" package dynamically. Reason:");
-                            console.dir(reason);
-                        }
-                    })];
-            case 1:
-                _a.sent();
-                return [2 /*return*/];
-        }
-    });
-}); };
 /**
  * Sets the EOL explicitly to the given value.
  * (This is especially useful for testing.)

package/dist/eol.js.map

@@ -1 +1 @@
-{"version":3,"file":"eol.js","sourceRoot":"","sources":["../src/eol.ts"],"names":[],"mappings":"AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH;;GAEG;AACH,MAAM,CAAC,IAAM,SAAS,GAAG;IACrB,EAAE,EAAE,IAAI;IACR,IAAI,EAAE,MAAM;CACN,CAAA;AAGV;;GAEG;AACH,MAAM,CAAC,IAAI,GAAG,GAAW,SAAS,CAAC,EAAE,CAAA;AAGrC;;GAEG;AACH,MAAM,CAAC,IAAM,iBAAiB,GAAG;;;;;gBACvB,qBAAqB,GAAG;oBAC1B,OAAO,CAAC,KAAK,CAAC,mKAA4J,CAAC,CAAA;gBAC/K,CAAC,CAAA;gBACD,qBAAM,MAAM,CAAC,IAAI,CAAC;yBACb,IAAI,CAAC,UAAC,SAAS;wBACZ,IAAI,SAAS,EAAE,CAAC;4BACZ,GAAG,GAAG,SAAS,CAAC,GAAG,CAAA;wBACvB,CAAC;6BAAM,CAAC;4BACJ,qBAAqB,EAAE,CAAA;wBAC3B,CAAC;oBACL,CAAC,CAAC;yBACD,KAAK,CAAC,UAAC,MAAM;wBACV,IAAI,MAAM,YAAY,SAAS,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;4BACrE,qBAAqB,EAAE,CAAA;wBAC3B,CAAC;6BAAM,CAAC;4BACJ,OAAO,CAAC,KAAK,CAAC,qFAAmF,CAAC,CAAA;4BAClG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;wBACvB,CAAC;oBACL,CAAC,CAAC,EAAA;;gBAfN,SAeM,CAAA;;;;KACT,CAAA;AAGD;;;GAGG;AACH,MAAM,CAAC,IAAM,gBAAgB,GAAG,UAAC,MAAc;IAC3C,GAAG,GAAG,MAAM,CAAA;AAChB,CAAC,CAAA;AAGD,IAAM,UAAU,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,CAAA;AAEtC;;;GAGG;AACH,MAAM,CAAC,IAAM,UAAU,GAAG,UAAC,GAAW;IAClC,OAAA,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC;AAArB,CAAqB,CAAA"}
+{"version":3,"file":"eol.js","sourceRoot":"","sources":["../src/eol.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,MAAM,CAAC,IAAM,SAAS,GAAG;IACrB,EAAE,EAAE,IAAI;IACR,IAAI,EAAE,MAAM;CACN,CAAA;AAGV;;GAEG;AACH,MAAM,CAAC,IAAI,GAAG,GAAW,SAAS,CAAC,EAAE,CAAA;AAGrC;;;GAGG;AACH,MAAM,CAAC,IAAM,gBAAgB,GAAG,UAAC,MAAc;IAC3C,GAAG,GAAG,MAAM,CAAA;AAChB,CAAC,CAAA;AAGD,IAAM,UAAU,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,CAAA;AAEtC;;;GAGG;AACH,MAAM,CAAC,IAAM,UAAU,GAAG,UAAC,GAAW;IAClC,OAAA,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC;AAArB,CAAqB,CAAA"}

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export { asString, commaSeparated, commonIndentations, indentWith, setEOLStyleFromOS, when, withEmptyLineAppended, withNewlineAppended } from "./index-internal.js";
+export { asString, commaSeparated, commonIndentations, indentWith, setEOLExplicitly, when, withEmptyLineAppended, withNewlineAppended } from "./index-internal.js";
 export type { Template, NestedString } from "./index-internal.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,QAAQ,EACR,cAAc,EACd,kBAAkB,EAClB,UAAU,EACV,iBAAiB,EACjB,IAAI,EACJ,qBAAqB,EACrB,mBAAmB,EACtB,MAAM,qBAAqB,CAAA;AAC5B,YAAY,EACR,QAAQ,EACR,YAAY,EACf,MAAM,qBAAqB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,QAAQ,EACR,cAAc,EACd,kBAAkB,EAClB,UAAU,EACV,gBAAgB,EAChB,IAAI,EACJ,qBAAqB,EACrB,mBAAmB,EACtB,MAAM,qBAAqB,CAAA;AAC5B,YAAY,EACR,QAAQ,EACR,YAAY,EACf,MAAM,qBAAqB,CAAA"}

package/dist/index.js

@@ -1,3 +1,3 @@
-export { asString, commaSeparated, commonIndentations, indentWith, setEOLStyleFromOS, when, withEmptyLineAppended, withNewlineAppended // (legacy alias)
+export { asString, commaSeparated, commonIndentations, indentWith, setEOLExplicitly, when, withEmptyLineAppended, withNewlineAppended // (legacy alias)
  } from "./index-internal.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,QAAQ,EACR,cAAc,EACd,kBAAkB,EAClB,UAAU,EACV,iBAAiB,EACjB,IAAI,EACJ,qBAAqB,EACrB,mBAAmB,CAAK,iBAAiB;EAC5C,MAAM,qBAAqB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,QAAQ,EACR,cAAc,EACd,kBAAkB,EAClB,UAAU,EACV,gBAAgB,EAChB,IAAI,EACJ,qBAAqB,EACrB,mBAAmB,CAAK,iBAAiB;EAC5C,MAAM,qBAAqB,CAAA"}

package/package.json

@@ -1,48 +1,35 @@
 {
     "name": "littoral-templates",
-    "version": "0.4.2-alpha.0",
-    "description": "A small JavaScript/TypeScript framework to do templating comfortably using the template literal syntax in either JavaScript or TypeScript.",
+    "version": "0.5.0-beta.0",
+    "description": "A small JavaScript/TypeScript framework to do templating comfortably using the template literal syntax in either JavaScript or TypeScript",
+    "license": "MIT",
+    "author": "Meinte Boersma",
+    "keywords": [
+        "template",
+        "engine"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/dslmeinte/littoral-templates.git"
+    },
+    "bugs": {
+        "url": "https://github.com/dslmeinte/littoral-templates/issues"
+    },
+    "homepage": "https://github.com/dslmeinte/littoral-templates#readme",
     "type": "module",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "scripts": {
+        "clean": "rm -rf dist node_modules",
         "build": "tsc",
         "watch-build": "tsc --watch",
-        "clean": "rm -rf dist node_modules",
-        "pretest": "npm run build",
-        "test": "mocha dist/test/*.js",
-        "watch-test": "mocha --watch dist/test/*.js",
         "lint": "eslint src",
-        "prep:pre-release": "npm run clean && npm install && npm test",
+        "prep:pre-release": "npm run clean && npm install && npm run build",
         "prerelease": "npm run prep:pre-release",
         "release": "npm publish",
         "prerelease-alpha": "npm run prep:pre-release",
         "release-alpha": "npm publish --tag beta",
         "prerelease-beta": "npm run prep:pre-release",
         "release-beta": "npm publish --tag beta"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/dslmeinte/littoral-templates.git"
-    },
-    "keywords": [
-        "template",
-        "engine"
-    ],
-    "author": "Meinte Boersma",
-    "license": "MIT",
-    "bugs": {
-        "url": "https://github.com/dslmeinte/littoral-templates/issues"
-    },
-    "homepage": "https://github.com/dslmeinte/littoral-templates#readme",
-    "devDependencies": {
-        "@types/chai": "5.2.2",
-        "@types/mocha": "10.0.10",
-        "@types/node": "18.19.112",
-        "@typescript-eslint/eslint-plugin": "6.21.0",
-        "@typescript-eslint/parser": "6.21.0",
-        "chai": "5.2.0",
-        "mocha": "10.8.2",
-        "typescript": "5.3.3"
     }
 }

package/.eslintrc.cjs

@@ -1,15 +0,0 @@
-/* eslint-env node */
-module.exports = {
-    extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
-    parser: "@typescript-eslint/parser",
-    plugins: ["@typescript-eslint"],
-    root: true,
-    rules: {
-        "@typescript-eslint/no-unused-vars": ["error", {"argsIgnorePattern": "^_"}],
-        "@typescript-eslint/ban-ts-ignore": "off",
-        "@typescript-eslint/prefer-spread": ["off"]
-    },
-    env: {
-        browser: true,
-        node: true
-    }}