https://github.com/crownedgrouse/steam
Search Tags in Erlang Application or Module
https://github.com/crownedgrouse/steam
debian erlang facets tags
Last synced: about 1 month ago
JSON representation
Search Tags in Erlang Application or Module
- Host: GitHub
- URL: https://github.com/crownedgrouse/steam
- Owner: crownedgrouse
- License: isc
- Created: 2016-02-21T14:44:09.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-05-29T09:54:23.000Z (about 8 years ago)
- Last Synced: 2025-08-11T20:41:17.695Z (10 months ago)
- Topics: debian, erlang, facets, tags
- Language: Erlang
- Size: 69.3 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# steam
Search Tags in Erlang Application or Module
## Overview ##
`steam` is a module detecting Debian package tags on Erlang projects.
Debian package tags are used because of their completeness compared to many other distributions. However those tags can be easily transcoded to anothers if needed.
Reference is [Debtags](https://debtags.debian.org/reports/facets).
All relevant tags for Erlang projects are automatically detected from abstract code, except tags of facet `use`.
This subjective facet cannot be detected for now and to be declared by projects maintainers.
## Contributing ##
Contributions are welcome. Please use pull-requests.
### In steam project ###
Facet `use` (The general purpose of the software) is to be informed by Erlang projects maintainer in `src/steam_use.hrl`.
Note : only pull requests coming from owner of project will be accepted for this facet `use`.
### In your own project ###
Alternatively, and prefered way, you can tune steam tags by adding attribute in your own project code.
Simply add a `steam` attribute in top of your main project file, as a list containing optional tuples :
- Tuple `tag` contains a list of tags to add to steam analyze. Note that _ALL_ tags must already exists in steam project or none will be added.
You can verify this by getting the whole list with `steam:tags()` function.
- Tuple `untag` contains a list of tags to remove from steam analyze. This should be used only to repair a false positive until a fix in steam code is done.
```
-steam([{tag,['use::analysing']}, % Add tag(s) (must ALL exists)
{untag,[]} % Remove any unwanted tag(s)
]).
```
## API ##
### Search tags in a project ###
Extracting Debian tags use `steam:tags/1`.
Argument is the path to the Erlang project root directory.
Returns `{ok, ListOfTags}` or `{error, Reason}`.
```
1> steam:tags("/path/to/root/project/directory/").
{ok,['implemented-in::erlang','protocol::ip',
'protocol::ssh','scope::suite','use::organizing']}
```
### Listing facets ###
Debian tag classification use [Facets](https://debtags.debian.org/reports/facets).
Listing facets used in tags : `steam:facets().`
Listing all potential facets : `steam:facets(all).`
### Listing tags ###
Listing available tags : `steam:tags().`
## Quick Start ##
```
git clone git://github.com/crownedgrouse/steam.git
cd steam
make
erl -pa `pwd`/ebin
```
or
```
git clone git://github.com/crownedgrouse/steam.git
cd steam
make shell
```