https://github.com/katanacode/katana_stamp
Adds copyright comments to .rb files within a Ruby application
https://github.com/katanacode/katana_stamp
Last synced: about 1 year ago
JSON representation
Adds copyright comments to .rb files within a Ruby application
- Host: GitHub
- URL: https://github.com/katanacode/katana_stamp
- Owner: KatanaCode
- Created: 2012-01-28T16:06:09.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2013-04-14T18:39:26.000Z (about 13 years ago)
- Last Synced: 2024-03-26T04:20:11.832Z (about 2 years ago)
- Language: Ruby
- Homepage:
- Size: 121 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Katana Code's Copyright Stamper
This gem is used internally by Katana Code. Feel free to fork it and modify for your
own organisation.
Read [the documentation](http://rubydoc.info/gems/katana_stamp) for more information on what's going on under the hood.
## Usage:
$ katana_stamp
adds **(c) Copyright 2012 Katana Code Ltd. All Rights Reserved.** to the end of every Ruby file under app/ and lib/.
See options below for configuration
## Options
### --include-dirs (-i)
Include these dir patterns in stamp list
e.g.
$ katana_stamp -i vendor/**/*.rb # will also stamp files matching vendor/**/*.rb
### --exclude-dirs (-x)
Don't include these dir patterns in stamp list
e.g.
$ katana_stamp -x app/controllers/application_controller.rb # will not stamp files matching app/controllers/application_controller.rb
### --year (-y)
Change the year of the Copyright
e.g.
$ katana_stamp -y 1999
Will stamp:
`# (c) Copyright 1999 Katana Code Ltd. All Rights Reserved.
### --owner (-o)
Change the owner of the Copyright
e.g.
$ katana_stamp -o "Ace Rimmer!"
Will stamp:
`# (c) Copyright 2012 Ace Rimmer. All Rights Reserved.`
### --message (-m)
Overwrite the entire message for the stamp.
e.g.
$ katana_stamp -m "2011 - All rights reserved"
Will stamp:
`# (c) 2011 - All rights reserved`
### --comment-delimiter (-c)
Change the comment delimiter used (for different file types)
e.g.
$ katana_stamp -c "//"
Will stamp:
`// (c) Copyright 2012 Katana Code Ltd. All Rights Reserved.`
## Known Issues
At the moment there's no way to reverse this... make sure you commit any changes before you
run this!
## About Katana Code
Katana Code are [iPhone app and Ruby on Rails Developers in Edinburgh, Scotland](http://katanacode.com/ "Katana Code").