Automate asset retrieval from lingoapp.com
Version | Description |
---|---|
0.3.4 |
Adding Changelog to readme |
0.3.3 |
Updated laf-lib, which changes the default API rate limit from 2000 to 200. This may be reverted in the future |
npm install laf -g
In order to use LAF you will need two files in your current working directory:
-
.laf.json
This is your config file.
-
.env
You might already have this file. If that's the case, you just need to add your SpaceID & API Token. Both are supplied by LingoApp.com.
SPACE_ID=''
API_TOKEN=''
Video Tutorial (1/2): laf gen
Config file is required. Using generator to create the config file is optional.
$ laf gen
{
"kits": [
{
"name": "",
"sections": [
{
"name": "",
"headers": [""]
}
]
}
]
}
{
"name": ".laf.json",
"value": {
"kits": [
{
"name": "Capswan UI",
"sections": [
{
"name": "Illustrations"
},
{
"name": "Icons",
"headers": ["Icons", "Components"]
}
]
},
{
"name": "Test Me",
"sections": [
{
"name": "Illustrations",
"headers": ["Lined"]
}
]
}
]
}
}
-
.laf.json
with semi-filled configThe tutorial in "Fetch files" walks you through finalizing this config
-
.env
with empty SPACE_ID & API_TOKEN keys
Video Tutorial (2/2): laf fetch
$ laf fetch
You can call
laf fetch
without specifying flags. Flag defaults are listed below.Visit here to read more about Lingo's available file cuts. This will show you what you conversion possibilities.
Flag | Alias | Description | Defaults |
---|---|---|---|
--out | -o | Download directory | "./downloads" |
--cut | -c | File type | "PNG" |
- $
laf fetch --out "./downloads" --cut "JPG"
- $
laf fetch --out "./assets/foo" --cut "PNG"
All of your files downloaded to the output directory you've specified
Downloaded filenames are a concatenation of asset name & tag names. Consider the following image:
The highlighted "down arrow" would be named:
down_arrow_black.png
as you can see here:
This CLI wraps lingo-asset-fetcher-lib
@github
: lingo-asset-fetcher-lib@npm
: laf-lib
Explores the thought process behind LAF + future plans:
Image download automation with Lingo & LAF