0.5.0 • Published 7 months ago

@isdk/templify v0.5.0

Weekly downloads
-
License
MIT
Repository
github
Last release
7 months ago

Templify: Instantly convert project into template

Turn any project into a reusable template in seconds—keep your structure, replace variables smartly, and ship templates that just work.

oclif Version Downloads/week

Usage

Install templify

$ npm install -g @isdk/templify
$ templify COMMAND
running command...
$ templify (--version)
@isdk/templify/0.5.0 linux-x64 node-v20.18.0
$ templify --help [COMMAND]
USAGE
  $ templify COMMAND
...

Turn project into template

Navigate to your project directory and mark the parts of the relevant files that need to be replaced with template placeholders using {{VAR}}. Then, run the templify scan command to initialize the template variable file.

For example, modify the package.json file as follows:

{
  "name": "{{name}}",
  "description": "{{description}}",
  "version": "{{version}}",
  "author": "{{author}}",
  "bugs": "{{githubUrl}}/issues",
  "homepage": "{{githubUrl}}",
  "keywords": {{keywords | tojson}},
  ...
}

Run the templify scan command in the project directory:

templify scan
found template file: package.json
Scanned. found 1 template files
Saved ./.templify.yaml

Open the generated .templify.yaml file and make some edits:

files:
  - package.json
parameters:
  name:
    type: string
    default: my-package-name
    title: Package Name
    description: Enter your project name
  description:
    type: string
    title: Package Description
    description: Enter your project description
  version:
    title: Package Version
    type: string
    default: 0.1.0
  author:
    type: string
  githubUrl:
    type: string
    default: https://github.com
  keywords:
    type: array
    description: Enter your project keywords

Note:

  • The default template format is a simplified version of jinja2.
  • The files or folders in the .gitignore will be ignored.

Apply template data configuration to the template folder directly

Ok, now you can run templify apply command to apply the template data configuration to the template folder directly:

templify apply
╭─ Templify: Instantly convert project into template ──────────────────────────⊱
│
◆  Package Name
│  Enter your project name
│  my-name
│
◆  Package Description
│  Enter your project description
│  my-description
│
◆  Package Version
│  0.1.0
│
◆  author
│  Riceball LEE @snowyu
│
◆  githubUrl
│  https://github.com
│

╭─ keywords ───────────────────────────────────────────────────────────────────⊱
│
◆  Add keywords[1] to array (empty to finish)
│  good
│
◆  Add keywords[2] to array (empty to finish)
│  better
│
◆  Add keywords[3] to array (empty to finish)
│  best
│
◆  Add keywords[4] to array (empty to finish)
│
│
│  keywords
╰──────────────────────────────────────────────────────────────────────────────⊱

│  Templify: Instantly convert project into template
╰──────────────────────────────────────────────────────────────────────────────⊱

skip: test/fixture/README.md
apply template: test/fixture/package.json done.
Appied. Enjoy your project at .

Note:

  • By default, the interactive mode is enabled.
  • Use the --no-interactive flag to disable interactive mode. If a .templify-data.yaml file exists in the template folder, it will apply the data from that file; otherwise, it will generate a .templify-data.yaml data file in the template folder.
  • Use the -d your-data-file.yaml flag to specify the data file to apply.

Commands

templify TEMPLATE_DIR [DATA]

🚀 Apply template data configuration etc to the template folder directly. This is the default command to run.

USAGE
  $ templify  TEMPLATE_DIR [DATA] [-d <value>] [-i] [-n]

ARGUMENTS
  TEMPLATE_DIR  [default: .] the template folder to apply
  DATA          the json data to apply. see also `--data data-file-path`

FLAGS
  -d, --data=<value>      the data file to apply. see also DATA argument
  -i, --[no-]interactive  interactive mode
  -n, --dryRun            dry run mode

DESCRIPTION
  🚀 Apply template data configuration etc to the template folder directly. This is the default command to run.

ALIASES
  $ templify 

EXAMPLES
  $ templify  .
  Appied. Enjoy your project at "."

templify apply TEMPLATE_DIR [DATA]

🚀 Apply template data configuration etc to the template folder directly. This is the default command to run.

USAGE
  $ templify apply TEMPLATE_DIR [DATA] [-d <value>] [-i] [-n]

ARGUMENTS
  TEMPLATE_DIR  [default: .] the template folder to apply
  DATA          the json data to apply. see also `--data data-file-path`

FLAGS
  -d, --data=<value>      the data file to apply. see also DATA argument
  -i, --[no-]interactive  interactive mode
  -n, --dryRun            dry run mode

DESCRIPTION
  🚀 Apply template data configuration etc to the template folder directly. This is the default command to run.

ALIASES
  $ templify 

EXAMPLES
  $ templify apply .
  Appied. Enjoy your project at "."

See code: src/commands/apply/index.ts

templify autocomplete [SHELL]

Display autocomplete installation instructions.

USAGE
  $ templify autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  (zsh|bash|powershell) Shell type

FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

DESCRIPTION
  Display autocomplete installation instructions.

EXAMPLES
  $ templify autocomplete

  $ templify autocomplete bash

  $ templify autocomplete zsh

  $ templify autocomplete powershell

  $ templify autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

templify help [COMMAND]

Display help for templify.

USAGE
  $ templify help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for templify.

See code: @oclif/plugin-help

templify plugins

List installed plugins.

USAGE
  $ templify plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ templify plugins

See code: @oclif/plugin-plugins

templify plugins add PLUGIN

Installs a plugin into templify.

USAGE
  $ templify plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into templify.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the TEMPLIFY_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the TEMPLIFY_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ templify plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ templify plugins add myplugin

  Install a plugin from a github url.

    $ templify plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ templify plugins add someuser/someplugin

templify plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ templify plugins inspect PLUGIN...

ARGUMENTS
  PLUGIN...  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ templify plugins inspect myplugin

See code: @oclif/plugin-plugins

templify plugins install PLUGIN

Installs a plugin into templify.

USAGE
  $ templify plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into templify.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the TEMPLIFY_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the TEMPLIFY_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ templify plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ templify plugins install myplugin

  Install a plugin from a github url.

    $ templify plugins install https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ templify plugins install someuser/someplugin

See code: @oclif/plugin-plugins

templify plugins link PATH

Links a plugin into the CLI for development.

USAGE
  $ templify plugins link PATH [-h] [--install] [-v]

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help          Show CLI help.
  -v, --verbose
      --[no-]install  Install dependencies after linking the plugin.

DESCRIPTION
  Links a plugin into the CLI for development.

  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ templify plugins link myplugin

See code: @oclif/plugin-plugins

templify plugins remove [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ templify plugins remove [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ templify plugins unlink
  $ templify plugins remove

EXAMPLES
  $ templify plugins remove myplugin

templify plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ templify plugins reset [--hard] [--reinstall]

FLAGS
  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
  --reinstall  Reinstall all plugins after uninstalling.

See code: @oclif/plugin-plugins

templify plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ templify plugins uninstall [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ templify plugins unlink
  $ templify plugins remove

EXAMPLES
  $ templify plugins uninstall myplugin

See code: @oclif/plugin-plugins

templify plugins unlink [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ templify plugins unlink [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ templify plugins unlink
  $ templify plugins remove

EXAMPLES
  $ templify plugins unlink myplugin

templify plugins update

Update installed plugins.

USAGE
  $ templify plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

templify scan TEMPLATE_DIR

🔎 Scan the template folder and generate or update the template config file(".templify.yaml").

USAGE
  $ templify scan TEMPLATE_DIR [-f <value>] [-n]

ARGUMENTS
  TEMPLATE_DIR  [default: .] the template folder to scan

FLAGS
  -f, --files=<value>  the file patterns to scan, split by comma
  -n, --dryRun         dry run mode

DESCRIPTION
  🔎 Scan the template folder and generate or update the template config file(".templify.yaml").

EXAMPLES
  $ templify scan .
  Scanned.

See code: src/commands/scan/index.ts

templify version

USAGE
  $ templify version [--json] [--verbose]

FLAGS
  --verbose  Show additional information about the CLI.

GLOBAL FLAGS
  --json  Format output as json.

FLAG DESCRIPTIONS
  --verbose  Show additional information about the CLI.

    Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.

See code: @oclif/plugin-version

oclif
@isdk/artistic-text@isdk/templify-lib@oclif/core@oclif/plugin-autocomplete@oclif/plugin-help@oclif/plugin-plugins@oclif/plugin-versioncustom-ability
0.5.0

7 months ago

0.4.0

7 months ago

0.3.7

7 months ago

0.3.6

7 months ago

0.3.5

7 months ago

0.3.4

7 months ago

0.3.3

7 months ago

0.3.2

7 months ago

0.3.1

7 months ago

0.3.0

7 months ago

0.2.1

7 months ago

0.2.0

7 months ago