https://github.com/alttiri/tags-line-generator
https://github.com/alttiri/tags-line-generator
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/alttiri/tags-line-generator
- Owner: AlttiRi
- Created: 2022-10-01T14:38:52.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-07-30T19:29:31.000Z (11 months ago)
- Last Synced: 2025-10-24T17:11:56.452Z (8 months ago)
- Language: TypeScript
- Size: 148 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TagsLineGenerator
This library allows you to generate a tag line based on the declarative rules described in JSON format.
It's mainly aimed for generating tag lines for using them in filenames when you download a content from online galleries.
## Hello World example
The expected input is an object with keys contain a set of tags (as a `string`, or `string[]` value) and some others _optional_ keys like this one:
```js
const propsObject = {
"category": "example",
"extension": "jpg",
"filename": "7ad864fb2d2bc8bcd2cec9bec094e0fe",
"id": 12345,
"md5": "7ad864fb2d2bc8bcd2cec9bec094e0fe",
"created_at": "2013-10-07T12:07:25.000-00:00",
"uploader": "anonymous",
"tag_string": "1girl brown_eyes brown_hair chair closed_mouth curly_hair dress extremely_high_resolution female grey_dress leonardo_da_vinci long_dress long_hair long_sleeves looking_at_viewer mona_lisa original sitting smile solo upper_body",
"tag_string_artist": "leonardo_da_vinci",
"tag_string_character": "mona_lisa",
"tag_string_copyright": "original",
"tag_string_general": "1girl brown_hair chair closed_mouth curly_hair dress female grey_dress long_dress long_hair long_sleeves looking_at_viewer sitting smile solo upper_body brown_eyes",
"tag_string_meta": "extremely_high_resolution"
};
```
_The props object `propsObject` are intended to be similar to a JSON response usually is returned by API._
The most simple use case is to order the tags by type — the most important tags are first (like `artist` and `character` types tags),
the less important ones are at the end.
Here is the generator's setting object for this case:
```js
const genSettings = {
"props": "tag_string_artist tag_string_character tag_string_copyright tag_string_general tag_string_meta"
};
```
`props` option determines which tags sets should be used from `propsObject`. It's order sensitive.
The example of using `TagsLineGenerator` class with the `propsObject` and `genSettings` variables above:
```js
const tagsLineGen = new TagsLineGenerator(genSettings);
const result = tagsLineGen.generateLine(propsObject);
console.log(result);
```
The `result` is the follow `string`:
```js
"leonardo_da_vinci mona_lisa original 1girl brown_hair chair closed_mouth curly_hair dress female grey_dress long_dress"
```
Since it's aimed to be used for as a filename part, by default, the generator limits the result tag line length up to 120 characters.
The last tag are not cut. If some tag is too long to be fitted in the length limit the generator looks for the follow tags.
Once the `TagsLineGenerator` is created, `generateLine` method can be used multiple times with the different props objects:
```js
const result2 = tagsLineGen.generateLine(propsObject2);
console.log(result2);
const result3 = tagsLineGen.generateLine(propsObject3);
console.log(result3);
```
It's recommended to reuse the same `TagsLineGenerator` instance due to optimisations.
---
## API
...
---
### v2 -> v3 changes
```
"custom-sets" -> "custom-props"
"source" -> "props" ("custom-sets.source" -> "custom-props.props")
"selected-sets" -> "props"
"chars-limit" -> "len-limit"
```
---
The bonus config example:
```json
{
"custom-props": {
"__important": {
"props": "tags",
"only": "third-party_edit sound_edit ai_generated artist_request"
},
"__important_medium": {
"props": "tags_medium",
"only": "3d"
},
"__filtered_medium": {
"props": "tags_medium",
"ignore": "*filesize *resolution *filesize *aspect_ratio hd fhd"
}
},
"ignore": "tagme cg_art game_cg artist_cg webm mp4 video animated",
"replace": [
["megane", "glasses"]
],
"only-one": [
["third-party_edit", "edit"],
["sound_edit", "edit"]
],
"props": [
"tags_artist __important tags_character tags_copyright tags_studio",
"__important_medium tags_genre __filtered_medium tags_meta"
],
"len-limit": 100
}
```