|
| 1 | +# package-resources-cli |
| 2 | + |
| 3 | +<!-- Generated by swift-argument-parser --> |
| 4 | + |
| 5 | +Code generator for https://github.com/capturecontext/swift-package-resources |
| 6 | + |
| 7 | +``` |
| 8 | +package-resources-cli [--version] [--help] |
| 9 | +``` |
| 10 | + |
| 11 | +**--version:** |
| 12 | + |
| 13 | +*Show the version.* |
| 14 | + |
| 15 | + |
| 16 | +**--help:** |
| 17 | + |
| 18 | +*Show help information.* |
| 19 | + |
| 20 | + |
| 21 | +## package-resources-cli.config |
| 22 | + |
| 23 | +Manages configuration file. |
| 24 | + |
| 25 | +``` |
| 26 | +package-resources-cli config [--path=<path>] [--version] [--help] |
| 27 | +``` |
| 28 | + |
| 29 | +**--path=\<path\>:** |
| 30 | + |
| 31 | +*Path to configuration file* |
| 32 | + |
| 33 | + |
| 34 | +**--version:** |
| 35 | + |
| 36 | +*Show the version.* |
| 37 | + |
| 38 | + |
| 39 | +**--help:** |
| 40 | + |
| 41 | +*Show help information.* |
| 42 | + |
| 43 | + |
| 44 | +### package-resources-cli.config.init |
| 45 | + |
| 46 | +Creates default configuration file |
| 47 | + |
| 48 | +``` |
| 49 | +package-resources-cli config init [--format=<format>] [--encode-aliases] |
| 50 | + [--no-encode-aliases] [--force] [--no-force] [--version] [--help] |
| 51 | +``` |
| 52 | + |
| 53 | +**--format=\<format\>:** |
| 54 | + |
| 55 | +*Custom format* |
| 56 | + |
| 57 | + |
| 58 | +**--encode-aliases:** |
| 59 | + |
| 60 | +*Disables alias resolution for config values* |
| 61 | + |
| 62 | + |
| 63 | +**--no-encode-aliases:** |
| 64 | + |
| 65 | +*Disables alias resolution for config values* |
| 66 | + |
| 67 | + |
| 68 | +**--force:** |
| 69 | + |
| 70 | +*Forces overwritting of an existing config file* |
| 71 | + |
| 72 | + |
| 73 | +**--no-force:** |
| 74 | + |
| 75 | +*Forces overwritting of an existing config file* |
| 76 | + |
| 77 | + |
| 78 | +**--version:** |
| 79 | + |
| 80 | +*Show the version.* |
| 81 | + |
| 82 | + |
| 83 | +**--help:** |
| 84 | + |
| 85 | +*Show help information.* |
| 86 | + |
| 87 | + |
| 88 | + |
| 89 | + |
| 90 | +### package-resources-cli.config.edit |
| 91 | + |
| 92 | +Overwrites configuration file entries |
| 93 | + |
| 94 | +``` |
| 95 | +package-resources-cli config edit [--format=<format>] [--output=<output>] |
| 96 | + [--indentor=<indentor>] [--indent-size=<indent-size>] |
| 97 | + [--numbers-separator=<numbers-separator>] |
| 98 | + [--numbers-next-token-mode=<numbers-next-token-mode>] |
| 99 | + [--numbers-allowed-delimeters=<numbers-allowed-delimeters>] |
| 100 | + [--numbers-single-letter-boundary-options=<numbers-single-letter-boundary-options>...] |
| 101 | + [--acronyms-processing-policy=<acronyms-processing-policy>] |
| 102 | + [--acronyms-values=<acronyms-values>...] [--encode-aliases] |
| 103 | + [--no-encode-aliases] [--remove-output] [--no-remove-output] |
| 104 | + [--remove-indentor] [--no-remove-indentor] [--remove-indent-size] |
| 105 | + [--no-remove-indent-size] [--remove-numbers-separator] |
| 106 | + [--no-remove-numbers-separator] [--remove-numbers-next-token-mode] |
| 107 | + [--no-remove-numbers-next-token-mode] [--remove-numbers-allowed-delimeters] |
| 108 | + [--no-remove-numbers-allowed-delimeters] |
| 109 | + [--remove-numbers-single-letter-boundary-options] |
| 110 | + [--no-remove-numbers-single-letter-boundary-options] |
| 111 | + [--remove-acronyms-processing-policy] [--no-remove-acronyms-processing-policy] |
| 112 | + [--remove-acronyms-values] [--no-remove-acronyms-values] [--version] [--help] |
| 113 | +``` |
| 114 | + |
| 115 | +**--format=\<format\>:** |
| 116 | + |
| 117 | +*Format override* |
| 118 | + |
| 119 | + |
| 120 | +**--output=\<output\>:** |
| 121 | + |
| 122 | +*Path to output file* |
| 123 | + |
| 124 | + |
| 125 | +**--indentor=\<indentor\>:** |
| 126 | + |
| 127 | +*Indentation character* |
| 128 | + |
| 129 | + |
| 130 | +**--indent-size=\<indent-size\>:** |
| 131 | + |
| 132 | +*Number of indentors per indentation level* |
| 133 | + |
| 134 | + |
| 135 | +**--numbers-separator=\<numbers-separator\>:** |
| 136 | + |
| 137 | +*Separator for numbers* |
| 138 | + |
| 139 | + |
| 140 | +**--numbers-next-token-mode=\<numbers-next-token-mode\>:** |
| 141 | + |
| 142 | +*Processsing mode for a token after a number* |
| 143 | + |
| 144 | + |
| 145 | +**--numbers-allowed-delimeters=\<numbers-allowed-delimeters\>:** |
| 146 | + |
| 147 | +*Allowed delimeters for numbers* |
| 148 | + |
| 149 | + |
| 150 | +**--numbers-single-letter-boundary-options=\<numbers-single-letter-boundary-options\>:** |
| 151 | + |
| 152 | +*Processsing mode for a token after a number* |
| 153 | + |
| 154 | + |
| 155 | +**--acronyms-processing-policy=\<acronyms-processing-policy\>:** |
| 156 | + |
| 157 | +*Acronyms processing* |
| 158 | + |
| 159 | + |
| 160 | +**--acronyms-values=\<acronyms-values\>:** |
| 161 | + |
| 162 | +*Acronyms to be treated as a single character in camelCasing* |
| 163 | + |
| 164 | + |
| 165 | +**--encode-aliases:** |
| 166 | + |
| 167 | +*Disables alias resolution for config values* |
| 168 | + |
| 169 | + |
| 170 | +**--no-encode-aliases:** |
| 171 | + |
| 172 | +*Disables alias resolution for config values* |
| 173 | + |
| 174 | + |
| 175 | +**--remove-output:** |
| 176 | + |
| 177 | +*Removes output path from the config file* |
| 178 | + |
| 179 | + |
| 180 | +**--no-remove-output:** |
| 181 | + |
| 182 | +*Removes output path from the config file* |
| 183 | + |
| 184 | + |
| 185 | +**--remove-indentor:** |
| 186 | + |
| 187 | +*Removes indentor from the config file* |
| 188 | + |
| 189 | + |
| 190 | +**--no-remove-indentor:** |
| 191 | + |
| 192 | +*Removes indentor from the config file* |
| 193 | + |
| 194 | + |
| 195 | +**--remove-indent-size:** |
| 196 | + |
| 197 | +*Removes indent-size from the config file* |
| 198 | + |
| 199 | + |
| 200 | +**--no-remove-indent-size:** |
| 201 | + |
| 202 | +*Removes indent-size from the config file* |
| 203 | + |
| 204 | + |
| 205 | +**--remove-numbers-separator:** |
| 206 | + |
| 207 | +*Removes numbers.separator from the config file* |
| 208 | + |
| 209 | + |
| 210 | +**--no-remove-numbers-separator:** |
| 211 | + |
| 212 | +*Removes numbers.separator from the config file* |
| 213 | + |
| 214 | + |
| 215 | +**--remove-numbers-next-token-mode:** |
| 216 | + |
| 217 | +*Removes numbers.next-token-mode from the config file* |
| 218 | + |
| 219 | + |
| 220 | +**--no-remove-numbers-next-token-mode:** |
| 221 | + |
| 222 | +*Removes numbers.next-token-mode from the config file* |
| 223 | + |
| 224 | + |
| 225 | +**--remove-numbers-allowed-delimeters:** |
| 226 | + |
| 227 | +*Removes numbers.allowed-delimeters from the config file* |
| 228 | + |
| 229 | + |
| 230 | +**--no-remove-numbers-allowed-delimeters:** |
| 231 | + |
| 232 | +*Removes numbers.allowed-delimeters from the config file* |
| 233 | + |
| 234 | + |
| 235 | +**--remove-numbers-single-letter-boundary-options:** |
| 236 | + |
| 237 | +*Removes numbers.single-letter-boundary-options from the config file* |
| 238 | + |
| 239 | + |
| 240 | +**--no-remove-numbers-single-letter-boundary-options:** |
| 241 | + |
| 242 | +*Removes numbers.single-letter-boundary-options from the config file* |
| 243 | + |
| 244 | + |
| 245 | +**--remove-acronyms-processing-policy:** |
| 246 | + |
| 247 | +*Removes acronyms.processing-policy from the config file* |
| 248 | + |
| 249 | + |
| 250 | +**--no-remove-acronyms-processing-policy:** |
| 251 | + |
| 252 | +*Removes acronyms.processing-policy from the config file* |
| 253 | + |
| 254 | + |
| 255 | +**--remove-acronyms-values:** |
| 256 | + |
| 257 | +*Removes acronyms.values from the config file* |
| 258 | + |
| 259 | + |
| 260 | +**--no-remove-acronyms-values:** |
| 261 | + |
| 262 | +*Removes acronyms.values from the config file* |
| 263 | + |
| 264 | + |
| 265 | +**--version:** |
| 266 | + |
| 267 | +*Show the version.* |
| 268 | + |
| 269 | + |
| 270 | +**--help:** |
| 271 | + |
| 272 | +*Show help information.* |
| 273 | + |
| 274 | + |
| 275 | + |
| 276 | + |
| 277 | +### package-resources-cli.config.validate |
| 278 | + |
| 279 | +Validates configuration file |
| 280 | + |
| 281 | +``` |
| 282 | +package-resources-cli config validate [--version] [--help] |
| 283 | +``` |
| 284 | + |
| 285 | +**--version:** |
| 286 | + |
| 287 | +*Show the version.* |
| 288 | + |
| 289 | + |
| 290 | +**--help:** |
| 291 | + |
| 292 | +*Show help information.* |
| 293 | + |
| 294 | + |
| 295 | + |
| 296 | + |
| 297 | + |
| 298 | + |
| 299 | +## package-resources-cli.generate |
| 300 | + |
| 301 | +Generates boilerplate for package resources |
| 302 | + |
| 303 | +``` |
| 304 | +package-resources-cli generate [--input=<input>] [--config=<config>] |
| 305 | + [--output=<output>] [--indentor=<indentor>] [--indent-size=<indent-size>] |
| 306 | + [--numbers-separator=<numbers-separator>] |
| 307 | + [--numbers-next-token-mode=<numbers-next-token-mode>] |
| 308 | + [--numbers-allowed-delimeters=<numbers-allowed-delimeters>] |
| 309 | + [--numbers-single-letter-boundary-options=<numbers-single-letter-boundary-options>...] |
| 310 | + [--acronyms-processing-policy=<acronyms-processing-policy>] |
| 311 | + [--acronyms-values=<acronyms-values>...] [--version] [--help] |
| 312 | +``` |
| 313 | + |
| 314 | +**--input=\<input\>:** |
| 315 | + |
| 316 | +*Path to root directory for scanning.* |
| 317 | + |
| 318 | + |
| 319 | +**--config=\<config\>:** |
| 320 | + |
| 321 | +*Path to configuration file* |
| 322 | + |
| 323 | + |
| 324 | +**--output=\<output\>:** |
| 325 | + |
| 326 | +*Path to output file* |
| 327 | + |
| 328 | + |
| 329 | +**--indentor=\<indentor\>:** |
| 330 | + |
| 331 | +*Indentation character* |
| 332 | + |
| 333 | + |
| 334 | +**--indent-size=\<indent-size\>:** |
| 335 | + |
| 336 | +*Number of indentors per indentation level* |
| 337 | + |
| 338 | + |
| 339 | +**--numbers-separator=\<numbers-separator\>:** |
| 340 | + |
| 341 | +*Separator for numbers* |
| 342 | + |
| 343 | + |
| 344 | +**--numbers-next-token-mode=\<numbers-next-token-mode\>:** |
| 345 | + |
| 346 | +*Processsing mode for a token after a number* |
| 347 | + |
| 348 | + |
| 349 | +**--numbers-allowed-delimeters=\<numbers-allowed-delimeters\>:** |
| 350 | + |
| 351 | +*Allowed delimeters for numbers* |
| 352 | + |
| 353 | + |
| 354 | +**--numbers-single-letter-boundary-options=\<numbers-single-letter-boundary-options\>:** |
| 355 | + |
| 356 | +*Processsing mode for a token after a number* |
| 357 | + |
| 358 | + |
| 359 | +**--acronyms-processing-policy=\<acronyms-processing-policy\>:** |
| 360 | + |
| 361 | +*Acronyms processing* |
| 362 | + |
| 363 | + |
| 364 | +**--acronyms-values=\<acronyms-values\>:** |
| 365 | + |
| 366 | +*Acronyms to be treated as a single character in camelCasing* |
| 367 | + |
| 368 | + |
| 369 | +**--version:** |
| 370 | + |
| 371 | +*Show the version.* |
| 372 | + |
| 373 | + |
| 374 | +**--help:** |
| 375 | + |
| 376 | +*Show help information.* |
| 377 | + |
| 378 | + |
| 379 | + |
| 380 | + |
| 381 | +## package-resources-cli.help |
| 382 | + |
| 383 | +Show subcommand help information. |
| 384 | + |
| 385 | +``` |
| 386 | +package-resources-cli help [<subcommands>...] [--version] |
| 387 | +``` |
| 388 | + |
| 389 | +**subcommands:** |
| 390 | + |
| 391 | + |
| 392 | +**--version:** |
| 393 | + |
| 394 | +*Show the version.* |
| 395 | + |
| 396 | + |
| 397 | + |
| 398 | + |
0 commit comments