Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mbrukman/autogen
Automatically generate boilerplate license comments.
https://github.com/mbrukman/autogen
autogen boilerplate license licenses
Last synced: 15 days ago
JSON representation
Automatically generate boilerplate license comments.
- Host: GitHub
- URL: https://github.com/mbrukman/autogen
- Owner: mbrukman
- License: apache-2.0
- Created: 2014-10-07T19:03:22.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2024-05-24T22:57:59.000Z (6 months ago)
- Last Synced: 2024-08-01T12:32:46.403Z (3 months ago)
- Topics: autogen, boilerplate, license, licenses
- Language: Shell
- Homepage:
- Size: 221 KB
- Stars: 96
- Watchers: 2
- Forks: 27
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# autogen
[![Build Status][github-ci-badge]][github-ci-url]
[github-ci-badge]: https://github.com/mbrukman/autogen/actions/workflows/main.yml/badge.svg
[github-ci-url]: https://github.com/mbrukman/autogen/actions/workflows/main.yml
Automatically generate boilerplate comments and code for new files with a single
command.
## Install
```bash
cd ~/bin
git clone [email protected]:mbrukman/autogen.git
echo 'alias autogen=~/bin/autogen/autogen' >> ~/.bash_profile
source ~/.bash_profile
```
## Editor support
For details on adding Autogen support to your editor, please see
the [`editors`](editors) directory.
## Usage
```bash
autogen -c [copyright holder] -l [license] [filename]
```
Modify an existing file in-place:
```bash
autogen -i [...other params as above...]
```
Bulk update many existing files in-place:
```bash
find . -type f -name \*.sh -exec autogen -i --no-top-level-comment [options...] {} \;
```
The flag `--no-top-level-comment` avoids adding a comment such as:
```css
/* TODO: High-level file comment */
```
because either some or all of the files have such a top-level comment, or if
they don't, you probably wouldn't want to have to manually add or delete at this
time, if you're just trying to add the license header in bulk.
To get a list of supported licenses, or to see the full set of flags, run
`autogen` with no parameters.
File type or language is determined based on the full filename or extension, as
appropriate. See [`autogen`](autogen) for a list of recognized file types.
The flag `--no-code` skips adding boilerplate code to source files.
The flag `--no-runline` skips adding runline to source files.
Sample outputs:
* [Apache 2.0, Haskell](tests/testdata/apache-acme-hs.out)
* [3-clause BSD, Erlang](tests/testdata/bsd3-acme-erl.out)
* [GPL 2, Ruby](tests/testdata/gpl2-acme-rb.out)
* [LGPL 2.1, C++](tests/testdata/lgpl2.1-acme-cpp.out)
* [MIT, Makefile](tests/testdata/mit-acme-makefile.out)
## Developing
To add a new file type or feature, change [`autogen`](autogen) and add
several files to the [`tests/testdata`](tests/testdata) directory, namely:
* `.in` - the input file containing command-line args to pass
to `autogen`
* `.out` - expected stdout for the test
* `.err` - expected stderr for the test
To generate the `*.out` and `*.err` files automatically, just add the `*.in`
files and run `regen_testdata.sh`. Then, examine the resulting `*.out` and
`*.err` files.
Other custom tests can be added as separate scripts in the [`tests`](tests)
directory. Add an entry for each `*_test.sh` script in the
[`tests/BUILD`](tests/BUILD) file, including appropriate dependencies on any
data files it may need.
## Testing
We use [Bazel](https://docs.bazel.build/versions/master/install.html) for
testing:
```
bazel test //...
```
## Related work
* [addlicense](https://github.com/google/addlicense)
* [License Up](https://github.com/nikitavoloboev/license-up)
## Contributing
See [`CONTRIBUTING.md`](CONTRIBUTING.md) for details.
## License
Apache 2.0; see [`LICENSE.txt`](LICENSE.txt) for details.
## Disclaimer
This project is not an official Google project. It is not supported by Google
and Google specifically disclaims all warranties as to its quality,
merchantability, or fitness for a particular purpose.