Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/felixhaeberle/inlang-plugin-yaml
🧩 YAML plugin for using translations resources in the yaml format with inlang
https://github.com/felixhaeberle/inlang-plugin-yaml
i18n inlang localization yaml
Last synced: 17 days ago
JSON representation
🧩 YAML plugin for using translations resources in the yaml format with inlang
- Host: GitHub
- URL: https://github.com/felixhaeberle/inlang-plugin-yaml
- Owner: felixhaeberle
- License: mit
- Created: 2023-04-26T08:15:18.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-21T23:10:04.000Z (12 months ago)
- Last Synced: 2024-04-13T20:40:18.399Z (7 months ago)
- Topics: i18n, inlang, localization, yaml
- Language: TypeScript
- Homepage: https://github.com/felixhaeberle/inlang-plugin-yaml/blob/main/README.md
- Size: 131 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# inlang-plugin-yaml
## ⚠️ OUTDATED - PR TO UPDATE THIS PLUGIN WELCOME
This is a yaml plugin for using translations resources in the yaml format with [inlang](https://inlang.com/documentation/plugins).
## Usage
Plugins can be imported directly from GitHub releases via jsDelivr.
```js
// filename: inlang.config.js
export async function defineConfig(env) {
const { default: pluginYaml } = await env.$import(
"https://cdn.jsdelivr.net/gh/felixhaeberle/inlang-plugin-yaml@{version}/dist/index.js"
);
return {
// other properties...
plugins: [
pluginYaml({
pathPattern: "./example/{language}.yml",
}),
],
};
}
```
The [dist](./dist/) directory is used to distribute the plugin directly via CDN like [jsDelivr](https://www.jsdelivr.com/). Using a CDN works because the inlang config uses dynamic imports to import plugins. Read the [jsDelivr documentation](https://www.jsdelivr.com/?docs=gh) on importing from GitHub.
For additional usage information, take a look at [example](./example/).
## Developing
Run the following commands in your terminal (node and npm must be installed):
1. `npm install`
2. `npm run dev`
`npm run dev` will start the development environment which automatically compiles the [src/index.ts](./src/index.ts) files to JavaScript ([dist/index.js](dist/index.js)), runs tests defined in `*.test.ts` files and watches changes.
## Publishing
1. Run `npm run build` to generate a build.
2. Commit the new build.
3. Create a new release on GitHub that uses [Semantic Versioning (SemVer)](https://semver.org/). Take a look at [inlang-plugin-json](https://github.com/samuelstroschein/inlang-plugin-json/releases) for example releases.
4. (Optional) Open a pull request to https://github.com/inlang/ecosystem
Note:
- tags are used without "v" at the beginning like: New Tag: 1.2.2
- JSdeliver cached your plugin for `one week`. If you published a new Version and you want to debug something, you have to specify your version in the link like: [email protected]/dist/index.js"
