saladplate 0.1.1 → 0.1.3

package/README.md

@@ -15,7 +15,7 @@ If you need more functionality that that, this is not the templating tool for yo
 ```bash
 $ npm -g install saladplate
 $ saladplate --version
-saladplate: version 0.1.0
+saladplate: version 0.1.2
 ```
 
 ## Usage
@@ -62,19 +62,35 @@ console.info(template("The current PATH is: $PATH"));
 
 ## Development
 
-When developing locally, you can test your changes using the *script* `saladplate`,
+When developing locally, you can test your changes using the _script_ `saladplate`,
 which uses `ts-node`. Note the use of `run` below, as well as the use of `--` to
 separate arguments to `npm run` from arguments to `saladplate`:
 
 ```bash
 $ npm run saladplate -- --version
 
-> saladplate@0.1.0 saladplate
+> saladplate@0.1.2 saladplate
 > ts-node ./bin/saladplate.ts
 
-saladplate: version 0.1.0
+saladplate: version 0.1.2
 ```
 
+### Building and publishing
+
+To build the distributable JS:
+
+```bash
+$ npm run build
+```
+
+This will build to `dist/`. To publish to NPM:
+
+```bash
+$ npm publish
+```
+
+### Testing
+
 Tests are located in `tests/` and consist of input templates `tests/*.test` and
 corresponding expected outputs `tests/*.expected`. To run tests:
 

package/dist/bin/saladplate.d.ts

@@ -1,2 +1,2 @@
-#! /usr/bin/env ts-node
+#!/usr/bin/env ts-node
 export {};

package/dist/bin/saladplate.js

@@ -1,4 +1,5 @@
-#! /usr/bin/env node
+#!/usr/bin/env node
+"use strict";
 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) {
@@ -8,14 +9,18 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import fs from "fs";
-import path from "path";
-import process from "process";
-import util from "util";
-import { BIN, template } from "../src/index";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const process_1 = __importDefault(require("process"));
+const util_1 = __importDefault(require("util"));
+const index_1 = require("../src/index");
 const parseArgsConfig = {
     // Exclude the first two arguments: node and the script itself.
-    args: process.argv.slice(2),
+    args: process_1.default.argv.slice(2),
     options: {
         debug: {
             type: "boolean",
@@ -53,7 +58,7 @@ const parseArgsConfig = {
     allowPositionals: true,
 };
 function help() {
-    console.info(`Usage: ${BIN} [options] <file>...`);
+    console.info(`Usage: ${index_1.BIN} [options] <file>...`);
     console.info(`Options:`);
     const entries = Object.entries(parseArgsConfig.options);
     const prefixes = {};
@@ -70,12 +75,17 @@ function help() {
     });
     console.info("");
 }
+const SALADPLATE_VERSION = "0.1.3";
 function version() {
-    const version = process.env.npm_package_version;
-    console.info(`${BIN}: version ${version !== null && version !== void 0 ? version : "unknown"}`);
+    var _a;
+    let version = SALADPLATE_VERSION;
+    if (version.startsWith("${{")) {
+        version = (_a = process_1.default.env.npm_package_version) !== null && _a !== void 0 ? _a : "";
+    }
+    console.info(`${index_1.BIN}: version ${version || "unknown"}`);
 }
 const parseArgs = () => {
-    const { values: options, positionals: filenames } = util.parseArgs(parseArgsConfig);
+    const { values: options, positionals: filenames } = util_1.default.parseArgs(parseArgsConfig);
     return { options, filenames };
 };
 let output = null;
@@ -86,14 +96,14 @@ function outputForFilename(filename, options) {
         }
         if (options.output) {
             output = {
-                file: yield fs.promises.open(options.output, "w"),
+                file: yield fs_1.default.promises.open(options.output, "w"),
                 filename: options.output,
             };
             return output;
         }
         if (options.directory) {
-            const basename = path.basename(filename);
-            let outputFilename = path.join(options.directory, basename);
+            const basename = path_1.default.basename(filename);
+            let outputFilename = path_1.default.join(options.directory, basename);
             if (options.suffix) {
                 outputFilename = outputFilename.replace(/\.[^.]+$/, options.suffix);
             }
@@ -103,7 +113,7 @@ function outputForFilename(filename, options) {
             };
         }
         output = {
-            file: yield fs.promises.open("/dev/stdout", "w"),
+            file: yield fs_1.default.promises.open("/dev/stdout", "w"),
             filename: "/dev/stdout",
         };
         return output;
@@ -113,7 +123,7 @@ function main() {
     return __awaiter(this, void 0, void 0, function* () {
         const { options, filenames } = parseArgs();
         if (options.debug) {
-            console.debug(`${BIN}: debug mode enabled`);
+            console.debug(`${index_1.BIN}: debug mode enabled`);
         }
         if (options.help) {
             help();
@@ -124,7 +134,7 @@ function main() {
             return;
         }
         if (filenames.length === 0) {
-            console.error(`${BIN}: no input files; use -- for stdin`);
+            console.error(`${index_1.BIN}: no input files; use -- for stdin`);
             help();
             return -1;
         }
@@ -132,15 +142,15 @@ function main() {
             if (filename === "--") {
                 filename = "/dev/stdin";
             }
-            options.debug && console.debug(`${BIN}: reading ${filename}...`);
-            const content = yield fs.promises.readFile(filename, {
+            options.debug && console.debug(`${index_1.BIN}: reading ${filename}...`);
+            const content = yield fs_1.default.promises.readFile(filename, {
                 encoding: "utf-8",
             });
-            options.debug && console.debug(`${BIN}: templating ${filename}...`);
-            const output = yield template(content, filename, options);
+            options.debug && console.debug(`${index_1.BIN}: templating ${filename}...`);
+            const output = yield (0, index_1.template)(content, filename, options);
             const { file: outputFile, filename: outputFilename } = yield outputForFilename(filename, options);
-            options.debug && console.debug(`${BIN}: writing ${outputFilename}...`);
-            yield fs.promises.writeFile(outputFile, output, {
+            options.debug && console.debug(`${index_1.BIN}: writing ${outputFilename}...`);
+            yield fs_1.default.promises.writeFile(outputFile, output, {
                 encoding: "utf-8",
             });
         })));
@@ -148,9 +158,9 @@ function main() {
 }
 main()
     .then((i) => {
-    process.exit(i !== null && i !== void 0 ? i : 0);
+    process_1.default.exit(i !== null && i !== void 0 ? i : 0);
 })
     .catch((e) => {
-    console.error(`${BIN}: unhandled error:`, e);
-    process.exit(-1);
+    console.error(`${index_1.BIN}: unhandled error:`, e);
+    process_1.default.exit(-1);
 });

package/dist/src/index.js

@@ -1,3 +1,4 @@
+"use strict";
 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) {
@@ -7,17 +8,22 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { exec } from "child_process";
-import fs from "fs";
-import path from "path";
-import process from "process";
-import util from "util";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.template = exports.BIN = void 0;
+const child_process_1 = require("child_process");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const process_1 = __importDefault(require("process"));
+const util_1 = __importDefault(require("util"));
 /**
  * The name of the tool; prefixes most output.
  */
-export const BIN = "saladplate";
+exports.BIN = "saladplate";
 const cwdForFilename = (filename) => {
-    return filename === "/dev/stdin" ? process.cwd() : path.dirname(filename);
+    return filename === "/dev/stdin" ? process_1.default.cwd() : path_1.default.dirname(filename);
 };
 const VAR_RE = /\$\{\{([^\}]+)\}\}/g;
 const FILE_RE = /\$\<\<([^\>]+)\>\>/g;
@@ -31,24 +37,24 @@ function replaceAsync(input, regexp, fn) {
 }
 const replaceVar = (variable, filename, options) => {
     var _a;
-    options.debug && console.debug(`${BIN}: ${filename}: evaluating ${variable} for replacement...`);
-    return (_a = process.env[variable]) !== null && _a !== void 0 ? _a : "";
+    options.debug && console.debug(`${exports.BIN}: ${filename}: evaluating ${variable} for replacement...`);
+    return (_a = process_1.default.env[variable]) !== null && _a !== void 0 ? _a : "";
 };
 const replaceFile = (includeFilename, filename, options) => __awaiter(void 0, void 0, void 0, function* () {
     // Resolve the include filename relative to the current file; if the current file is stdin
     // then keep the current working directory.
     const cwd = cwdForFilename(filename);
-    const include = path.join(cwd, includeFilename);
-    options.debug && console.debug(`${BIN}: ${filename}: reading ${include} for replacement...`);
-    const content = yield fs.promises.readFile(include, { encoding: "utf-8" });
-    return template(content, include, options);
+    const include = path_1.default.join(cwd, includeFilename);
+    options.debug && console.debug(`${exports.BIN}: ${filename}: reading ${include} for replacement...`);
+    const content = yield fs_1.default.promises.readFile(include, { encoding: "utf-8" });
+    return (0, exports.template)(content, include, options);
 });
 const replaceExec = (command, filename, options) => __awaiter(void 0, void 0, void 0, function* () {
     // Execute the command in the working directory containing the file we are processing; if
     // the current file is stdin then keep the current working directory.
     const cwd = cwdForFilename(filename);
-    options.debug && console.debug(`${BIN}: ${filename}: executing ${command} for replacement...`);
-    const { stdout } = yield util.promisify(exec)(command, {
+    options.debug && console.debug(`${exports.BIN}: ${filename}: executing ${command} for replacement...`);
+    const { stdout } = yield util_1.default.promisify(child_process_1.exec)(command, {
         cwd,
     });
     return stdout;
@@ -58,7 +64,7 @@ const replaceExec = (command, filename, options) => __awaiter(void 0, void 0, vo
  * is assumed to have been read from the given `filename` (or stdin). Collapses newlines
  * at the end of the output so that there's just one.
  */
-export const template = (content, filename, options) => __awaiter(void 0, void 0, void 0, function* () {
+const template = (content, filename, options) => __awaiter(void 0, void 0, void 0, function* () {
     filename !== null && filename !== void 0 ? filename : (filename = "/dev/stdin");
     options !== null && options !== void 0 ? options : (options = {});
     content = yield replaceAsync(content, VAR_RE, (match) => {
@@ -73,3 +79,4 @@ export const template = (content, filename, options) => __awaiter(void 0, void 0
     content = content.replace(/\n+$/m, "\n");
     return content;
 });
+exports.template = template;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "saladplate",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Very simple templating.",
   "keywords": [
     "template",
     "templating"
   ],
-  "main": "./dist/src/saladplate.js",
+  "main": "./dist/src/index.js",
   "bin": {
     "saladplate": "dist/bin/saladplate.js"
   },