srctag v1.0.2

SrcTag.JS

A lightweight JS utility to that makes it easier to tag a large amount of files with a generic header.

Templating

Currently this tool supports a very limited set of keywords you can use when making your own headers.

Keywords:

file_name_long: the absolute name of the file, includes the path
file_name_short: the short name of the file, excludes the extension
file_name: the name of the file
file_extension: the extension of the file

Example:

If you wanted to make a header for some of your JS files:

(header.js)
/**
 * File Name: {file_name}
 * Extension: {file_extension}
 * 
 * This file contains some functions that do 'foo'.
 * 
 * This file can be found at {file_name_long}
 * /

Installation

npm i srctag

Add

  "srctag": "node node_modules/srctag/srctag.js"

to scripts in your package.json.

Usage

Run node srctag.js and follow the prompts.

Note: will only pick up files in a subdirectroy of the current directory.