Introducing Socket Firewall: Free, Proactive Protection for Your Software Supply Chain.Learn More
Socket
Book a DemoInstallSign in
Socket

doc-releaser

Package Overview
Dependencies
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

doc-releaser

A simple utility to prepare documents for client release when using time-stamped and similar dynamic file naming conventions.

latest
npmnpm
Version
0.0.1
Version published
Maintainers
1
Created
Source

Doc Releaser

This simple utility was created to do help when technical documentation needs to be written in a very un-collaborative manner, such as via Word documents, and the best way to keep track of things is through a standardized file-naming convention.

Example: for a file release on December 30th, 2015 at 6:07PM, the file name would be:

201512301807-MyFile.txt

Using programs like word is very tedious to keep hitting save-all and then trying to find your most recent "release." This utility creates a current folder and a previous folder. The current folder will only contain the file created from the last time this utility was run. Each time this utility runs, it will move the file in the current folder into the previous folder.

Processing steps

  • Ensure that a file name was specified in the command, exit process if not with a message
  • Look for a configuration file or use defaults if one not provided*
  • Find the current and previous folders or create if not existing
  • Move any files in the current folder to the previous folder
  • Copy the file specified in the command into the current folder with the proper file naming convention.
  • = This is still a bit buggy and is being worked on

Outstanding Tasks

  • Proper handling for configuration file
  • Current file will be moved, but not created, if file with same name (including timestamp) already exists in previous folder
  • Add additional variables in the file naming
  • Provide ability to specify variables and replacement functions

Keywords

Word

FAQs

Package last updated on 31 Dec 2015

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts