Thank you for approving #11! I'm sorry there is a bug in BudouXText that I added in that pull request, I didn't anticipate at the time.

When BudouXText is used in a language that BudouX does not support (currently non-Japanese), no translation by BudouX.Parser.

(In the example screenshot below, the line break position of "brown" is incorrect.)

|non-ja Before|non-ja After|ja (No change)| |:-:|:-:|:-:| ||||

Thank you for reviewing #12 !

Since the original BudouX doesn't have language detection, I think it is difficult to complete multi-language support in BudouXText. https://github.com/griffin-stewie/BudouX.swift/pull/12#issuecomment-1014545382

This is a very critical point. However, in this package, which is the Swift version of BudouX, it can easily imagine it being used on platforms such as iOS, macOS, tvOS, watchOS, etc. where localization is very significant, and I believe that multi-language support is important.

Based on the above, I would like to propose this pull request again.

1. Change Model from struct to protocol.
2. Model has supportedNaturalLanguages: Set<String> that the original BudouX does not have.
   • Add an option supportedNaturalLanguages for command line execution (this was added to conform to the protocol Model, and does not affect anything at this time).
3. Change the existing jaKNBCModel: [String: Int] to struct JaKNBCModel: Model.
4. Add an argument in BudouXText to tell BudouX's parser whether to do the translation.
   • I had the idea that "the decision to decide whether to translate with BudouX should be done by the user of this package", but this change is highly necessary considering that it makes it "easy to use by simply replacing SwiftUI.Text with BudouXText".
5. Add a property defaultBudouXTextCondition that makes the decision that BudouX's parser will do the translation only if it is in a natural language supported by the Model, based on the localization settings of the current environment in which the application is running.
   • It is now possible to get the localized settings of the execution environment in this package.
   • It wants to use it for JaKNBCModel, which is currently included in this package, it is better if we can determine whether the current execution environment is Japanese or not. For this reason, we have added keys for en and ja.
     • For example, it is expected that users will use a custom model that supports zh. In this case, the defaultBudouXTextCondition cannot be used without submitting a new pull request.
       • However, with the new argument of BudouXText, this problem can be avoided without submitting a pull request.

I hope that this pull request will bring a better evolution to this package!

Thank you for publishing a great library! I wanted to add methods to it for SwiftUI's Text, so I created this pull request.

I have added two public methods.

• BudouXText(verbatim:parser:threshold:)
• BudouXText(_:tableName:bundle:comment:parser:threshold:)

||||| |:-:|:-:|:-:|:-:|

What I tried to do in the beginning

At first, I tried to add a method of the same name to SwiftUI's Text, like the already existing String extension method budouxed(_:). But I couldn't find a way to get the String content that SwiftUI's Text has, so I gave up on that.

Why do methods to be added not use lower-camel-case?

These methods are just to give the SwiftUI's Text content translated from String by BudouX's parser. Therefore, creating a new SwiftUI's View called BudouXText is no longer an option for me. That's because we just want SwiftUI's Text.

I was inspired by NSLocalizedString(_:tableName:bundle:value:comment:). It is not lower-camel-case, but it is a method that returns a String. I thought this would be the most suitable for this usage.

Avoid abbreviations. Abbreviations, especially non-standard ones, are effectively terms-of-art, because understanding depends on correctly translating them into their non-abbreviated forms.

The intended meaning for any abbreviation you use should be easily found by a web search. Swift.org - API Design Guidelines

BudouX.swift needs JaKNBCModel and UnicodeBlocks to run. The original BudouX written in TypeScript contains tools to import JSON file and generate code from Python version's BudouX directory. We do same approach.