# jsht > Tool to generate templates, using node js. Latest version **1.0.4** (published 2023-01-24) · GNU license · 0 weekly downloads ## Install ```sh npm install jsht pnpm add jsht yarn add jsht bun add jsht ``` Provides the command `jsht`. ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.4 | | Published | 2023-01-24 | | First published | 2021-08-01 | | Weekly downloads | 0 | | License | GNU | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 2 | | Unpacked size | 59.3 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | helliu | | Maintainers | helliu | | Keywords | template, nodejs, node, codegen, generator | ## Links - npm: https://www.npmjs.com/package/jsht - Repository: https://github.com/helliu/jsht - Homepage: https://github.com/helliu/jsht#readme - Issues: https://github.com/helliu/jsht/issues - npm.io page: https://npm.io/package/jsht ## Dependencies (2) - [shellparams](https://npm.io/package/shellparams.md) ^1.0.3 - [readline-sync](https://npm.io/package/readline-sync.md) ^1.4.10 ## Alternatives - [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads - [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads - [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads - [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads - [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads ## Recent versions - 1.0.4 (latest) — 2023-01-24 - 1.0.3 — 2023-01-17 - 1.0.2 — 2022-08-04 - 1.0.1 — 2021-08-08 - 1.0.0 — 2021-08-01 ## README # jsht Program to generate templates files using NodeJS code, using tags <# #> and <#= #> to print values.
With all capabilities NodeJS has to offer. ## Prerequisites NodeJS installed. ## Installing ``` npm i -g jsht ``` ## Getting Started **1 - Create new template:**
_{Template file will be created at **current dir/.jshtTemplates/create/class.js**

```
jsht -n create class
```
**2 - Edit new template**

**_{current dir/.jshtTemplates/create/class.js}**
```js
<#
//any NodeJS here
var className = "HelloWorld";
#>

class <#=className#>{

}
```
**3 - Execute template**
```
jsht create class
```
Will generate
```js

class HelloWorld{

}
```

## Examples
**Create new template file**
```
jsht -n create class
```
New template file will be created at **current dir/.jshtTemplates/create/class.js**.

**Execute template file**
```
jsht create class
```
Execute template file: **current dir/.jshtTemplates/create/class.js**.

**Hello World**
```js
<#
//any NodeJS here
var className = "HelloWorld";
#>

class <#=className#>{

}
```
Will generate
```js

class HelloWorld{

}
```

**Print text**
```js
print text: <#
printText("printed text");
#>

short form: <#="printed text"#>
```
Will generate
```js
print text: printed text

short form: printed text
```

**IF**
```js
<#if(5 > 6){#>
var biggerVar;
<#}else{#>
var smallerVar;
<#}#>
```
Will generate
```js

var smallerVar;

```

**FOR**
```js
<#for(var i = 0; i < 10; i++){#>
let var<#=i#>;
<#}#>
```
Will generate
```js

let var0;

let var1;

let var2;

let var3;

let var4;

let var5;

let var6;

let var7;

let var8;

let var9;
```

**Location variables**
```js
Outputfile: <#=outputFile#>
Outputfile directory: <#=currentDir#>
Template name: <#=templateName#>
Template path: <#=templatePath#>
Template path directory: <#=templateDir#>
```
Will generate
```js
Outputfile: /class.js
Outputfile directory:
Template name: class
Template path: /.jshtTemplates/create/class.js
Template path directory: /.jshtTemplates/create
```

**Change output Name**
```js
<#
outputFile = "myNewFile.js";
#>
```

**Change output location**
```js
<#
outputFile = "../class.js";
#>
```

**not generating output location**
```js
<#
outputFile = "";
#>
```
or
```js
<#
outputFile = null;
#>
```

**Overwite file without asking**
-rf option overwrite existing files without asking.
Example
```
jsht create class -rf
```

**Output generated template in console**\
-outputTemplate \
Example
```
jsht create class -outputTemplate
```

**Output generated JS Code in console for debug**\
-outputJSCode \
Example
```
jsht create class -outputJSCode
```

**Create global template**

A global template can executed in any folder/path.
To creat global template instead local template add "-g" after "-n":
```
jsht -n -g create class
```
First jsht will look for the template at **"./.jshtTemplates"** folder, if not found it will look search in the global template path.

**Global template path**

Get
```
jsht config template location
```
Set
```
jsht config template location C:/Desenv/Templates
```

**Require Modules**

Install your modules at **".jshtTemplates"** folder, to see where **".jshtTemplates"** is, execute command **"jsht config template location"**.

Any module installed at your **".jshtTemplates"** folder will be accessible by require method in your template.

**Require Files**

A js file can be called using require, by the relative path of the template file.

Example:
```
require("./folder/fileToBeCalled");
```

**Call Template from template**
```
callTemplate("./otherTemplate.js", [], []);
```
or through command:
```
execShell("jsht otherTemplate");
```
The second parameter is an array of input arguments. The third parameter is an arrays of named arguments.

**Build in functions**
- **execShell** - execute command in the system \
      **params:** \
            **command** - command to be executed \
            **path** - optional, folder to execute the command, if not provided it will be executed on the current folder. \
**Example:**
```
execShell("ls");
execShell("cd ..");
```

**Input Args**

Aditional parameters will became arguments inside the template:
```
jsht create class MyClassName calculateAge
```

```js
class <#=inputArgs[0]#>{
<#=inputArgs[1]#>(){

}
}
```

**Named Args**

Passing named parameters.
```
jsht create class -methodName calculateAge -className MyClassName
```

```js
class <#=namedArgs["className"]#>{
<#=namedArgs["methodName"]#>(){

}
}
```

---
_Source: https://npm.io/package/jsht · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._}