Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/minuscorp/ModuleInterface
Swift tool to generate Module Interfaces for Swift projects.
https://github.com/minuscorp/ModuleInterface
command-line-tool documentation-generator swift
Last synced: 3 months ago
JSON representation
Swift tool to generate Module Interfaces for Swift projects.
- Host: GitHub
- URL: https://github.com/minuscorp/ModuleInterface
- Owner: minuscorp
- License: apache-2.0
- Created: 2019-11-21T15:08:50.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-11-17T09:19:04.000Z (almost 2 years ago)
- Last Synced: 2024-06-19T03:04:31.398Z (5 months ago)
- Topics: command-line-tool, documentation-generator, swift
- Language: Swift
- Size: 126 KB
- Stars: 81
- Watchers: 3
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - ModuleInterface - Command Line Tool that generates the Module's Interface from a Swift project. (Command Line / Linter)
- awesome-ios-star - ModuleInterface - Command Line Tool that generates the Module's Interface from a Swift project. (Command Line / Linter)
- fucking-awesome-ios - ModuleInterface - Command Line Tool that generates the Module's Interface from a Swift project. (Command Line / Linter)
- fucking-awesome-ios - ModuleInterface - Command Line Tool that generates the Module's Interface from a Swift project. (Command Line / Linter)
README
# ModuleInterface
[](https://travis-ci.org/minuscorp/ModuleInterface)
Swift tool to generate Module Interfaces for Swift projects.
## What is a Module Interface
A Module Interface is what we commonly get using the CMD+click on an `import` statement in our codebases. SourceKit generates the code on demand. It can be a great tool and source of documentation.
[](https://asciinema.org/a/284079)
### Examples
* [Commandant](Examples/Commandant.swift)
* [Mini](Examples/Mini.swift)
* [SourceKittenFramework](Examples/SourceKittenFramework.swift)
* [Yams](Examples/Yams.swift)
* [SwiftLintFramework](Examples/SwiftLintFramework.swift)
## Usage
To generate the module interface from your project, or library, run the `moduleinterface` command directly from the root your project.
```
$ cd ~/path/to/MyAppOrFramework
$ moduleinterface generate
```
This command will analyze your MyAppOrFramework project and generate the module interface for the types that have the minimum access level defined. The module interface is written to the directory Documentation relative to the root of your project repository.
### Usage options
```
$ moduleinterface help
Available commands:
clean Delete the output folder and quit.
generate Generates the Module Interface
help Display general or command-specific help
version Display the current version of ModuleInterface
```
Typing `moduleinterface help ` we get a list of all options for that command:
```
Generates the Swift Module Interface.
[--spm-module (string)]
Generate documentation for Swift Package Manager module.
[--module-name (string)]
Generate documentation for a Swift module.
[--input-folder (string)]
Path to the input directory (defaults to /Users/minuscorp/Documents/GitHub/ModuleInterface).
[--output-folder (string)]
Output directory (defaults to Documentation).
[--min-acl (string)]
The minimum access level to generate documentation. Defaults to public.
--clean|-c
Delete output folder before generating documentation.
[[]]
List of arguments to pass to xcodebuild.
```
Usually, for most Xcode projects, no parameters are needed at all. xcodebuild should be able to find the default project and scheme.
If the command fails, try specifying the scheme (-scheme SchemeName) or the workspace. Any arguments passed to `moduleinterface` after `--` will be passed to xcodebuild without modification.
`$ moduleinterface generate -- -scheme MyScheme`
For Swift Package Manager modules, you can the module name using the --spm-module parameter.
`$ moduleinterface generate --spm-module ModuleInterface`
## Installation
### Download Binary
```
$ curl -Ls https://github.com/minuscorp/ModuleInterface/releases/download/latest/moduleinterface.macos.zip -o /tmp/moduleinterface.macos.zip
$ unzip -j -d /usr/local/bin /tmp/moduleinterface.macos.zip
```
### From Sources
Requirements:
Swift 5.1 runtime and Xcode installed in your computer.
### Using Homebrew
`brew tap minuscorp/moduleinterface`
`brew install moduleinterface`
### Building with Swift Package Manager
```
$ git clone https://github.com/minuscorp/ModuleInterface.git
$ cd ModuleInterface
$ make
```
## Contact
Follow and contact me on Twitter at [@minuscorp](https://twitter.com/minuscorp).
## Contributions
If you find an issue, just [open a ticket](https://github.com/minuscorp/ModuleInterface/issues/new) on it. Pull requests are warmly welcome as well.
## License
ModuleInterface is licensed under the Apache 2.0. See [LICENSE](https://github.com/minuscorp/ModuleInterface/blob/master/LICENSE) for more info.
## Acknowledegments
- To [@eneko](https://twitter.com/eneko) for giving me the tooling idea.
- To [SourceKitten](https://github.com/jpsim/SourceKitten) for providing such an awesome Framework for dealing with SourceKit.
- To [BQ](https://github.com/bq) for all the mentoring.