Add CLI and Swift Package Manager Plugin

[ollieatkinson]

Add lexicon-generate CLI and a Swift Package Manager Plugin for automatically generating swift identifiers from lexicon documents.

CLI

Generate identifiers for a given lexicon document

OVERVIEW: A utility for generating code from lexicon documents.

USAGE: lexicon-generate <input> [--output <output>] --type <type> [--quiet]

ARGUMENTS:
  <input>

OPTIONS:
  -o, --output <output>
  -t, --type <type>
  -q, --quiet
  --version               Show the version.
  -h, --help              Show help information.

Generate mindflare identifiers in swift, kotlin and json

$ lexicon-generate mindflare.lexicon --type swift,kotlin,json

Plugin

Automatically generates swift identifiers for all lexicon documents in your target, run at build time and generated to the derived plugin work directory

[ollieatkinson]

Inside of this P/R I noticed a problem with how inherited node own types were being resolved.

Given the following lexicon:

root:
  db:
    collection:
      id:
    user:
    + root.db.collection

root.user.id is inherited from root.db.collection.id, the is(_:) check which validated if the user id is of the same type of collection id was returning false. Inherited nodes should validate their types against their parent nodes with similar names to the one currently used.

A test has been added to ensure this case is covered

await root["user", "id"].is(root["db", "collection", "id"]) == true

[ollieatkinson]

You can validate the plugins via this test package:

// swift-tools-version: 5.6

import PackageDescription

let package = Package(
    name: "Test",
    platforms: [.macOS(.v11)],
    products: [
        .library(name: "Test", targets: ["Test"])
    ],
    dependencies: [
        .package(url: "https://github.com/thousandyears/Lexicon", branch: "oliver/swift-package-manager-plugin")
    ],
    targets: [
        .target(
            name: "Test",
            resources: [
                .copy("example.taskpaper")
            ],
            plugins: [
                .plugin(name: "SwiftStandAloneGeneratorPlugin", package: "Lexicon")
            ]
        )
    ]
)

[screensailor]

I've tested the plugin on macOS 13.0 Beta and XCode 14.0 Beta and it works 👍.
As you no doubt know, it is likely that Swift 5.7 and the new Xcode will allow you to refine and extend this further :)

[screensailor]

I've tested the plugin on macOS 13.0 Beta and XCode 14.0 Beta and it works 👍.
As you no doubt know, it is likely that Swift 5.7 and the new Xcode will allow you to refine and extend this further :)

[screensailor]

Minor questions about naming conventions...

Wonderful to have the command line tool and the plugins!

And super important to also have the fix for the types of inherited nodes!

Thank you Ollie

[ollieatkinson]

@screensailor I also added the ability to pass a http URL to the generator, possibly useful in certain scenarios:

lexicon-generate https://raw.githubusercontent.com/thousandyears/MindFlare/trunk/App/Library/Sources/Library/Resources/Test.lexicon --output /tmp/test --type swift

[screensailor]

URL argument is a lovely option Ollie 👍

[NoahKnudsen]

Excellent work Ollie! This is a huge improvement to workflows!