@fal-works/sagmal 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +112 -0
- package/dist/bin.js +359 -0
- package/package.json +47 -0
package/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
@@ -0,0 +1,112 @@
|
|
1
|
+
# @fal-works/sagmal
|
2
|
+
|
3
|
+
Command-line translation tool powered by the DeepL API.
|
4
|
+
|
5
|
+
> "sagmal" comes from the German "Sag mal" ("say" or "tell me").
|
6
|
+
|
7
|
+
Note: This is an early-stage project, primarily developed for personal use.
|
8
|
+
|
9
|
+
## Quick Start
|
10
|
+
|
11
|
+
Save your DeepL API key in a `.env` file located either in the current directory or your home directory.
|
12
|
+
**Never commit your `.env` file to version control!**
|
13
|
+
|
14
|
+
```ini
|
15
|
+
SAGMAL_DEEPL_API_KEY=your-api-key-here
|
16
|
+
```
|
17
|
+
|
18
|
+
Then run the CLI tool with:
|
19
|
+
|
20
|
+
```text
|
21
|
+
npx sagmal <text-to-translate>
|
22
|
+
```
|
23
|
+
|
24
|
+
Or, if you have installed it globally:
|
25
|
+
|
26
|
+
```text
|
27
|
+
sagmal <text-to-translate>
|
28
|
+
```
|
29
|
+
|
30
|
+
Then you will see the translated text in your terminal.
|
31
|
+
|
32
|
+
|
33
|
+
## Specifying Languages
|
34
|
+
|
35
|
+
You can specify language options at the **first** or **last** position of your input using colon (`:`) syntax.
|
36
|
+
|
37
|
+
The format is `[from]:[to]`.
|
38
|
+
|
39
|
+
### Language Option Examples
|
40
|
+
|
41
|
+
```text
|
42
|
+
# Language option at the first position
|
43
|
+
de: Hallo Welt # from German
|
44
|
+
:en Oh mon Dieu # to English
|
45
|
+
ja:vi 私は大丈夫です # from Japanese to Vietnamese
|
46
|
+
|
47
|
+
# Language option at the last position
|
48
|
+
Hallo Welt de: # from German
|
49
|
+
Oh mon Dieu :en # to English
|
50
|
+
私は大丈夫です ja:vi # from Japanese to Vietnamese
|
51
|
+
|
52
|
+
# Language options at both positions (confliction should be avoided)
|
53
|
+
ja: 私は大丈夫です :vi # from Japanese to Vietnamese
|
54
|
+
```
|
55
|
+
|
56
|
+
|
57
|
+
### Language Defaults
|
58
|
+
|
59
|
+
- If you don't specify a source language in the CLI or config file, the DeepL API will detect it automatically.
|
60
|
+
- If you don't specify a target language in either place, it will default to `en-US`.
|
61
|
+
|
62
|
+
|
63
|
+
## Configuration
|
64
|
+
|
65
|
+
You can configure the tool by creating a `.sagmalrc.json` file in either your home directory or the current directory.
|
66
|
+
|
67
|
+
The configuration file must be in JSON format and can include:
|
68
|
+
|
69
|
+
- `deepL.sourceLang`: The default source language code.
|
70
|
+
- `deepL.targetLang`: The default target language code.
|
71
|
+
- `deepL.options`: [Text translation options](https://github.com/deeplcom/deepl-node?tab=readme-ov-file#text-translation-options) that will be passed to the DeepL API.
|
72
|
+
|
73
|
+
```json
|
74
|
+
{
|
75
|
+
"deepL": {
|
76
|
+
"sourceLang": "ja",
|
77
|
+
"targetLang": "vi",
|
78
|
+
"options": {
|
79
|
+
"formality": "less",
|
80
|
+
"context": "Always translate technical terms to English",
|
81
|
+
"modelType": "latency_optimized",
|
82
|
+
"tagHandling": "html"
|
83
|
+
}
|
84
|
+
}
|
85
|
+
}
|
86
|
+
```
|
87
|
+
|
88
|
+
|
89
|
+
## Help message
|
90
|
+
|
91
|
+
If no text is provided, or if the first argument is `--help` or `-h`, the tool will display a help message.
|
92
|
+
|
93
|
+
```text
|
94
|
+
Usage:
|
95
|
+
sagmal [languages] <text>
|
96
|
+
sagmal <text> [languages]
|
97
|
+
sagmal [language] <text> [language]
|
98
|
+
Examples:
|
99
|
+
sagmal Bonjour tout le monde
|
100
|
+
sagmal de: Hallo Welt!
|
101
|
+
sagmal :it It's not a bug, it's a feature
|
102
|
+
sagmal fr:ar Je pense, donc je suis
|
103
|
+
sagmal I have made a terrible mistake :ja
|
104
|
+
sagmal 404 Motivation Not Found en:de
|
105
|
+
sagmal ja: 私は大丈夫です :zh-HANT
|
106
|
+
```
|
107
|
+
|
108
|
+
|
109
|
+
## References
|
110
|
+
|
111
|
+
- DeepL API Documentation: <https://www.deepl.com/docs-api>
|
112
|
+
- DeepL API for Node.js: <https://github.com/DeepLcom/deepl-node>
|
package/dist/bin.js
ADDED
@@ -0,0 +1,359 @@
|
|
1
|
+
#!/usr/bin/env node
|
2
|
+
import { DeepLClient, DeepLError } from "deepl-node";
|
3
|
+
import { existsSync, readFileSync } from "node:fs";
|
4
|
+
import { homedir } from "node:os";
|
5
|
+
import { join } from "node:path";
|
6
|
+
import dotenv from "dotenv";
|
7
|
+
|
8
|
+
//#region src/cli-language-parser.ts
|
9
|
+
/**
|
10
|
+
* Parses colon-separated language options from a command line argument.
|
11
|
+
* Returns null if argument doesn't contain colon.
|
12
|
+
*/
|
13
|
+
function parseCliLanguageOption(arg) {
|
14
|
+
if (!arg.includes(":")) return null;
|
15
|
+
const colonIndex = arg.indexOf(":");
|
16
|
+
const beforeColon = arg.substring(0, colonIndex);
|
17
|
+
const afterColon = arg.substring(colonIndex + 1);
|
18
|
+
return {
|
19
|
+
sourceLang: beforeColon || null,
|
20
|
+
targetLang: afterColon || null
|
21
|
+
};
|
22
|
+
}
|
23
|
+
|
24
|
+
//#endregion
|
25
|
+
//#region src/errors.ts
|
26
|
+
/**
|
27
|
+
* Custom error class for Sagmal application-specific errors.
|
28
|
+
* Used for validation errors, configuration errors, and other application logic errors.
|
29
|
+
* Not used for external API errors or unknown errors.
|
30
|
+
*/
|
31
|
+
var SagmalError = class SagmalError extends Error {
|
32
|
+
constructor(message) {
|
33
|
+
super(message);
|
34
|
+
this.name = "SagmalError";
|
35
|
+
if (Error.captureStackTrace) Error.captureStackTrace(this, SagmalError);
|
36
|
+
}
|
37
|
+
};
|
38
|
+
/**
|
39
|
+
* Converts an unknown error value to a readable string.
|
40
|
+
*
|
41
|
+
* @param error - Error value to stringify
|
42
|
+
* @returns Formatted error string
|
43
|
+
*/
|
44
|
+
function stringifyError(error) {
|
45
|
+
if (error instanceof Error) return `${error.name} > ${error.message}`;
|
46
|
+
return String(error);
|
47
|
+
}
|
48
|
+
|
49
|
+
//#endregion
|
50
|
+
//#region src/cli-parser.ts
|
51
|
+
/**
|
52
|
+
* Checks if CLI arguments contain help option.
|
53
|
+
*/
|
54
|
+
function hasHelpOption(args) {
|
55
|
+
return args.length === 0 || args[0] === "--help" || args[0] === "-h";
|
56
|
+
}
|
57
|
+
/**
|
58
|
+
* Parses CLI arguments to extract language options and text parts.
|
59
|
+
* Handles language options at both first and last positions.
|
60
|
+
*/
|
61
|
+
function parseCliArguments(args) {
|
62
|
+
if (args.length === 0) return {
|
63
|
+
languageOptions: {
|
64
|
+
first: null,
|
65
|
+
last: null
|
66
|
+
},
|
67
|
+
text: ""
|
68
|
+
};
|
69
|
+
const firstLangOptions = parseCliLanguageOption(args[0]);
|
70
|
+
const lastLangOptions = args.length > 1 ? parseCliLanguageOption(args[args.length - 1]) : null;
|
71
|
+
let textParts = args;
|
72
|
+
if (firstLangOptions !== null) textParts = textParts.slice(1);
|
73
|
+
if (lastLangOptions !== null && textParts.length > 0) textParts = textParts.slice(0, -1);
|
74
|
+
const text = textParts.join(" ");
|
75
|
+
if (text.length > 1024) throw new SagmalError(`Text too long: ${text.length} characters (maximum: 1024).`);
|
76
|
+
return {
|
77
|
+
languageOptions: {
|
78
|
+
first: firstLangOptions,
|
79
|
+
last: lastLangOptions
|
80
|
+
},
|
81
|
+
text
|
82
|
+
};
|
83
|
+
}
|
84
|
+
|
85
|
+
//#endregion
|
86
|
+
//#region src/config-loader.ts
|
87
|
+
/**
|
88
|
+
* Reads file content from disk.
|
89
|
+
*
|
90
|
+
* @param path - Path to the file
|
91
|
+
* @returns File content as string
|
92
|
+
* @throws SagmalError if file cannot be read
|
93
|
+
*/
|
94
|
+
function readConfigFileContent(path) {
|
95
|
+
try {
|
96
|
+
return readFileSync(path, "utf-8");
|
97
|
+
} catch (error) {
|
98
|
+
throw new SagmalError(`Cannot read config file: ${path}\n ${stringifyError(error)}`);
|
99
|
+
}
|
100
|
+
}
|
101
|
+
/**
|
102
|
+
* Parses JSON content.
|
103
|
+
*
|
104
|
+
* @param content - JSON string content
|
105
|
+
* @param path - File path for error messages
|
106
|
+
* @returns Parsed JSON data
|
107
|
+
* @throws SagmalError if JSON is invalid
|
108
|
+
*/
|
109
|
+
function parseConfigJson(content, path) {
|
110
|
+
try {
|
111
|
+
return JSON.parse(content);
|
112
|
+
} catch (error) {
|
113
|
+
throw new SagmalError(`Invalid JSON in config file: ${path}\n ${stringifyError(error)}`);
|
114
|
+
}
|
115
|
+
}
|
116
|
+
/**
|
117
|
+
* Validates and types parsed config data.
|
118
|
+
*
|
119
|
+
* @param parsed - Parsed JSON data
|
120
|
+
* @param path - File path for error messages
|
121
|
+
* @returns Typed config object
|
122
|
+
* @throws SagmalError if data is not a valid config object
|
123
|
+
*/
|
124
|
+
function validateConfigData(parsed, path) {
|
125
|
+
if (typeof parsed !== "object" || parsed === null || Array.isArray(parsed)) throw new SagmalError(`Invalid config file: ${path}\n must be an object, not ${Array.isArray(parsed) ? "array" : typeof parsed}`);
|
126
|
+
return parsed;
|
127
|
+
}
|
128
|
+
/**
|
129
|
+
* Loads and parses a JSON configuration file.
|
130
|
+
* Only validates that the result is a plain object (not array or primitive).
|
131
|
+
* Does not validate the object's contents - invalid configuration options are passed through.
|
132
|
+
*
|
133
|
+
* @param path - Path to the JSON file
|
134
|
+
* @returns Parsed object or undefined if file doesn't exist
|
135
|
+
* @throws SagmalError if file cannot be read, JSON is malformed, or data is not an object
|
136
|
+
*/
|
137
|
+
function loadConfigFile(path) {
|
138
|
+
if (!existsSync(path)) return void 0;
|
139
|
+
const content = readConfigFileContent(path);
|
140
|
+
const parsed = parseConfigJson(content, path);
|
141
|
+
return validateConfigData(parsed, path);
|
142
|
+
}
|
143
|
+
/**
|
144
|
+
* Loads configuration files from home and current directories.
|
145
|
+
*
|
146
|
+
* @returns Configuration inputs (no merging applied, uses empty objects as defaults)
|
147
|
+
*/
|
148
|
+
function loadConfigInputs() {
|
149
|
+
const homeDir = homedir();
|
150
|
+
const homeConfig = loadConfigFile(join(homeDir, ".sagmalrc.json"));
|
151
|
+
const localConfig = loadConfigFile(join(process.cwd(), ".sagmalrc.json"));
|
152
|
+
return {
|
153
|
+
homeConfig: homeConfig ?? {},
|
154
|
+
localConfig: localConfig ?? {}
|
155
|
+
};
|
156
|
+
}
|
157
|
+
|
158
|
+
//#endregion
|
159
|
+
//#region src/env-loader.ts
|
160
|
+
/**
|
161
|
+
* Mutes `console.log` output for a function execution.
|
162
|
+
*/
|
163
|
+
function mute(fn) {
|
164
|
+
const originalLog = console.log;
|
165
|
+
console.log = () => {};
|
166
|
+
fn();
|
167
|
+
console.log = originalLog;
|
168
|
+
}
|
169
|
+
/**
|
170
|
+
* Loads environment variables from `.env` files.
|
171
|
+
*/
|
172
|
+
function loadDotEnv() {
|
173
|
+
dotenv.config({ path: join(homedir(), ".env") });
|
174
|
+
dotenv.config();
|
175
|
+
}
|
176
|
+
/**
|
177
|
+
* Loads environment variables.
|
178
|
+
*/
|
179
|
+
function loadEnvironment() {
|
180
|
+
mute(loadDotEnv);
|
181
|
+
}
|
182
|
+
/**
|
183
|
+
* Gets the DeepL API key from environment variable.
|
184
|
+
*
|
185
|
+
* @returns API key
|
186
|
+
* @throws SagmalError if the key is not found
|
187
|
+
*/
|
188
|
+
function getApiKey() {
|
189
|
+
const key = process.env.SAGMAL_DEEPL_API_KEY;
|
190
|
+
if (!key) throw new SagmalError("DeepL API key not found. Please set SAGMAL_DEEPL_API_KEY as an environment variable or in a .env file.");
|
191
|
+
return key;
|
192
|
+
}
|
193
|
+
|
194
|
+
//#endregion
|
195
|
+
//#region src/help.ts
|
196
|
+
/**
|
197
|
+
* Displays usage information and examples to the console.
|
198
|
+
* Called when no arguments are provided or when --help/-h flags are used.
|
199
|
+
*/
|
200
|
+
function showHelp() {
|
201
|
+
const msg = `
|
202
|
+
Usage:
|
203
|
+
sagmal [languages] <text>
|
204
|
+
Examples:
|
205
|
+
sagmal Bonjour tout le monde
|
206
|
+
sagmal de: Hallo Welt!
|
207
|
+
sagmal :it It's not a bug, it's a feature
|
208
|
+
sagmal I have made a terrible mistake :ja
|
209
|
+
sagmal fr:ar Je pense, donc je suis
|
210
|
+
sagmal ja: 私は大丈夫です :zh-HANT
|
211
|
+
sagmal 404 Motivation Not Found en:de
|
212
|
+
`.trim();
|
213
|
+
console.log(msg);
|
214
|
+
}
|
215
|
+
|
216
|
+
//#endregion
|
217
|
+
//#region src/parameter-resolver.ts
|
218
|
+
/**
|
219
|
+
* Merges multiple CLI language options with conflict detection.
|
220
|
+
*/
|
221
|
+
function mergeCliLanguageOptions(firstLang, lastLang) {
|
222
|
+
const firstSource = firstLang?.sourceLang ?? null;
|
223
|
+
const firstTarget = firstLang?.targetLang ?? null;
|
224
|
+
const lastSource = lastLang?.sourceLang ?? null;
|
225
|
+
const lastTarget = lastLang?.targetLang ?? null;
|
226
|
+
if (firstSource && lastSource && firstSource !== lastSource) throw new SagmalError(`Conflicting source languages: '${firstSource}' and '${lastSource}'`);
|
227
|
+
if (firstTarget && lastTarget && firstTarget !== lastTarget) throw new SagmalError(`Conflicting target languages: '${firstTarget}' and '${lastTarget}'`);
|
228
|
+
return {
|
229
|
+
sourceLang: lastSource ?? firstSource,
|
230
|
+
targetLang: lastTarget ?? firstTarget
|
231
|
+
};
|
232
|
+
}
|
233
|
+
/**
|
234
|
+
* Resolves source language with cascading priority.
|
235
|
+
* Priority order: CLI → local config → home config → null (auto-detect)
|
236
|
+
*/
|
237
|
+
function resolveSourceLanguage(cliLanguages, configInputs) {
|
238
|
+
let src = null;
|
239
|
+
src ??= cliLanguages.sourceLang;
|
240
|
+
src ??= configInputs.localConfig.deepL?.sourceLang;
|
241
|
+
src ??= configInputs.homeConfig.deepL?.sourceLang;
|
242
|
+
src ??= null;
|
243
|
+
return src;
|
244
|
+
}
|
245
|
+
/**
|
246
|
+
* Resolves target language with cascading priority.
|
247
|
+
* Priority order: CLI → local config → home config → 'en-US' (default)
|
248
|
+
* Also normalizes 'en' to 'en-US'.
|
249
|
+
*/
|
250
|
+
function resolveTargetLanguage(cliLanguages, configInputs) {
|
251
|
+
let target = null;
|
252
|
+
target ??= cliLanguages.targetLang;
|
253
|
+
target ??= configInputs.localConfig.deepL?.targetLang;
|
254
|
+
target ??= configInputs.homeConfig.deepL?.targetLang;
|
255
|
+
target ??= "en-US";
|
256
|
+
if (target.toLowerCase() === "en") target = "en-US";
|
257
|
+
return target;
|
258
|
+
}
|
259
|
+
/**
|
260
|
+
* Merges DeepL API options from config files.
|
261
|
+
* Local config options override home config options.
|
262
|
+
* Validates that no internal-only fields are present.
|
263
|
+
*/
|
264
|
+
function mergeTranslationOptions(configInputs) {
|
265
|
+
const homeOptions = configInputs.homeConfig.deepL?.options;
|
266
|
+
const localOptions = configInputs.localConfig.deepL?.options;
|
267
|
+
if (homeOptions && "__path" in homeOptions) throw new SagmalError("Invalid config: '__path' is an internal-only field and cannot be used in configuration");
|
268
|
+
if (localOptions && "__path" in localOptions) throw new SagmalError("Invalid config: '__path' is an internal-only field and cannot be used in configuration");
|
269
|
+
return {
|
270
|
+
...homeOptions,
|
271
|
+
...localOptions
|
272
|
+
};
|
273
|
+
}
|
274
|
+
/**
|
275
|
+
* Centralized parameter resolution with complete cascading logic.
|
276
|
+
*
|
277
|
+
* Resolution priority (later overrides earlier):
|
278
|
+
* 1. Default values (source: null/auto-detect, target: 'en-US')
|
279
|
+
* 2. Home directory config
|
280
|
+
* 3. Local directory config
|
281
|
+
* 4. CLI language arguments
|
282
|
+
*
|
283
|
+
* Special handling:
|
284
|
+
* - 'en' (case-insensitive) is normalized to 'en-US'
|
285
|
+
* - DeepL options are merged (local overrides home)
|
286
|
+
*
|
287
|
+
* @param cliLanguages - Parsed CLI language arguments (always provided, uses default object if no language specified)
|
288
|
+
* @param configInputs - Configuration inputs from files (always provided, uses empty objects as defaults)
|
289
|
+
* @returns Fully resolved parameters ready for translation
|
290
|
+
*/
|
291
|
+
function resolveParameters(firstCliLanguages, lastCliLanguages, configInputs) {
|
292
|
+
const mergedCliLanguages = mergeCliLanguageOptions(firstCliLanguages, lastCliLanguages);
|
293
|
+
const sourceLanguage = resolveSourceLanguage(mergedCliLanguages, configInputs);
|
294
|
+
const targetLanguage = resolveTargetLanguage(mergedCliLanguages, configInputs);
|
295
|
+
const translationOptions = mergeTranslationOptions(configInputs);
|
296
|
+
return {
|
297
|
+
sourceLanguage,
|
298
|
+
targetLanguage,
|
299
|
+
translationOptions
|
300
|
+
};
|
301
|
+
}
|
302
|
+
|
303
|
+
//#endregion
|
304
|
+
//#region package.json
|
305
|
+
var name = "@fal-works/sagmal";
|
306
|
+
var version = "0.1.0";
|
307
|
+
|
308
|
+
//#endregion
|
309
|
+
//#region src/translator.ts
|
310
|
+
/**
|
311
|
+
* DeepL API client options.
|
312
|
+
*/
|
313
|
+
const clientOptions = { appInfo: {
|
314
|
+
appName: name,
|
315
|
+
appVersion: version
|
316
|
+
} };
|
317
|
+
/**
|
318
|
+
* Translates text using the DeepL API with fully resolved parameters.
|
319
|
+
*
|
320
|
+
* @param apiKey - DeepL API key
|
321
|
+
* @param text - Text to translate
|
322
|
+
* @param params - Fully resolved translation parameters
|
323
|
+
* @returns Translated text
|
324
|
+
*/
|
325
|
+
async function translate(apiKey, text, params) {
|
326
|
+
const client = new DeepLClient(apiKey, clientOptions);
|
327
|
+
const result = await client.translateText(text, params.sourceLanguage, params.targetLanguage, params.translationOptions);
|
328
|
+
return result.text;
|
329
|
+
}
|
330
|
+
|
331
|
+
//#endregion
|
332
|
+
//#region src/bin.ts
|
333
|
+
async function main() {
|
334
|
+
const args = process.argv.slice(2);
|
335
|
+
if (hasHelpOption(args)) {
|
336
|
+
showHelp();
|
337
|
+
process.exit(0);
|
338
|
+
}
|
339
|
+
loadEnvironment();
|
340
|
+
const apiKey = getApiKey();
|
341
|
+
const configInputs = loadConfigInputs();
|
342
|
+
const parseResult = parseCliArguments(args);
|
343
|
+
const text = parseResult.text;
|
344
|
+
if (text.length === 0) {
|
345
|
+
showHelp();
|
346
|
+
process.exit(0);
|
347
|
+
}
|
348
|
+
const resolvedParams = resolveParameters(parseResult.languageOptions.first, parseResult.languageOptions.last, configInputs);
|
349
|
+
const translatedText = await translate(apiKey, text, resolvedParams);
|
350
|
+
console.log(translatedText);
|
351
|
+
}
|
352
|
+
main().catch((error) => {
|
353
|
+
if (error instanceof SagmalError) console.error(error.name, ">", error.message);
|
354
|
+
else if (error instanceof DeepLError) console.error("DeepL API Error", ">", error.name, ">", error.message);
|
355
|
+
else console.error("Sagmal Unknown Error", ">", stringifyError(error));
|
356
|
+
process.exit(1);
|
357
|
+
});
|
358
|
+
|
359
|
+
//#endregion
|
package/package.json
ADDED
@@ -0,0 +1,47 @@
|
|
1
|
+
{
|
2
|
+
"name": "@fal-works/sagmal",
|
3
|
+
"version": "0.1.0",
|
4
|
+
"description": "CLI for text translation using DeepL API",
|
5
|
+
"type": "module",
|
6
|
+
"bin": {
|
7
|
+
"sagmal": "./dist/bin.js"
|
8
|
+
},
|
9
|
+
"sideEffects": false,
|
10
|
+
"files": [
|
11
|
+
"dist/"
|
12
|
+
],
|
13
|
+
"scripts": {
|
14
|
+
"setup": "deps-docs",
|
15
|
+
"build": "tsdown",
|
16
|
+
"lint": "biome check",
|
17
|
+
"lint:fix": "biome check --fix",
|
18
|
+
"check:types": "tsc --noEmit -p tsconfig.json",
|
19
|
+
"check": "npm run check:types && npm run lint",
|
20
|
+
"fix": "npm run check:types && npm run lint:fix",
|
21
|
+
"prepublishOnly": "npm run check"
|
22
|
+
},
|
23
|
+
"keywords": [
|
24
|
+
"translation"
|
25
|
+
],
|
26
|
+
"author": "FAL",
|
27
|
+
"license": "Apache-2.0",
|
28
|
+
"engines": {
|
29
|
+
"node": ">=22.0.0"
|
30
|
+
},
|
31
|
+
"dependencies": {
|
32
|
+
"deepl-node": "^1.19.0",
|
33
|
+
"dotenv": "^17.2.1"
|
34
|
+
},
|
35
|
+
"devDependencies": {
|
36
|
+
"@biomejs/biome": "^2.1.3",
|
37
|
+
"@fal-works/deps-docs": "^0.1.0",
|
38
|
+
"@types/node": "^24.1.0",
|
39
|
+
"tsdown": "^0.13.0",
|
40
|
+
"typescript": "^5.8.3"
|
41
|
+
},
|
42
|
+
"repository": {
|
43
|
+
"type": "git",
|
44
|
+
"url": "git+https://github.com/fal-works/sagmal.git"
|
45
|
+
},
|
46
|
+
"homepage": "https://github.com/fal-works/sagmal#readme"
|
47
|
+
}
|