PhraseyConfiguration File
The configuration file helps the CLI to build the project.
Representation
ts
interface PhraseyZConfigType {
input: {
// supports globs
files: string | string[];
format: string;
fallback?: string | string[];
};
schema: {
file: string;
format: string;
};
output?: {
dir: string;
format: string;
stringFormat: string;
};
locales?: {
file: string;
format: string;
};
hooks?: {
files: (
| string
| {
path: string;
options?: Record<string, any>;
}
)[];
};
}interface PhraseyZConfigType {
input: {
// supports globs
files: string | string[];
format: string;
fallback?: string | string[];
};
schema: {
file: string;
format: string;
};
output?: {
dir: string;
format: string;
stringFormat: string;
};
locales?: {
file: string;
format: string;
};
hooks?: {
files: (
| string
| {
path: string;
options?: Record<string, any>;
}
)[];
};
}Example
yaml
schema:
file: ./i18n-schema.yaml
format: yaml
input:
files: ./i18n/**.yaml
fallback: ./i18n/en.yaml
format: yaml
output:
dir: ./dist
format: json
stringFormat: parts
hooks:
files:
- ./hooks.jsschema:
file: ./i18n-schema.yaml
format: yaml
input:
files: ./i18n/**.yaml
fallback: ./i18n/en.yaml
format: yaml
output:
dir: ./dist
format: json
stringFormat: parts
hooks:
files:
- ./hooks.js