@xploration-tech/xtouch v2.9.1

xTouch

The easiest way to create empty files and folder trees at a glance!

Installation

> yarn global add @xploration-tech/xtouch

Usage

xTouch is the easiest way to create new, empty files. It is also used to quickly create TypeScript projects and files from templates, based on our own preferences.

xTouch's syntax is

xtouch [option] file_name(s)

When used without any options, xTouch creates new files for any file names that are provided as arguments if files with such names do not already exist. xTouch can create any number of files simultaneously.

For example, the following command would create four new, empty files named tsconfig.json, tslint.json, index.ts, and package.json.

xtouch tsconfig.json tslint.json index.ts package.json

As of 2.5.0 you can now add content per file!

xtouch file1 -c Contents! file2 -c "Multiple words must be in quotations" file3 -c 'More contents!'

Addons

When used with options, xTouch creates new files based on the parameters given to it. xTouch cannot create more than one type of addon simultaneously. However, should the need arise, we will add it accordingly.

When creating project files, xTouch needs very few parameters to get you started. For example, the following command would create a Fusebox-powered module bundling file! The very same file that powers xTouch's bundles!

xtouch --addon fuse-box --type module.ts

You can also specify a name and path! In this example, xTouch will be replacing __NAME__ with 83a9999ac29bb5ed086930699e307649, simply a rather extreme example of a bundle name. xTouch will write the addon file into the temp/ directory. By default, xTouch will simply write the addon into the CWD (Current Working Directory).

xtouch -a fuse-box -t module.ts -n 83a9999ac29bb5ed086930699e307649 --path temp

Sparky.task('default', () => {
  ...
-  fuse.bundle('__NAME__').instructions('> xtouch.ts');
+  fuse.bundle('83a9999ac29bb5ed086930699e307649').instructions('> xtouch.ts');
});

Addons work by taking a file, renaming it, and putting it under a categoric folder. For example: addons/<addon>/<type>. Then we include a configuration file, and we're go for liftoff!

Interactive alpha Coming Soon*

When specifying the --interactive option, you'll be prompted with an interactive CLI for making your selections. This is only something we're playing around with, it may be buggy.

Note

We're designing xTouch with modularity in mind. This means rather than simply creating a new project entirely, you can use xTouch to add files in a plugin-like way. Another features we're working on is resetting files. This way anything can be removed, reset, or added in a modular way, without you having to scroll through git commits for a good reset entry.