From 964115bfaeaee44a79759244f82dc677007271bf Mon Sep 17 00:00:00 2001 From: jguerinet Date: Tue, 2 Nov 2021 12:07:21 -0400 Subject: [PATCH] v9.0.0 --- CHANGELOG.md | 17 ++++++++++++++--- README.md | 33 ++++++++++++++++++++------------- 2 files changed, 34 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8b766f2..3a00e0c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,12 +1,23 @@ # Change Log +## Version 9.0.0 (2021-11-02) + +- Switched to Kotlin DSL for the Gradle files +- Updated Weave to check for duplicate values +- Updated params to be formatted in the more universal $1, $2... +- Added cleanup of smart quotes +- Clean up log messages +- Updated dependencies + ## Version 8.0.1 (2019-06-06) -- Remove percentage formatting on iOS + +- Remove percentage formatting on iOS ## Version 8.0.0 (2019-04-18) -- Added option to specify the casing for the key and type values in a constants config (none, camel, pascal, snake, caps) -- Renamed the `tag` stuff to `value` +- Added option to specify the casing for the key and type values in a constants config (none, camel, pascal, snake, + caps) +- Renamed the `tag` stuff to `value` ## Version 7.0.0 (2019-04-10) diff --git a/README.md b/README.md index 524c5d0..3d424ef 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,15 @@ ## Summary -Weave takes an online CSV file and parses the content to produce the Strings files for an Android or iOS app. It also parses the Strings for Web in the form of a JSON: an on object with a bunch of key-value pairs, the key being the String key and the value being the translated String for that language. +Weave takes an online CSV file and parses the content to produce the Strings files for an Android or iOS app. It also +parses the Strings for Web in the form of a Json: a Json object with key-value pairs, the key being the String key and +the value being the translated String for that language. -It can also parse Constants into files that you are using the same properties cross platform (ex: Analytics tags, Regex expressions). +It can also parse Constants into files that you are using the same properties cross-platform (ex: Analytics tags, Regex +expressions). -It will also show any warnings or errors that the Strings file might have. -Please note that it assumes that the file is in UTF-8 and also produces UTF-8 files. +It will also show any warnings or errors that the Strings file might have. Please note that it assumes that the file is +in UTF-8 and also produces UTF-8 files. ## Instructions @@ -19,12 +22,15 @@ To use this: - `keyColumnName`, which represents the name of the column where the key is stored, defaults to `key` - `platformsColumnName`, which represents the name of the column where the supported platforms for a specific row is, defaults to `platforms` - Any columns containing translations in your CSV file must have a header with the 2 character language Id (ex: en, fr) -- You may also add a 'platforms' column and put in a CSV list of the platforms that a particular String should be parsed for. If the column doesn't exist or the platform value is empty for a specific String it will be parsed for all platforms -- Keys must be unique, not have spaces, and not be null (the parser will inform of any of these errors when you run it) -- You can add headers (which will be parsed as comments) in your Strings file by adding or surrounding your header with '###' (or whatever you specify).For example, if you put ### General ### (or ### General), it will be parsed as `/* General */` on iOS and `` on Android -- You can add formatted Strings by putting either the normal placeholder (i.e. %s for a String) if there is one argument, or numbering them - like this for multiple: %1$s, %2$s... -- Run the jar +- You may also add a 'platforms' column and put in a CSV list of the platforms that a particular String should be parsed + for. If the column doesn't exist or the platform value is empty for a specific String it will be parsed for all + platforms +- Keys must be unique, not have spaces, and not be null (the parser will inform of any errors when you run it) +- You can add headers (which will be parsed as comments) in your Strings file by adding or surrounding your header + with '###' (or whatever you specify).For example, if you put ### General ### (or ### General), it will be parsed + as `/* General */` on iOS and `` on Android +- You can add formatted Strings using `$1`, `$2`, and so on. +- Run the jar For the constants: @@ -35,8 +41,9 @@ For the constants: ## Gradle Dependencies -- [OkHttp](http://square.github.io/okhttp/) -- [kotlinx-serialization](https://github.com/Kotlin/kotlinx.serialization) +- [OkHttp](http://square.github.io/okhttp/) +- [Okio](http://square.github.io/okio/) +- [kotlinx-serialization](https://github.com/Kotlin/kotlinx.serialization) - [super-csv](http://super-csv.github.io/super-csv/) ## Contributors @@ -50,7 +57,7 @@ See the [Change Log](CHANGELOG.md). ## Copyright - Copyright 2013-2019 Julien Guerinet + Copyright 2013-2021 Julien Guerinet Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.