@translated/lara-cli 0.2.1 → 1.0.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.
Files changed (2) hide show
  1. package/README.md +93 -66
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -6,88 +6,34 @@ Lara Cli automates translation of your i18n files with a single command, preserv
6
6
 
7
7
  Supports multiple file formats including JSON, PO (gettext), TypeScript, Vue I18n single-file components, Markdown and MDX files, and Android XML string resource files. See [Supported Formats](docs/config/formats.md) for details.
8
8
 
9
- [![Version](https://img.shields.io/badge/version-0.2.1-blue.svg)](https://github.com/translated/lara-cli)
9
+ [![Version](https://img.shields.io/badge/version-1.0.0-blue.svg)](https://github.com/translated/lara-cli)
10
10
 
11
11
  </div>
12
12
 
13
- > **⚠️ Development Mode Only:** This tool is currently available in Development mode. The full release is coming soon! 🚀
14
-
15
13
  ## 📑 Table of Contents
16
14
 
17
- - [Requirements](#requirements)
18
- - [Local Development Setup](#local-development-setup)
15
+ - [Installation](#installation)
19
16
  - [Setting Up Your Project](#setting-up-your-project)
17
+ - [Local Development Setup](#local-development-setup)
20
18
  - [Technology Stack](#technology-stack)
21
19
  - [Supported Locales](#supported-locales)
22
20
  - [Documentation](#documentation)
23
21
 
24
- ## Requirements
25
-
26
- - Node.js v18 or higher
27
- - pnpm v8 or higher
28
-
29
- ## Local Development Setup
30
-
31
- 1. **Clone the repository**
32
-
33
- ```bash
34
- git clone https://github.com/translated/lara-cli.git
35
- ```
36
-
37
- 2. **Navigate to the cloned repository**
38
-
39
- ```bash
40
- cd lara-cli
41
- ```
42
-
43
- 3. **Install dependencies and build**
44
-
45
- > **Note:** This project uses pnpm. If you don't have it installed, run: `npm install -g pnpm`. Verify the installation with `pnpm -v` before proceeding with the following commands.
46
-
47
- ```bash
48
- pnpm install
49
- pnpm run build
50
- ```
51
-
52
- 4. **Setup pnpm global bin directory (first time only)**
22
+ ## Installation
53
23
 
54
- ```bash
55
- pnpm setup
56
- ```
57
-
58
- This command configures your shell to add the pnpm global bin directory to your PATH. After running it, you'll see output similar to:
24
+ ### Requirements
59
25
 
60
- ```bash
61
- Appended new lines to /Users/<username>/.zshrc
62
-
63
- Next configuration changes were made:
64
- export PNPM_HOME="/Users/<username>/Library/pnpm"
65
- case ":$PATH:" in
66
- *":$PNPM_HOME:"*) ;;
67
- *) export PATH="$PNPM_HOME:$PATH" ;;
68
- esac
69
- ```
70
-
71
- Add these lines to your shell profile (`.zshrc`, `.bashrc`, etc.) or restart your terminal to apply the changes. This ensures you can run globally installed pnpm packages.
72
-
73
- 5. **Link globally**
74
-
75
- ```bash
76
- pnpm link --global
77
- ```
26
+ - Node.js v18 or higher
78
27
 
79
- > **Note:** If you experience an error like `ERR_PNPM_NO_GLOBAL_BIN_DIR`, you may need to manually copy and paste the lines added by `pnpm setup` into your shell profile. After doing so, restart your terminal or source your profile file, and you should be able to proceed.
28
+ ### Install via npm
80
29
 
81
- After running this command, the project will be successfully linked to the pnpm global library. You should see a response similar to:
30
+ The easiest way to get started is to install Lara CLI globally via npm:
82
31
 
83
32
  ```bash
84
- /Users/username/Library/pnpm/global/5:
85
- + lara-cli version <- ../../../../Projects/translated/lara-cli
33
+ npm install -g @translated/lara-cli
86
34
  ```
87
35
 
88
- 6. **Installation Complete - Use anywhere**
89
-
90
- Now that Lara CLI is installed globally, you can use it from any directory on your system:
36
+ Once installed, you can use it from any directory:
91
37
 
92
38
  ```bash
93
39
  # Get help with available commands
@@ -100,8 +46,6 @@ lara-cli init --help
100
46
  lara-cli translate --help
101
47
  ```
102
48
 
103
- **Note:** After making changes to the source code, run `pnpm run build` to update the global command.
104
-
105
49
  ## Setting Up Your Project
106
50
 
107
51
  ### Add Your Credentials to `.env`
@@ -164,6 +108,89 @@ That's it – you're ready to go!
164
108
 
165
109
  > **📖 Documentation:** For detailed information about commands, see [Init Command](docs/commands/init.md) and [Translate Command](docs/commands/translate.md).
166
110
 
111
+ ## Local Development Setup
112
+
113
+ If you want to contribute to Lara CLI or run it from source, follow these steps.
114
+
115
+ ### Requirements
116
+
117
+ - Node.js v18 or higher
118
+ - pnpm v8 or higher
119
+
120
+ 1. **Clone the repository**
121
+
122
+ ```bash
123
+ git clone https://github.com/translated/lara-cli.git
124
+ ```
125
+
126
+ 2. **Navigate to the cloned repository**
127
+
128
+ ```bash
129
+ cd lara-cli
130
+ ```
131
+
132
+ 3. **Install dependencies and build**
133
+
134
+ > **Note:** This project uses pnpm. If you don't have it installed, run: `npm install -g pnpm`. Verify the installation with `pnpm -v` before proceeding with the following commands.
135
+
136
+ ```bash
137
+ pnpm install
138
+ pnpm run build
139
+ ```
140
+
141
+ 4. **Setup pnpm global bin directory (first time only)**
142
+
143
+ ```bash
144
+ pnpm setup
145
+ ```
146
+
147
+ This command configures your shell to add the pnpm global bin directory to your PATH. After running it, you'll see output similar to:
148
+
149
+ ```bash
150
+ Appended new lines to /Users/<username>/.zshrc
151
+
152
+ Next configuration changes were made:
153
+ export PNPM_HOME="/Users/<username>/Library/pnpm"
154
+ case ":$PATH:" in
155
+ *":$PNPM_HOME:"*) ;;
156
+ *) export PATH="$PNPM_HOME:$PATH" ;;
157
+ esac
158
+ ```
159
+
160
+ Add these lines to your shell profile (`.zshrc`, `.bashrc`, etc.) or restart your terminal to apply the changes. This ensures you can run globally installed pnpm packages.
161
+
162
+ 5. **Link globally**
163
+
164
+ ```bash
165
+ pnpm link --global
166
+ ```
167
+
168
+ > **Note:** If you experience an error like `ERR_PNPM_NO_GLOBAL_BIN_DIR`, you may need to manually copy and paste the lines added by `pnpm setup` into your shell profile. After doing so, restart your terminal or source your profile file, and you should be able to proceed.
169
+
170
+ After running this command, the project will be successfully linked to the pnpm global library. You should see a response similar to:
171
+
172
+ ```bash
173
+ /Users/username/Library/pnpm/global/5:
174
+ + lara-cli version <- ../../../../Projects/translated/lara-cli
175
+ ```
176
+
177
+ 6. **Development Complete - Use anywhere**
178
+
179
+ Now that Lara CLI is linked globally, you can use it from any directory on your system:
180
+
181
+ ```bash
182
+ # Get help with available commands
183
+ lara-cli --help
184
+
185
+ # Initialize a new Lara project
186
+ lara-cli init --help
187
+
188
+ # Translate your localization files
189
+ lara-cli translate --help
190
+ ```
191
+
192
+ **Note:** After making changes to the source code, run `pnpm run build` to update the global command.
193
+
167
194
  ## Technology Stack
168
195
 
169
196
  Lara CLI is built with modern technologies to ensure reliability, performance, and maintainability:
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@translated/lara-cli",
3
3
  "type": "module",
4
- "version": "0.2.1",
4
+ "version": "1.0.0",
5
5
  "description": "CLI tool for automated i18n file translation using Lara Translate",
6
6
  "repository": {
7
7
  "type": "git",