jquery-tmpl-convert v1.0.1

jquery-tmpl-convert

Application is created to help in migration from deprecated jQuery template library. Application is able to converte jQuery template to handlebar templates. Application supports two working modes: command-line interface(CLI) and server preview for interactive template converting. If needed application can be extended to convert other template types.

Installing

To install package globally run command:

npm install jquery-tmpl-convert -g

If you need to use package API install it locally running command:

npm install jquery-tmpl-convert --save

Running application using command-line interface (CLI)

Without server

To convert source jQuery template files into handlebar templates run command:

jquery-tmpl-convert --files <path_to_source_templates> --output <output_directory>

where <path_to_source_templates> is glob to source jQuery template files and <output_directory> is directory where converted handlebars files will be copied. The output directory will also contain report.txt file that contains info, warning and error messages for each converted template.

Example:

jquery-tmpl-convert --files /my_templates/*.htm --output /converted_tmp/

With server

To run jquery-tmpl-convert application in server mode execute command:

jquery-tmpl-convert --files <path_to_source_templates> --server

After command executes open browser and enter address http://localhost:3000. UI provides preview of all original and converted templates. Use UI to edit converted templates using double click on any converted template. Templates can be downloaded via "Download" button. Example:

jquery-tmpl-convert --files /my_templates/*.htm --server

CLI arguments

Usage:

jquery-tmpl-convert [options]

Options:

Using API

If application is installed locally it can be run using API. In order to run application from code follow next example:

	const { Application } = require('jquery-tmpl-convert');

	// create application configuration
	const config = {
		// start the application using server mode
		server: true,
		files: ['./**/*.html'],
		output: '',
		port: 3000,
		converter: 'hbs',
		extension: '.hbs'
	};

	const app = new Application(config);
	app.start();

Extend application with custom template converter

Example how to write your custom template converter:

	const { Application,
			Converter,
			// helper functions
			Utils,
			// application models
			Models
	} = require('jquery-tmpl-convert');

	// define custom converter
	class MyCustomConverter extends Converter {
		get id() {
			return 'myCustomConverter';
		}

		get name() {
			return 'My custom converter';
		}

		get fileExtension() {
			return 'htm';
		}

		constructor(cfg) {
			super(cfg);
		}

		convert(templates) {
			// TODO convert jQueryTemplates, see HandlebarsConverter.js for more details

			this._convertTemplates;.push(/* Push template after it is converted */);
		}
	}

	// create application configuration
	const config = {
		// start the application using server mode
		server: true,
		files: ['./**/*.html'],
		output: '',
		port: 3000,
		converter: 'hbs',
		extension: '.hbs'
	};

	const app = new Application(config);
	app.start([new MyCustomConverter()]);

Running the tests

Use command below to run test locally:

npm run test

License

This project is licensed under the MIT License - see the LICENSE.md file for details