@gent-js/gent 0.1.6 → 0.1.8

package/README.md

@@ -2,8 +2,8 @@
 
 ![GenT logo](https://github.com/tomo-waka/gent/raw/main/media/gent_logo.png)
 
-![NPM Version](https://img.shields.io/npm/v/%40gent-js%2Fgent)
-![NPM License](https://img.shields.io/npm/l/%40gent-js%2Fgent)
+[![NPM Version](https://img.shields.io/npm/v/%40gent-js%2Fgent)](https://www.npmjs.com/package/@gent-js/gent)
+[![NPM License](https://img.shields.io/npm/l/%40gent-js%2Fgent)](https://github.com/tomo-waka/gent/blob/main/LICENSE)
 
 ## Introduction
 
@@ -31,7 +31,7 @@ GenT is a template-based data generator. The generated data is used as test data
 install with npm globally.
 
 ```shell
-npm install -g gent
+npm install -g @gent-js/gent
 ```
 
 Then, create a template. Save the following content as a text file in any directory, for instance `{dir path}/template.log`.
@@ -87,7 +87,7 @@ Some commands accept command option, command and option syntax is like shell com
 
 supporting template commands and their options are below.
 
-[Command List](./docs/templateCommands)
+[Command List](./docs/template-commands.md)
 
 ## Meta template sample
 
@@ -139,3 +139,17 @@ supporting template commands and their options are below.
   "{{content}}": "{{int}}"
 }
 ```
+## Output
+
+in cli, specify output path with `out` option.
+```shell
+gent --template {dir path}/template.log --count 3 --out path-to-out.log
+```
+in meta file, specify output path with `out` key.
+```json
+{
+  "out": "path-to-out.log"
+}
+```
+
+moreover, you can use various output method and options in meta file. see [output](./docs/output.md) for details.

package/dist/generated/packageEnv.d.ts

@@ -1,6 +1,6 @@
 export declare const packageEnv: {
     readonly fullName: "@gent-js/gent";
     readonly name: "gent";
-    readonly version: "0.1.6";
+    readonly version: "0.1.8";
     readonly description: "template-based data generator.";
 };

package/dist/generated/packageEnv.js

@@ -2,7 +2,6 @@
 export const packageEnv = {
     fullName: "@gent-js/gent",
     name: "gent",
-    version: "0.1.6",
+    version: "0.1.8",
     description: "template-based data generator."
 };
-//# sourceMappingURL=packageEnv.js.map

package/dist/src/buildDocumentFromJsonTemplate.js

@@ -24,4 +24,3 @@ class JsonDocumentFragmentImpl {
         return json ?? "";
     }
 }
-//# sourceMappingURL=buildDocumentFromJsonTemplate.js.map

package/dist/src/buildDocumentFromTextTemplate.js

@@ -24,4 +24,3 @@ export function buildDocumentFromTextTemplate(templateString, commandManager, do
     }
     return buildCommandDocumentFragments(parsedTemplateFragments, commandManager, documentOptions);
 }
-//# sourceMappingURL=buildDocumentFromTextTemplate.js.map

package/dist/src/cli.js

@@ -100,4 +100,3 @@ async function main() {
     await program.parseAsync(process.argv);
 }
 await main();
-//# sourceMappingURL=cli.js.map

package/dist/src/cliConsts.js

@@ -1,3 +1,2 @@
 export const SUCCEEDED = 0;
 export const FAILED = 1;
-//# sourceMappingURL=cliConsts.js.map

package/dist/src/cliTypes.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=cliTypes.js.map

package/dist/src/command/commandManager/commandManager.js

@@ -80,4 +80,3 @@ function createEscapeStringOut(baseContextualStringOut, style) {
         return baseContextualStringOut;
     }
 }
-//# sourceMappingURL=commandManager.js.map

package/dist/src/command/commandParser/commandParser.js

@@ -87,4 +87,3 @@ export class CommandParser extends CstParser {
 }
 export const commandParser = new CommandParser();
 // endregion
-//# sourceMappingURL=commandParser.js.map

package/dist/src/command/commandParser/parseCommand.js

@@ -16,4 +16,3 @@ export function parseCommand(input) {
     }
     return structuredCommandExpression;
 }
-//# sourceMappingURL=parseCommand.js.map

package/dist/src/command/commandParser/types.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=types.js.map

package/dist/src/command/commandParser/visitor.js

@@ -157,4 +157,3 @@ export function toAstVisitor(input) {
     }
     return out;
 }
-//# sourceMappingURL=visitor.js.map

package/dist/src/command/commands/date/anytime.js

@@ -5,4 +5,3 @@ export const anytimeCommand = {
         return faker.date.anytime().toISOString();
     },
 };
-//# sourceMappingURL=anytime.js.map

package/dist/src/command/commands/date/timestamp.js

@@ -68,4 +68,3 @@ class TimestampCommandImpl {
     }
 }
 export const timestampCommand = new TimestampCommandImpl();
-//# sourceMappingURL=timestamp.js.map

package/dist/src/command/commands/finance/creditCardCVV.js

@@ -5,4 +5,3 @@ export const creditCardCVV = {
         return faker.finance.creditCardCVV();
     },
 };
-//# sourceMappingURL=creditCardCVV.js.map

package/dist/src/command/commands/finance/creditCardIssuer.js

@@ -5,4 +5,3 @@ export const creditCardIssuer = {
         return faker.finance.creditCardIssuer();
     },
 };
-//# sourceMappingURL=creditCardIssuer.js.map

package/dist/src/command/commands/finance/creditCardNumber.js

@@ -9,4 +9,3 @@ export const creditCardNumber = {
         return () => faker.finance.creditCardNumber(commandOptions);
     },
 };
-//# sourceMappingURL=creditCardNumber.js.map

package/dist/src/command/commands/hacker/hacker.noun.js

@@ -5,4 +5,3 @@ export const hackerNounCommand = {
         return faker.hacker.noun();
     },
 };
-//# sourceMappingURL=hacker.noun.js.map

package/dist/src/command/commands/index.js

@@ -97,4 +97,3 @@ commandManager.setCommand(networkInterface);
 commandManager.setCommand(semver);
 // others
 commandManager.setCommand(lengthCommand);
-//# sourceMappingURL=index.js.map

package/dist/src/command/commands/internet/domainName.js

@@ -5,4 +5,3 @@ export const domainName = {
         return faker.internet.domainName();
     },
 };
-//# sourceMappingURL=domainName.js.map

package/dist/src/command/commands/internet/email.js

@@ -5,4 +5,3 @@ export const email = {
         return faker.internet.email();
     },
 };
-//# sourceMappingURL=email.js.map

package/dist/src/command/commands/internet/httpMethod.js

@@ -5,4 +5,3 @@ export const httpMethod = {
         return faker.internet.httpMethod();
     },
 };
-//# sourceMappingURL=httpMethod.js.map

package/dist/src/command/commands/internet/httpStatusCode.js

@@ -5,4 +5,3 @@ export const httpStatusCode = {
         return faker.internet.httpStatusCode().toString();
     },
 };
-//# sourceMappingURL=httpStatusCode.js.map

package/dist/src/command/commands/internet/ip.js

@@ -5,4 +5,3 @@ export const ipCommand = {
         return faker.internet.ip();
     },
 };
-//# sourceMappingURL=ip.js.map

package/dist/src/command/commands/internet/ipv4.js

@@ -5,4 +5,3 @@ export const ipv4Command = {
         return faker.internet.ipv4();
     },
 };
-//# sourceMappingURL=ipv4.js.map

package/dist/src/command/commands/internet/ipv6.js

@@ -5,4 +5,3 @@ export const ipv6Command = {
         return faker.internet.ipv6();
     },
 };
-//# sourceMappingURL=ipv6.js.map

package/dist/src/command/commands/internet/mac.js

@@ -5,4 +5,3 @@ export const mac = {
         return faker.internet.mac();
     },
 };
-//# sourceMappingURL=mac.js.map

package/dist/src/command/commands/internet/password.js

@@ -9,4 +9,3 @@ export const password = {
         return () => faker.internet.password(commandOptions);
     },
 };
-//# sourceMappingURL=password.js.map

package/dist/src/command/commands/internet/pri.js

@@ -10,4 +10,3 @@ export const priCommand = {
             .toString();
     },
 };
-//# sourceMappingURL=pri.js.map

package/dist/src/command/commands/internet/url.js

@@ -5,4 +5,3 @@ export const url = {
         return faker.internet.url();
     },
 };
-//# sourceMappingURL=url.js.map

package/dist/src/command/commands/internet/userAgent.js

@@ -5,4 +5,3 @@ export const userAgent = {
         return faker.internet.userAgent();
     },
 };
-//# sourceMappingURL=userAgent.js.map

package/dist/src/command/commands/internet/username.js

@@ -5,4 +5,3 @@ export const username = {
         return faker.internet.username();
     },
 };
-//# sourceMappingURL=username.js.map

package/dist/src/command/commands/japan/hyakuninIsshu.js

@@ -1147,4 +1147,3 @@ const data = [
     },
 ];
 const hyakuninIsshuFeeder = new WeightedItemFeeder(...data);
-//# sourceMappingURL=hyakuninIsshu.js.map

package/dist/src/command/commands/japan/shogun.js

@@ -68,4 +68,3 @@ const data = [
     },
 ];
 const shogunFeeder = new WeightedItemFeeder(...data);
-//# sourceMappingURL=shogun.js.map

package/dist/src/command/commands/location/country.js

@@ -5,4 +5,3 @@ export const country = {
         return faker.location.country();
     },
 };
-//# sourceMappingURL=country.js.map

package/dist/src/command/commands/location/countryCode.js

@@ -10,4 +10,3 @@ export const countryCode = {
         return () => faker.location.countryCode(commandOptions);
     },
 };
-//# sourceMappingURL=countryCode.js.map

package/dist/src/command/commands/location/timeZone.js

@@ -5,4 +5,3 @@ export const timeZone = {
         return faker.location.timeZone();
     },
 };
-//# sourceMappingURL=timeZone.js.map

package/dist/src/command/commands/lorem/lorem.sentences.js

@@ -11,4 +11,3 @@ export const loremSentencesCommand = {
         return () => faker.lorem.sentences(commandOptions);
     },
 };
-//# sourceMappingURL=lorem.sentences.js.map

package/dist/src/command/commands/number/int.js

@@ -10,4 +10,3 @@ export const intCommand = {
         return () => faker.number.int(commandOptions).toString();
     },
 };
-//# sourceMappingURL=int.js.map

package/dist/src/command/commands/number/pid.js

@@ -11,4 +11,3 @@ export const pidCommand = {
             .toString();
     },
 };
-//# sourceMappingURL=pid.js.map

package/dist/src/command/commands/others/length.js

@@ -10,4 +10,3 @@ export const lengthCommand = {
         return () => faker.number.int(commandOptions).toString();
     },
 };
-//# sourceMappingURL=length.js.map

package/dist/src/command/commands/phone/imei.js

@@ -5,4 +5,3 @@ export const imei = {
         return faker.phone.imei();
     },
 };
-//# sourceMappingURL=imei.js.map

package/dist/src/command/commands/phone/phone.number.js

@@ -9,4 +9,3 @@ export const phoneNumber = {
         return () => faker.phone.number(commandOptions);
     },
 };
-//# sourceMappingURL=phone.number.js.map

package/dist/src/command/commands/string/alpha.js

@@ -10,4 +10,3 @@ export const alpha = {
         return () => faker.string.alpha(commandOptions);
     },
 };
-//# sourceMappingURL=alpha.js.map

package/dist/src/command/commands/string/alphanumeric.js

@@ -10,4 +10,3 @@ export const alphanumeric = {
         return () => faker.string.alphanumeric(commandOptions);
     },
 };
-//# sourceMappingURL=alphanumeric.js.map

package/dist/src/command/commands/string/binary.js

@@ -10,4 +10,3 @@ export const binary = {
         return () => faker.string.binary(commandOptions);
     },
 };
-//# sourceMappingURL=binary.js.map

package/dist/src/command/commands/string/hexadecimal.js

@@ -10,4 +10,3 @@ export const hexadecimal = {
         return () => faker.string.hexadecimal(commandOptions);
     },
 };
-//# sourceMappingURL=hexadecimal.js.map

package/dist/src/command/commands/string/numeric.js

@@ -9,4 +9,3 @@ export const numeric = {
         return () => faker.string.numeric(commandOptions);
     },
 };
-//# sourceMappingURL=numeric.js.map

package/dist/src/command/commands/string/octal.js

@@ -10,4 +10,3 @@ export const octal = {
         return () => faker.string.octal(commandOptions);
     },
 };
-//# sourceMappingURL=octal.js.map

package/dist/src/command/commands/string/ulid.js

@@ -5,4 +5,3 @@ export const ulid = {
         return faker.string.ulid();
     },
 };
-//# sourceMappingURL=ulid.js.map

package/dist/src/command/commands/string/uuid.js

@@ -5,4 +5,3 @@ export const uuid = {
         return faker.string.uuid();
     },
 };
-//# sourceMappingURL=uuid.js.map

package/dist/src/command/commands/system/directoryPath.js

@@ -5,4 +5,3 @@ export const directoryPath = {
         return faker.system.directoryPath();
     },
 };
-//# sourceMappingURL=directoryPath.js.map

package/dist/src/command/commands/system/filePath.js

@@ -5,4 +5,3 @@ export const filePath = {
         return faker.system.filePath();
     },
 };
-//# sourceMappingURL=filePath.js.map

package/dist/src/command/commands/system/mimeType.js

@@ -5,4 +5,3 @@ export const mimeType = {
         return faker.system.mimeType();
     },
 };
-//# sourceMappingURL=mimeType.js.map

package/dist/src/command/commands/system/networkInterface.js

@@ -5,4 +5,3 @@ export const networkInterface = {
         return faker.system.networkInterface();
     },
 };
-//# sourceMappingURL=networkInterface.js.map

package/dist/src/command/commands/system/semver.js

@@ -5,4 +5,3 @@ export const semver = {
         return faker.system.semver();
     },
 };
-//# sourceMappingURL=semver.js.map

package/dist/src/command/consts.js

@@ -1,4 +1,3 @@
 export const GlobalOption_Variations = "variations";
 export const GlobalOption_Escape = "escape";
 export const EscapeStyles = ["json", "doubleQuote"];
-//# sourceMappingURL=consts.js.map

package/dist/src/command/index.js

@@ -1,3 +1,2 @@
 export { parseCommand } from "./commandParser/parseCommand.js";
 export { commandManager } from "./commandManager/commandManager.js";
-//# sourceMappingURL=index.js.map

package/dist/src/command/type.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=type.js.map

package/dist/src/command/utils.js

@@ -6,4 +6,3 @@ export function isEscapeStyle(value) {
     const candidates = EscapeStyles;
     return candidates.includes(value);
 }
-//# sourceMappingURL=utils.js.map

package/dist/src/commandDocument/buildCommandDocumentFragments.js

@@ -9,4 +9,3 @@ export function buildCommandDocumentFragments(parsedTemplateFragments, commandMa
         }
     });
 }
-//# sourceMappingURL=buildCommandDocumentFragments.js.map

package/dist/src/commandDocument/createCommandDocumentFragment.js

@@ -11,4 +11,3 @@ class CommandDocumentFragmentImpl {
 export function createCommandDocumentFragment(structuredCommandExpression, commandManager, documentOptions) {
     return new CommandDocumentFragmentImpl(structuredCommandExpression, commandManager, documentOptions);
 }
-//# sourceMappingURL=createCommandDocumentFragment.js.map

package/dist/src/commandDocument/index.js

@@ -1,2 +1 @@
 export { buildCommandDocumentFragments } from "./buildCommandDocumentFragments.js";
-//# sourceMappingURL=index.js.map

package/dist/src/commandTemplate/index.js

@@ -1,3 +1,2 @@
 export * from "./types.js";
 export { parseAndEmbedCommandExpression } from "./parseAndEmbedCommandExpression.js";
-//# sourceMappingURL=index.js.map

package/dist/src/commandTemplate/parseAndEmbedCommandExpression.js

@@ -9,4 +9,3 @@ export function parseAndEmbedCommandExpression(templateFragments) {
         }
     });
 }
-//# sourceMappingURL=parseAndEmbedCommandExpression.js.map

package/dist/src/commandTemplate/types.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=types.js.map

package/dist/src/common/utils.d.ts

@@ -0,0 +1,5 @@
+/**
+ * ReadonlyArray のためのタイプガード
+ * https://github.com/microsoft/TypeScript/issues/17002
+ */
+export declare function isReadonlyArray<T extends ReadonlyArray<unknown>>(value: T | unknown): value is T;

package/dist/src/common/utils.js

@@ -0,0 +1,7 @@
+/**
+ * ReadonlyArray のためのタイプガード
+ * https://github.com/microsoft/TypeScript/issues/17002
+ */
+export function isReadonlyArray(value) {
+    return Array.isArray(value);
+}

package/dist/src/common/weightedItemFeeder.js

@@ -64,4 +64,3 @@ function normalizeWeightedItem(weightedItem) {
 export function normalizeWeight(value) {
     return Math.min(Math.max(value, MIN_WEIGHT), MAX_WEIGHT);
 }
-//# sourceMappingURL=weightedItemFeeder.js.map

package/dist/src/consts.js

@@ -15,4 +15,3 @@ export const DefaultTrailerReplacer = " ";
 export const TrailerMap = {
     lf: "\n",
 };
-//# sourceMappingURL=consts.js.map

package/dist/src/createDocumentFeeder.js

@@ -61,4 +61,3 @@ async function createWeightedDocument(templateOptions, sharedDocumentOptions, co
     };
     return weightDocument;
 }
-//# sourceMappingURL=createDocumentFeeder.js.map

package/dist/src/createGeneratingDocumentStream.js

@@ -16,4 +16,3 @@ function* generateGeneratingDocument(documentFeeder, count) {
         yield new GeneratingDocument(document, context);
     }
 }
-//# sourceMappingURL=createGeneratingDocumentStream.js.map

package/dist/src/debugFileWriter.js

@@ -30,4 +30,3 @@ class DebugFileWriterImpl {
     }
 }
 export const debugFileWriter = new DebugFileWriterImpl();
-//# sourceMappingURL=debugFileWriter.js.map

package/dist/src/document/createDocumentContextIterator.js

@@ -12,4 +12,3 @@ function* generate(length, startIndex = 0) {
         yield new DocumentContextImpl(i);
     }
 }
-//# sourceMappingURL=createDocumentContextIterator.js.map

package/dist/src/document/generatingDocument.js

@@ -10,4 +10,3 @@ export class GeneratingDocument {
         return stampDocument(this.content, this.context);
     }
 }
-//# sourceMappingURL=generatingDocument.js.map

package/dist/src/document/index.js

@@ -1,4 +1,3 @@
 export { GeneratingDocument } from "./generatingDocument.js";
 export { createDocumentContextIterator } from "./createDocumentContextIterator.js";
 export { stampDocument } from "./utils.js";
-//# sourceMappingURL=index.js.map

package/dist/src/document/types.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=types.js.map

package/dist/src/document/utils.js

@@ -6,4 +6,3 @@ export function stampDocument(content, context) {
         .map((documentFragment) => documentFragment.toString(context))
         .join("");
 }
-//# sourceMappingURL=utils.js.map

package/dist/src/documentTransformStream.js

@@ -115,4 +115,3 @@ function createNonTransparentDocumentTransformer(trailer, trailerReplacer) {
         ];
     };
 }
-//# sourceMappingURL=documentTransformStream.js.map

package/dist/src/documentTransformTypes.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=documentTransformTypes.js.map

package/dist/src/index.js

@@ -1,2 +1 @@
 export { run } from "./run.js";
-//# sourceMappingURL=index.js.map

package/dist/src/json/abstractJsonable.d.ts

@@ -1,6 +1,5 @@
 import type { DocumentContext } from "../document/index.js";
-import type { JsonValueType } from "./jsonableTypes.js";
-import type { JsonValue } from "./jsonTypes.js";
+import type { JsonValue, JsonValueType } from "./jsonTypes.js";
 export declare abstract class AbstractJsonable {
     readonly probability: number | undefined;
     readonly weight: number | undefined;

package/dist/src/json/abstractJsonable.js

@@ -30,4 +30,3 @@ export class AbstractJsonable {
         return this.toJSONImpl(keyOrIndex, context);
     }
 }
-//# sourceMappingURL=abstractJsonable.js.map

package/dist/src/json/createJsonable.js

@@ -1,6 +1,7 @@
 import { assertNever } from "../utils.js";
 import { ArrayJsonable } from "./jsonableClasses/arrayJsonable.js";
 import { BooleanJsonable } from "./jsonableClasses/booleanJsonable.js";
+import { JsonStringJsonable } from "./jsonableClasses/jsonStringJsonable.js";
 import { NullJsonable } from "./jsonableClasses/nullJsonable.js";
 import { NumberJsonable } from "./jsonableClasses/numberJsonable.js";
 import { ObjectJsonable } from "./jsonableClasses/objectJsonable.js";
@@ -13,7 +14,15 @@ export function createJsonable(parameters) {
         return new ArrayJsonable(parameters.content, parameters.length, parameters.probability, parameters.weight);
     }
     else if (parameters.type === "string") {
-        return new StringJsonable(parameters.content, parameters.probability, parameters.weight);
+        if (parameters.subType === "string") {
+            return new StringJsonable(parameters.content, parameters.probability, parameters.weight);
+        }
+        else if (parameters.subType === "json") {
+            return new JsonStringJsonable(parameters.content, parameters.probability, parameters.weight);
+        }
+        else {
+            return assertNever(parameters);
+        }
     }
     else if (parameters.type === "number") {
         return new NumberJsonable(parameters.content, parameters.probability, parameters.weight);
@@ -28,4 +37,3 @@ export function createJsonable(parameters) {
         return assertNever(parameters);
     }
 }
-//# sourceMappingURL=createJsonable.js.map