Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opportunityliu/resourcegenerator
A tool to generate classes for UWP string resources.
https://github.com/opportunityliu/resourcegenerator
localization resjson resource-management resw uwp
Last synced: 14 days ago
JSON representation
A tool to generate classes for UWP string resources.
- Host: GitHub
- URL: https://github.com/opportunityliu/resourcegenerator
- Owner: OpportunityLiu
- License: mit
- Created: 2017-02-26T12:09:49.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-05-26T04:12:36.000Z (over 5 years ago)
- Last Synced: 2024-12-28T14:18:24.224Z (about 1 month ago)
- Topics: localization, resjson, resource-management, resw, uwp
- Language: C#
- Homepage:
- Size: 554 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ResourceGenerator
A tool to generate classes for UWP string resources.
[](https://www.nuget.org/packages/Opportunity.ResourceGenerator/)
[](https://ci.appveyor.com/project/OpportunityLiu/resourcegenerator)
## How-To
1. **Install package**
To install this package, execute following command in
[package manager console](https://docs.nuget.org/docs/start-here/using-the-package-manager-console).
```powershell
Install-Package Opportunity.ResourceGenerator
```
1. **Create config file**
To create default config file of ResourceGenerator, execute following command.
```powershell
New-Config Resources/Strings
```
You can also specify paths other than `Resources/Strings`.
Use `-Project ` to create config file in project other than default project.
1. **Edit config file**
After step 2, you'll get a `.resgenconfig` file with following content.
```js
{
"`$schema": "https://raw.githubusercontent.com/OpportunityLiu/ResourceGenerator/master/resgenconfig.json?version=1.4.0",
// Path for resource files (*.resw & *.resjson).
// Default value is "/Strings".
"ResourcePath": "/Strings",
// Default language of resources, will be detected automatically if unset.
//"SourceLanguagePath": "en-Us",
// Namespace for resource visitor class.
// Default value is "".
//"LocalizedStringsNamespace": "MyNamespace",
// Namespace for resource visitor interfaces.
// Default value is ".ResourceInfo".
//"InterfacesNamespace": "MyNamespace.ResourceInfo",
// Modifier for resource visitor class and interfaces.
"Modifier": "internal",
// Specifies whether this project is the default project or not.
// Determines if it is necessary to contains project name in the resource path.
"IsDefaultProject": true,
// Regard resource strings whose name starts with '$' as format string.
// Default value is false.
//"IsFormatStringEnabled": true,
// Format function used for format strings, must be replaceble with string.Format.
//"FormatStringFunction": "string.Format",
// Excluded resource paths.
//"Exclude": [],
// Included resource paths, has higher priority than Exclude.
//"Include": [],
// Specifies whether the tool generates code that is debuggable.
"DebugGeneratedCode": false
}
```
Edit this file to control properties of generated classes.
1. **Generate resource class**
Run following command to generate resource class.
```powershell
Convert-Resource -Project
```
To generate resource classes in all projects, run `Convert-Resource` without arguments.
If you edited your resource file (`.resw` & `.resjson`), re-generate resource classes as the last step.
## Features
Takes following `.resjson` file as an example:
```js
//File `Resources.resjosn`:
{
"AppName": "TestName",
"ContentTextBox": {
"Header": "Header",
"Text": "Content",
"ToolTipService/ToolTip": "A simple text box."
},
"$FileNotFound": "Line {line:g}: Can not find file with name \"{name}\" in \"{path}\""
}
```
1. **Nested resource strings** (`.` in `.resw` file or `/` in `.resjson` file)
For example, you can visit the tool tip (`"A simple text box."`) via expression `Strings.Resources.ContentTextBox.ToolTipService.ToolTip`.
1. **Format resource strings** (resource strings whose name starts with a `$`)
To enable this feature, you should set `IsFormatStringEnabled` to `true` in `.resgenconfig` file.
You can find a generated function `string Strings.Resources.FileNotFound(object line, object name, object path)` for format strings.
1. **Dynamic visit support**
You should use a pair of parentheses to end visiting with a string result.
Dynamic version of the first example looks like following:
```cs
string tooltip = Strings.Resources.ContentTextBox.ToolTipService.ToolTip;
dynamic resources = Strings.Resources;
string tooltip1 = (string)resources.ContentTextBox.ToolTipService.ToolTip();
string tooltip2 = (string)resources.ContentTextBox["ToolTipService"].ToolTip();
string tooltip3 = (string)resources.ContentTextBox["ToolTipService/ToolTip"]();
```