yamlfish 0.1.0.rc1 → 0.1.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49157d9d4bd38be7815795f988ec8b7029099a624c461ddd0b10e56f901e1ca5
-  data.tar.gz: 761f1992eb5676261ca80a84a7b1b5b69690052f16ddb5b3445146738232ffd3
+  metadata.gz: 8a41671e059e352e76f132c0fbcd0106cc9a17cee26872cb8c78fbb44e9720a6
+  data.tar.gz: 343c3d9fde40e58ab909f7ae79c938058875c00d305ecaa08f7ca842c50907c6
 SHA512:
-  metadata.gz: 4cf03873a81a812551491e8bee607b0a0beefb4000a57de94f789b81cd66fbb76e1b221376e65c2380fa19b35eb56850b4f6c8ffa2313a8289d8d0b09204370d
-  data.tar.gz: 8b5ca3a399a3bed89c3edc87b001c886b6690cd3955ab6b8bd334a0aae155220d085236b858b3ebc892f1d7bc7c0d8203d7ee7d51516b7a0de6e003a96f6b8c7
+  metadata.gz: 7a55ee62dc45c611e6f5634b64b2ff4209735fcc514bd2a42ffe0fe4964da0e90b2e5fea2a8b2769ccc0a3a6963620e88c0b4390c55386cee6f80ad03b8e558a
+  data.tar.gz: aff8fb4f4ede8bc7ed0a2a08ffb8bd2b1de9bd0ecda29e34fcb84a2561557d0071e6a0ab7d1821cbe370d41ba866cf63ed5c8813fc0ce94cab3ca9cc0ff5ea9a

data/CHANGELOG.md

@@ -1,5 +1,5 @@
-## [Unreleased]
+<!-- ## [Unreleased] -->
 
-## [0.1.0] - 2023-07-16
+## [0.1.0.rc3] - 2024-09-08
+* Add `-k` / `--keep-unmentioned-keys` option to `push` command
 
-- Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    yamlfish (0.1.0.rc1)
+    yamlfish (0.1.0.rc3)
       activesupport (>= 6)
       faraday (~> 2.0)
       rainbow (~> 3.1)

data/README.md

@@ -1 +1,33 @@
-# Yamlfish
+# YAMLFish CLI
+
+This is the command line interface for [YAMLFish](https:s://yamlfish.dev), the simple and powerful translation management platform.
+
+## Installation
+
+The YAMLFish CLI is available as a Ruby gem.
+First, make sure you have Ruby installed on your machine. You can follow the [official Ruby installation guide](https://www.ruby-lang.org/en/documentation/installation/) for your operating system.
+
+Then, to install the YAMLFish CLI, run:
+
+```bash
+gem install yamlfish --pre
+```
+
+YAMLFish is still in beta, hence the `--pre` flag to install the latest RC.
+
+## Configuration
+
+Before you can use the YAMLFish CLI, you need to configure it with your API key and project token.
+
+To do this, create a `.yamlfish.yml` file in your project's root directory with the following content:
+
+```yaml
+api_key: YOUR_API_KEY
+project_token: YOUR_PROJECT_TOKEN
+```
+
+Those secrets can be found in the footer of your project's page on YAMLFish.
+
+## Usage
+
+For usage instructions, please refer to the [official documentation](https://yamlfish.dev/docs/).

data/exe/yamlfish

@@ -7,8 +7,9 @@ require_relative "../lib/yamlfish/cli"
 class YamlfishExe < Thor
   desc "push", "Pushes translations to yamlfish"
   option :branch, type: :string, default: "main"
+  option :keep_unmentioned_keys, type: :boolean, default: false, aliases: "-k"
   def push(locale)
-    Yamlfish::Cli::Push.new(locale, branch: options[:branch]).call
+    Yamlfish::Cli::Push.new(locale, branch: options[:branch], keep_unmentioned_keys: options[:keep_unmentioned_keys]).call
   rescue Errno::ENOENT => e
     puts Rainbow("Could not push: #{e.message}").red.bright
     exit 1

data/lib/yamlfish/cli/push.rb

@@ -6,9 +6,10 @@ require "faraday"
 module Yamlfish
   module Cli
     class Push
-      def initialize(locale_identifier, branch: "main")
+      def initialize(locale_identifier, branch: "main", keep_unmentioned_keys: false)
         @locale_identifier = locale_identifier
         @branch = branch
+        @keep_unmentioned_keys = keep_unmentioned_keys
       end
 
       def call
@@ -22,7 +23,10 @@ module Yamlfish
 
         response = Faraday.post(
           "#{Yamlfish::Cli.configuration.base_url}/projects/#{Yamlfish::Cli.configuration.project_token}/#{@branch}/locales/#{@locale_identifier}/import",
-          { data: JSON.dump(translations) },
+          {
+            keep_unmentioned_keys: @keep_unmentioned_keys,
+            data: JSON.dump(translations)
+          },
           {
             "Authorization": "Bearer #{Yamlfish::Cli.configuration.api_key}"
           }

data/lib/yamlfish/cli/version.rb

@@ -2,6 +2,6 @@
 
 module Yamlfish
   module Cli
-    VERSION = "0.1.0.rc1"
+    VERSION = "0.1.0.rc3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yamlfish
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc1
+  version: 0.1.0.rc3
 platform: ruby
 authors:
 - Adrien Siami
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-04 00:00:00.000000000 Z
+date: 2024-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -66,7 +66,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-description:
+description: YAMLFish helps developers and product managers with i18n and translation
+  management simply and efficiently.
 email:
 - adrien@siami.fr
 executables:
@@ -95,6 +96,8 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://yamlfish.dev
+  source_code_uri: https://github.com/yamlfish/yamlfish-cli
+  changelog_uri: https://github.com/YAMLFish/yamlfish-cli/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -113,5 +116,5 @@ requirements: []
 rubygems_version: 3.5.10
 signing_key:
 specification_version: 4
-summary: Easily manage your translations with yamlfish
+summary: CLI for YAMLFish, the simple and powerful translation management platform
 test_files: []