https://github.com/robb-j/labrador
🦮 A tool for translating YAML files
https://github.com/robb-j/labrador
alpine commitlint husky i18n lint-staged prettier standard-version typescript vite yaml
Last synced: 3 months ago
JSON representation
🦮 A tool for translating YAML files
- Host: GitHub
- URL: https://github.com/robb-j/labrador
- Owner: robb-j
- Created: 2021-09-19T13:36:04.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2022-08-28T15:22:04.000Z (almost 4 years ago)
- Last Synced: 2025-01-15T23:25:14.255Z (over 1 year ago)
- Topics: alpine, commitlint, husky, i18n, lint-staged, prettier, standard-version, typescript, vite, yaml
- Language: HTML
- Homepage: https://labrador.r0b.io/
- Size: 686 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Labrador
This is a prototype tool for editing YAML i18n strings.
You have 2 files.
The reference file is the version of the file you want to be translated
and the target file is the translation you want to produce.
You load both of these files into the tool and it generates an interface for you to do the translation.
Press save at any time to download a modified version of the target file with any changes made to it.
Send that file back to whoever asked you to translate it.
Current translations and changes are stored in `localStorage`
so it will persist between reloads.
## Background
I made this repo to play around with [alpine.js](https://alpinejs.dev/),
[css variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties)
and [vite](https://vitejs.dev/).
## Screenshots
## Development
### Setup
Check out the repo and `npm install` to get the latest dependencies.
Run `npm run prepare` to setup the [husky](https://typicode.github.io/husky/) integration.
### Development
```sh
# Run the development server with hot-reloading
npm run dev
# Run the build
npm run build
```
### Formatting
Code is automatically formatted using [prettier](https://prettier.io),
this runs automatically when comitting code.
Commit's will fail if invalid code is staged.
You can manually format code with `npm run format` if you want.
### Commits
Commit messages must follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/),
this is linted using [husky](https://typicode.github.io/husky/).
### Releasing
Releases are generated with [standard-version](https://github.com/conventional-changelog/standard-version).
This decides the next version and generates the [CHANGELOG.md](/CHANGELOG.md)
based on commit messages.
```sh
npm run release
```