Manage integrity checkers on repo types from the CLI by nmkedziora · Pull Request #1105 · box/mojito

nmkedziora · 2026-10-08T05:48:34Z

Summary

Repo types can now set integrity checkers from the CLI, the same way repositories already can.

repo-type-create --integrity-check stores the checkers with the new type.
repo-type-update --integrity-check replaces the whole set. Leave the flag off to keep the current checkers. Pass an empty value (-it "") to clear them.
repo-type-view prints each checker as extension:TYPE.
repo-type-list shows how many checkers a type has. Add --verbose to print each one on its own line.
Command help for --integrity-check lists every IntegrityCheckerType, including types that were missing from the old hardcoded list.

Test

1. Create a repository type with integrity checkers

mojito-local repo-type-create -n TestType \
  -d "Lorem ipsum..." \
  -it "properties:MESSAGE_FORMAT,properties:TRAILING_WHITESPACE"

2. List repository types

By default, the command displays the number of configured integrity checkers.

mojito-local repo-type-list

Example output:

Repo type id --> 1
Name --> TestType
Integrity checkers --> contains 2 values

Use --verbose to display each checker separately.

mojito-local repo-type-list --verbose

Example output:

Integrity checkers --> properties:MESSAGE_FORMAT
properties:TRAILING_WHITESPACE

3. View a repository type

mojito-local repo-type-view -n TestType

Example output:

Integrity checkers --> properties:MESSAGE_FORMAT,properties:TRAILING_WHITESPACE

4. Update or clear integrity checkers

Pass an empty value to --integrity-check to remove all configured checkers.

mojito-local repo-type-update -n TestType -it ""

Verify that the checkers have been removed.

mojito-local repo-type-view -n TestType

The output no longer contains an Integrity checkers entry.

5. Assign a repository type

Create a repository using the repository type.

mojito-local repo-create -n TestRepo --repo-type TestType -l fr-FR

Verify the assignment.

mojito-local repo-view -n TestRepo

Example output:

Repository id --> 1
Repository type --> TestType
Repository locales --> fr-FR

6. Delete a repository type

A repository type cannot be deleted while it is assigned to one or more repositories.

mojito-local repo-type-delete -n TestType

Remove the repository type assignment.

mojito-local repo-update -n TestRepo --repo-type ""

Delete the repository type.

mojito-local repo-type-delete -n TestType

CLAassistant · 2026-10-08T05:48:42Z

All committers have signed the CLA.

kkuliczkowski-box · 2026-10-13T08:08:00Z

+  static final String INTEGRITY_CHECK_DESCRIPTION =
+      "Replaces integrity checkers for this repo type, comma separated format: \"FILE_EXTENSION_1:CHECKER_TYPE_1,FILE_EXTENSION_2:CHECKER_TYPE_2\"\n       "
+          + "Omitting the flag leaves existing checkers unchanged. An empty value clears them.\n       "
+          + "Available Checker types: "
+          + IntegrityCheckerCli.AVAILABLE_CHECKER_TYPES_TOKEN
+          + "\n       "
+          + "For example: \"properties:MESSAGE_FORMAT,properties:TRAILING_WHITESPACE\"";


[Suggestion] Add a help-text test for the {availableCheckerTypes} placeholder
Files: cli/.../L10nJCommander.java (L199–210), RepoCommand.java (L16–22), RepoTypeCreateCommand.java (L73–78), RepoTypeUpdateCommand.java (L77–83)

This also changes the help output of repo-create and repo-update, but nothing tests the substitution. If a future usage path skips L10nJCommander.usage(String), users will see a literal {availableCheckerTypes}. Could we add a test that runs repo-create -h and repo-type-create -h and asserts that:

the output does not contain {availableCheckerTypes}

the output contains a type that was missing from the old hardcoded list (e.g. FLUENT or MISC_AI_TRANSLATE)

Also worth mentioning in the PR description: the help list now shows all 21 enum values instead of the previous 13.

Added help tests for repo-create -h and repo-type-create -h. Both go through L10nJCommander.usage, which replaces {availableCheckerTypes} with every IntegrityCheckerType.

The tests assert the placeholder is gone and that the output includes types missing from the old hardcoded list (FLUENT, MISC_AI_TRANSLATE). I also noted in the PR description that command help now lists every checker type from the enum, including those that were missing before.

kkuliczkowski-box · 2026-10-13T08:10:03Z

+      String[] param = StringUtils.delimitedListToStringArray(integrityCheckerParam, ":");
+      if (param.length != 2) {
+        throw new ParameterException(
+            "Invalid integrity checker format [" + integrityCheckerParam + "]");
+      }
+      String fileExtension = param[0];
+      String checkerType = param[1];
+      IntegrityChecker integrityChecker = new IntegrityChecker();
+      integrityChecker.setAssetExtension(fileExtension);
+      try {
+        integrityChecker.setIntegrityCheckerType(IntegrityCheckerType.valueOf(checkerType));
+      } catch (IllegalArgumentException ex) {
+        throw new ParameterException("Invalid integrity checker type [" + checkerType + "]");
+      }


[Suggestion] Throw CommandException from IntegrityCheckerCli.parse instead of ParameterException
Files: cli/.../IntegrityCheckerCli.java (L58–71), RepoTypeCreateCommand.java (L101–102), RepoTypeUpdateCommand.java (L126–127)

parse declares throws CommandException, but it actually throws the unchecked ParameterException. The repo-type commands catch and wrap it, so they print a short error. The repo-* commands don't, so repo-create -it properties:NOPE still ends up in L10nJCommander's catch (Throwable) and prints "Unexpected error" plus a stack trace.

Since the parser is shared now, throwing CommandException directly would give both command families the same short error and remove the two catch (ParameterException ex) blocks. Fine as a follow-up if you'd rather keep repo-* behaviour unchanged in this PR.

I'd rather keep repo-* behavior unchanged in this PR

I checked all callers and the repo-* commands already handle this case. Both RepoCreateCommand and RepoUpdateCommand catch ParameterException and wrap it in CommandException, so an invalid checker produces the same short CLI error and does not reach L10nJCommander’s catch (Throwable).

That handling predates this PR. The new repo-type-* callers perform the same mapping explicitly. ParameterException also remains consistent with the existing CLI parsers for malformed parameter values, so I’d prefer to keep the current exception type.

I added explicit regression tests for invalid checkers on repo-create and repo-update, but changing the exception type would not change the user-visible behavior.

kkuliczkowski-box · 2026-10-13T08:12:26Z

+- At least one of `--new-name`, `--description`, `--ai-prompt`, `--ai-prompt-file`, or `--integrity-check` / `-it` is required; otherwise `Must provide at least one of the following options: --new-name, --description, --ai-prompt, --ai-prompt-file, --integrity-check`.
 - PATCH body sets only the fields the user passed; omitted flags stay `null` so the server leaves those columns unchanged (see [PATCH semantics](#6-patch-null-means-leave-unchanged)).
- Checkers: `integrityCheckers` is left Java `null` so `NON_NULL` omits the property (unchanged). A non-null empty set would serialize as `[]` and clear them. There is no checkers CLI flag yet.
+- Omitted `--integrity-check` / `-it` leaves Java `integrityCheckers` null, so `NON_NULL` omits the property and existing checkers stay. A present value replaces the full set, same `FILE_EXTENSION:CHECKER_TYPE` list as create. The same pair twice, including a leading dot on the extension, is stored once. An empty value sends `[]` and clears every checker. An unknown checker type fails before the request with `Invalid integrity checker type [<type>]`.


[Suggestion] Validate --integrity-check before looking up the repo type in repo-type-update
Files: cli/.../RepoTypeUpdateCommand.java (L106–111), docs/internal/Architecture.md (Update section, ~L401)

commandHelper.findRepoTypeByName(nameParam) runs before IntegrityCheckerCli.parse(...). So a bad -it value still costs a GET, and if the type name is also wrong, the user sees "not found" instead of the input error. Parsing (and resolving the AI prompt) before the lookup would fail fast with no network call, and would make the doc line "An unknown checker type fails before the request" accurate for update as well as create.

@kkuliczkowski-box
Thanks — the lookup-before-local-validation order predates this change.

repo-type-update already resolves the existing type before validating the AI prompt or reading the prompt file.

repo-update follows a similar lookup-before-parse sequence.

This PR preserves existing behavior while adding integrity-check parsing.
Moving only checker validation would make validation order inconsistent, while moving all local validation would be a broader behavioral refactor.

I’ll clarify the architecture wording to say the invalid checker fails before the PATCH request.

Done. The Update section now says an unknown checker type fails before the PATCH request with Invalid integrity checker type [<type>]. The name lookup can still issue a GET first.

…epo create. Build the available checker names from the enum so the help text stays aligned with the types the CLI accepts.

Omitting the flag leaves the set unchanged, and an empty value sends an empty list so the type's checkers are cleared.

Print each extension and checker type on one line, and omit that line when the type has none.

…erbose. The default line is a count so a long catalog stays short, and --verbose prints each extension and checker type.

…er the name lookup.

…s a short CLI error.

…eft as a placeholder. repo-create -h and repo-type-create -h must not print the placeholder and must include checker types missing from the old hardcoded list.

… record that the CLI sets them. Also lock the singular list count and drop the unrelated .conduit ignore entry.

repo-update and repo-type-update -h must substitute the placeholder with every IntegrityCheckerType, the same way create already does.

…after installing Mojito.

Document repository types for CLI usage

nmkedziora requested a review from ehoogerbeets October 8, 2026 05:48

kkuliczkowski-box reviewed Oct 13, 2026

View reviewed changes

nmkedziora added 11 commits October 14, 2026 14:13

Let repo-type-create store integrity checkers with the same flag as r…

75b15ad

…epo create. Build the available checker names from the enum so the help text stays aligned with the types the CLI accepts.

Let repo-type-update replace, keep, or clear integrity checkers.

d0ce243

Omitting the flag leaves the set unchanged, and an empty value sends an empty list so the type's checkers are cleared.

Show a repo type's integrity checkers from repo-type-view.

27ff1de

Print each extension and checker type on one line, and omit that line when the type has none.

Summarize integrity checkers on repo-type-list and expand them with v…

4dfcb11

…erbose. The default line is a count so a long catalog stays short, and --verbose prints each extension and checker type.

Clarify that an unknown repo-type checker fails before the PATCH, aft…

f21d303

…er the name lookup.

Lock repo-create and repo-update so an unknown integrity checker stay…

ec259f4

…s a short CLI error.

Format the repo-type checker CLI so the Spotless check passes.

6d869f1

Lock command help so the integrity checker list is substituted, not l…

e3ea3fd

…eft as a placeholder. repo-create -h and repo-type-create -h must not print the placeholder and must include checker types missing from the old hardcoded list.

Share repo-type checker formatting so view and list cannot drift, and…

672c6d9

… record that the CLI sets them. Also lock the singular list count and drop the unrelated .conduit ignore entry.

Lock every integrity-check help path so it prints the full checker list.

5d674db

repo-update and repo-type-update -h must substitute the placeholder with every IntegrityCheckerType, the same way create already does.

Add a user guide so operators can create and manage repository types …

f0535db

…after installing Mojito.

nmkedziora force-pushed the repo-type-create-integrity-checkers branch from b477f14 to 5d674db Compare October 14, 2026 12:14

Merge pull request #1106 from box/docs-repository-types

9e5e38a

Document repository types for CLI usage

kkuliczkowski-box approved these changes Oct 14, 2026

View reviewed changes

nmkedziora merged commit 61ef781 into master Oct 14, 2026
6 checks passed

Navigation Menu

Repository navigation

Manage integrity checkers on repo types from the CLI - #1105

Manage integrity checkers on repo types from the CLI#1105
nmkedziora merged 12 commits into
masterfrom
repo-type-create-integrity-checkers

nmkedziora commented Oct 8, 2026 •

edited

Loading

Uh oh!

CLAassistant commented Oct 8, 2026 •

edited

Loading

Uh oh!

kkuliczkowski-box Oct 13, 2026

Uh oh!

nmkedziora Oct 14, 2026

Uh oh!

kkuliczkowski-box Oct 13, 2026

Uh oh!

nmkedziora Oct 14, 2026

Uh oh!

kkuliczkowski-box Oct 13, 2026

Uh oh!

nmkedziora Oct 13, 2026 •

edited

Loading

Uh oh!

nmkedziora Oct 14, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

nmkedziora commented Oct 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test

1. Create a repository type with integrity checkers

2. List repository types

3. View a repository type

4. Update or clear integrity checkers

5. Assign a repository type

6. Delete a repository type

Uh oh!

CLAassistant commented Oct 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kkuliczkowski-box Oct 13, 2026

Choose a reason for hiding this comment

Uh oh!

nmkedziora Oct 14, 2026

Choose a reason for hiding this comment

Uh oh!

kkuliczkowski-box Oct 13, 2026

Choose a reason for hiding this comment

Uh oh!

nmkedziora Oct 14, 2026

Choose a reason for hiding this comment

Uh oh!

kkuliczkowski-box Oct 13, 2026

Choose a reason for hiding this comment

Uh oh!

nmkedziora Oct 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nmkedziora Oct 14, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

nmkedziora commented Oct 8, 2026 •

edited

Loading

CLAassistant commented Oct 8, 2026 •

edited

Loading

nmkedziora Oct 13, 2026 •

edited

Loading