@twin.org/validate-locales 0.0.3-next.9 → 0.0.3

package/docs/reference/classes/CLI.md

@@ -22,7 +22,71 @@ The main entry point for the CLI.
 
 ## Methods
 
-### run()
+### execute() {#execute}
+
+> **execute**(`options`, `localesDirectory`, `argv`): `Promise`\<`number`\>
+
+Execute the command line processing.
+
+#### Parameters
+
+##### options
+
+`ICliOptions`
+
+The options for the CLI.
+
+##### localesDirectory
+
+`string`
+
+The path to load the locales from.
+
+##### argv
+
+`string`[]
+
+The process arguments.
+
+#### Returns
+
+`Promise`\<`number`\>
+
+The exit code.
+
+#### Inherited from
+
+`CLIBase.execute`
+
+***
+
+### getCommands() {#getcommands}
+
+> `protected` **getCommands**(`program`): `Command`[]
+
+Get the commands for the CLI, override in derived class to supply your own.
+
+#### Parameters
+
+##### program
+
+`Command`
+
+The main program that the commands will be added to.
+
+#### Returns
+
+`Command`[]
+
+The commands for the CLI.
+
+#### Inherited from
+
+`CLIBase.getCommands`
+
+***
+
+### run() {#run}
 
 > **run**(`argv`, `localesDirectory?`, `options?`): `Promise`\<`number`\>
 
@@ -60,7 +124,7 @@ The exit code.
 
 ***
 
-### configureRoot()
+### configureRoot() {#configureroot}
 
 > `protected` **configureRoot**(`program`): `void`
 

package/docs/usage.md

@@ -0,0 +1,35 @@
+# Validate Locales Usage
+
+Use this page to confirm validation options before scanning source files.
+
+## Running
+
+To install and run the CLI locally use the following commands:
+
+```shell
+npm install @twin.org/validate-locales -g
+validate-locales
+```
+
+or run directly using NPX:
+
+```shell
+npx "@twin.org/validate-locales"
+```
+
+## Help
+
+```shell
+validate-locales --help
+
+Usage: validate-locales [options]
+
+Options:
+  --cwd <path>                      Current working directory to scan. (default: ".")
+  --source-glob <glob>              Glob for source files to validate.
+  --locale-file <path>              Locale dictionary file to validate against.
+  --ignore-key-pattern <pattern>    Regex pattern for keys to ignore.
+  --report-unused                   Include unused locale keys in the report.
+  --lang <lang>                     The language to display the output in. (default: "en")
+  -h, --help                        display help for command
+```

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/validate-locales",
-	"version": "0.0.3-next.9",
-	"description": "Tool to validate source files against the locales",
+	"version": "0.0.3",
+	"description": "Validate source files against the locales",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/framework.git",
+		"url": "git+https://github.com/iotaledger/framework.git",
 		"directory": "apps/validate-locales"
 	},
 	"author": "martyn.janes@iota.org",
@@ -14,13 +14,13 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/cli-core": "0.0.3-next.9",
-		"@twin.org/core": "0.0.3-next.9",
-		"@twin.org/nameof": "0.0.3-next.9",
-		"@twin.org/nameof-transformer": "0.0.3-next.9",
-		"commander": "14.0.2",
-		"glob": "11.0.3",
-		"typescript": "5.9.3"
+		"@twin.org/cli-core": "^0.0.3",
+		"@twin.org/core": "^0.0.3",
+		"@twin.org/nameof": "^0.0.3",
+		"@twin.org/nameof-transformer": "^0.0.3",
+		"commander": "14.0.3",
+		"glob": "13.0.6",
+		"typescript": "6.0.3"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
@@ -47,7 +47,7 @@
 		"test": "tests"
 	},
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/framework/issues"
+		"url": "git+https://github.com/iotaledger/framework/issues"
 	},
 	"homepage": "https://twindev.org",
 	"keywords": [

package/docs/examples.md

@@ -1,15 +0,0 @@
-# @twin.org/validate-locales - Examples
-
-## Command Line Tool
-
-First install the tool with the following script.
-
-```shell
-npm install @twin.org/validate-locales
-```
-
-You can then run the tool from the command line e.g.
-
-```shell
-validate-locales
-```