@puya/ts 1.0.0 → 1.1.0

package/README.md

@@ -1,8 +1,121 @@
 # Timestamper
-This library provides timestamp and supports custom templates for its output file.
 
-# Install
+Timestamper is a Node.js library and CLI tool that provides timestamp functionality and supports custom templates for its output file. It allows you to easily add a timestamp to a JSON file or any other file format based on a template.
 
+## Features
+
+- **Add Timestamp**: Automatically add a timestamp to a specified output file.
+- **Custom Templates**: Use custom templates for the output file.
+- **Locale Support**: Supports different locales for timestamp formatting (e.g., `en`, `fa`).
+- **CLI and Programmatic Use**: Can be used as a command-line tool or imported as a module in your Node.js projects.
+
+## Installation
+
+You can install Timestamper globally for CLI use or locally in your project.
+
+### Global Installation
+
+Install globally to use the `ts` command:
+
+```bash
+npm install -g @puya/ts
+```
+
+### Local Installation
+
+Install locally in your project:
+
+```bash
+npm install @puya/ts
 ```
-npm i @puya/ts
+
+## Usage
+
+### CLI
+
+Once installed globally, you can use the `ts` command in your terminal.
+
+```bash
+ts [options]
+```
+
+#### Options
+
+- `-l [locale]`: The locale to use for formatting the date/time. Default is `en`.
+- `-o [outputfile]`: The name of the output file where the result will be saved. Default is `info.json`.
+- `-t [template]`: The path to a template file.
+- `-f [format]`: The format string to use for formatting the date/time. Default is `YYYYMMDDHHmm`.
+- `-so`: skip generating output file.
+- `-i [inline-template]`: Inline template string.
+
+#### Examples
+
+1. Add a timestamp using the default settings:
+
+   ```bash
+   ts
+   ```
+
+2. Add a timestamp to a custom output file with a specific format:
+
+   ```bash
+   ts -l en -o result.json -f YYYYMMDDHHmmss
+   ```
+
+3. Use a custom template file:
+
+   ```bash
+   ts -l fa -o result.json -t template.txt
+   ```
+
+4. Use an inline template:
+
+   ```bash
+   ts -l fa -o result.json -i "{ test: '{ts}' }"
+   ```
+
+5. Get help:
+
+   ```bash
+   ts --help
+   ```
+
+### Programmatic Use
+
+You can also use Timestamper as a module in your Node.js projects.
+
+Example 1.
+```javascript
+const { Timestamper } = require('@puya/ts');
+
+const result = Timestamper({
+    locale: 'en',
+    outputFileName: 'result.json',
+    template: '{ "hash": "{ts}" }',
+    format: 'YYYYMMDDHHmmss'
+});
+
+if (result.success) {
+    console.log(`Timestamp "result.json" generated successfully`);
+} else {
+    console.error('Failed to generate timestamp:', result.err);
+}
+```
+
+Example 2. No output
+```javascript
+const { Timestamper } = require('@puya/ts');
+
+const result = Timestamper({
+    locale: 'en',
+    skipOutput: true,
+    template: '{ "hash": "{ts}" }',
+    format: 'YYYYMMDDHHmmss'
+});
+
+if (result.success) {
+    console.log('Timestamp: ', result.data);
+} else {
+    console.error('Failed to generate timestamp:', result.err);
+}
 ```

package/Timestamper.js

@@ -1,8 +1,9 @@
 const path = require("path");
 const fs = require("fs");
 const moment = require("jalali-moment");
+const package = require('./package.json');
 
-const version = '1.0.0';
+const version = package.version;
 
 let default_options = {
   locale: "en",
@@ -12,7 +13,8 @@ let default_options = {
   templatePath: "",
   format: "YYYYMMDDHHmm",
   inlineTemplate: "",
-  hasInlineTemplate: false
+  hasInlineTemplate: false,
+  skipOutput: false
 };
 
 class TimestampError extends Error {
@@ -39,10 +41,19 @@ function start(args) {
     if (result.state === "successful") {
       result.options = Object.assign(default_options, options);
       
-      const ts = generateTimestamp(options.locale, options.format);
-      const data = generateData(ts, result.options);
-    
-      writeOutput(data, result.options.outPutFilePath);
+      if (default_options.version === true) {
+        console.log(version);
+      } else {
+        
+        const ts = generateTimestamp(options.locale, options.format);
+        const data = generateData(ts, result.options);
+      
+        if (!options.skipOutput) {
+          writeOutput(data, result.options.outPutFilePath);
+        }
+
+        result.data = data;
+      }
       
       result.success = true;
     }
@@ -93,12 +104,20 @@ function parseArguments(args) {
         default_options.format = args[i + 1];
         i += 2;
         break;
+      case '-so':
+        default_options.skipOutput = true;
+        i++;
+        break;
       case '-i':
         default_options.inlineTemplate = args[i + 1];
         default_options.template = default_options.inlineTemplate;
         default_options.hasInlineTemplate = true;
         i += 2;
         break;
+        case '-v':
+          default_options.version = true;
+          i++;
+        break;
       default:
         throw new Error(`Invalid argument provided: ${args[i]}`);
     }
@@ -108,37 +127,42 @@ function parseArguments(args) {
 }
 
 function validateOptions(options) {
-  const fileRegex = /^[\w,-]+\.[A-Za-z]{1,15}$/;
+  // const fileRegex = /^[\w,-]+\.[A-Za-z]{1,15}$/;
 
-  Object.entries(options).forEach(([key, value]) => {
-    if (value === undefined) {
-      throw new TimestampError(`${key}_required`, `${key} is required after -${key.slice(0, 1)}`);
+  if (options.version !== true) {
+    if (options.skipOutput && !options.outPutFilePath) {
+      throw new TimestampError("output_confusion", `Please make up your mind buddy. Do you want me to generate the output for you or not?`);
+    }
+  
+    Object.entries(options).forEach(([key, value]) => {
+      if (value === undefined) {
+        throw new TimestampError(`${key}_required`, `${key} is required after -${key.slice(0, 1)}`);
+      }
+    });
+  
+    // if (!fileRegex.test(path.basename(options.outPutFilePath))) {
+    //   throw new TimestampError("invalid_filename", `Please enter a valid file name.`);
+    // }
+  
+    if (options.templatePath && !fs.existsSync(options.templatePath)) {
+      throw new TimestampError("template_not_exists", `Template file does not exist.`);
+    }
+  
+    if (!isValidDateFormat(options.format)) {
+      throw new TimestampError("invalid_format", `Please enter a valid format.`);
+    }
+  
+    if (options.inlineTemplate !== "") {
+      options.hasInlineTemplate = true;
+    }
+  
+    if (options.hasInlineTemplate && options.inlineTemplate === "") {
+      throw new TimestampError("invalid_inline_template", `Please provide a valid inline template.`);
+    }
+  
+    if (options.templatePath && options.inlineTemplate != "") {
+      throw new TimestampError("extra_template", `You can use only one template.`);
     }
-  });
-
-  if (!fileRegex.test(path.basename(options.outPutFilePath))) {
-    throw new TimestampError("invalid_filename", `Please enter a valid file name.`);
-  }
-
-  if (options.templatePath && !fs.existsSync(options.templatePath)) {
-    throw new TimestampError("template_not_exists", `Template file does not exist.`);
-  }
-
-  if (!isValidDateFormat(options.format)) {
-
-    throw new TimestampError("invalid_format", `Please enter a valid format.`);
-  }
-
-  if (options.inlineTemplate !== "") {
-    options.hasInlineTemplate = true;
-  }
-
-  if (options.hasInlineTemplate && options.inlineTemplate === "") {
-    throw new TimestampError("invalid_inline_template", `Please provide a valid inline template.`);
-  }
-
-  if (options.templatePath && options.inlineTemplate != "") {
-    throw new TimestampError("extra_template", `You can use only one template.`);
   }
 
   return "successful";

package/TimestamperCLI.js

@@ -6,12 +6,13 @@ Timestamper v${version}
   Usage: ts [options]
 
   Options:
-    -v  --version         version
-    -l  --locale          locale to use for formatting the date/time. e.g. 'en' or 'fa' (default = en).
-    -o  --output          output file name where the result will be saved. default is info.json.
-    -t  --template        template file.
-    -f  --format          format string to use for formatting the date/time. default is "YYYYMMDDHHmm".
-    -i  --inline-template inline template string.
+    -v         version
+    -l         locale to use for formatting the date/time. e.g. 'en' or 'fa' (default = en).
+    -o         output file name where the result will be saved. default is info.json.
+    -t         template file.
+    -f         format string to use for formatting the date/time. default is "YYYYMMDDHHmm".
+    -i         inline template string.
+    -so        skip generating output file.
 
   Examples:
     ts
@@ -31,7 +32,9 @@ function TimestamperCLI(args) {
     const result = ts(args);
 
     if (result.success) {
-      console.log(`File ${result.options.outputFileName} generated at ${result.options.outPutFilePath}`);
+      if (result.options.version !== true) {
+        console.log(`File ${result.options.outputFileName} generated at ${result.options.outPutFilePath}`);
+      }
     } else {
       if (result.err) {
         throw result.err;

package/bin/ts

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-
-var path = require('path');
-var fs   = require('fs');
-require(path.join(path.dirname(fs.realpathSync(__filename)), '../test'));
+
+var path = require('path');
+var fs   = require('fs');
+require(path.join(path.dirname(fs.realpathSync(__filename)), '../run'));

package/index.js

@@ -1,4 +1,5 @@
 const { ts } = require('./Timestamper')
-//const cli = require('./TimestamperCLI');
+const cli = require('./TimestamperCLI');
 
-module.exports = ts;
+module.exports.Timestamper = ts;
+module.exports.TimestamperCLI = TimestamperCLI;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@puya/ts",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "This library provides timestamp and supports custom templates for its output file.",
   "main": "index.js",
   "bin": {
     "ts": "bin/ts"
   },
   "scripts": {
-    "test": "node test.js"
+    "test": "node run.js"
   },
   "repository": {
     "type": "git",
@@ -30,7 +30,7 @@
     "jalali-moment": "^3.3.11"
   },
   "files": [
-    "test.js",
+    "run.js",
     "Timestamper.js",
     "TimestamperCLI.js",
     "bin/ts"