Giter VIP home page Giter VIP logo

headerizer's Introduction

endorse

Headerizer

Copyright © 2012 Ben Glasser

Headerizer is a utility that (when finished) will recursively sift through sub directories of a specified root inserting a header into files of a specified type. Headerizer was inspired by Bart Massey's emacs-copyright and is released under a GPLv3.0 license

Current State

As of now, Hederizer has been realesed only as a commandline utility and can be used as follows:

[-r|--recursive] [-h|--help] [-v|--verbose] <directory> <header> fileType1 fileType2 ... fileTypeN

  [-r|--recursive]
        tell Headerizer whether or not to recursively search subdirectories for
        matching files

  [-h|--help]
        displays this message

  [-v|--verbose]
        Requests verbose output

  <directory>
        Name of directory or file which is to be Headerized (default: ./)

  <header>
        This is the intended header to be inserted into the specified files
        (default: //  Default Header)

  fileType1 fileType2 ... fileTypeN
        file extensions of files which are to be Headerized (default: txt)

the jar for this project can be found under Downloads

note that there is little to no error handleing/fault tolerance right now so this may blow up in your face, but it hasn't lost a file yet ;)

Currently, Headerizer works by prepending the specified header at the begining of the specified file. if the -r option is invoked and a directory is passed as an argument it will prepend the header to all files of the specified file type found in that directory and all sub directories.

Future Plans

So far no future releases have been formalized, but it is my intention to incorporate the following features into Headerizer as the projects develops

  • GUI
  • Insert headers into multiple file types at once
  • Automatic comment prefixing based on file type
  • Automatic name, date, and copyright entry
  • Support for multiple projects across a disjoint directory structure

any other ideas? you are welcome pass them along or implement them as you see fit.

headerizer's People

Contributors

benglasser avatar spynets avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.