fastlane-plugin-swift_doc 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/LICENSE +21 -0
- data/README.md +48 -0
- data/lib/fastlane/plugin/swift_doc.rb +16 -0
- data/lib/fastlane/plugin/swift_doc/actions/swift_doc_action.rb +122 -0
- data/lib/fastlane/plugin/swift_doc/version.rb +5 -0
- metadata +174 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: a68f7d1342f015577ba8d77a3c9ebde05b9ecbd1ed9f157bca7d7ba195a6c9bd
|
4
|
+
data.tar.gz: 50502af44822e98dfc437de8af38ef54fa32950389374f917d52dd7f00796e12
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 35749a6449c8dfaf34638f3f1df21dfc4015ea443d94cd6aec030146522d35f548eef905ee2c0fc588ab0b15529bffbee1f975228455a9d46bc325df8f4166f1
|
7
|
+
data.tar.gz: fefce209aa14bec6c9ea3e1f10774208f05142410e3542363123113823a9faa6697193526c4df27c70025635c16488ad20dcd9eca9208e82a96a47ec820b7a59
|
data/LICENSE
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2021 josh <josh@pepabo.com>
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
13
|
+
copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
21
|
+
SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,48 @@
|
|
1
|
+
# swift_doc plugin
|
2
|
+
|
3
|
+
[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-swift_doc)
|
4
|
+
|
5
|
+
## Getting Started
|
6
|
+
|
7
|
+
This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-swift_doc`, add it to your project by running:
|
8
|
+
|
9
|
+
```bash
|
10
|
+
fastlane add_plugin swift_doc
|
11
|
+
```
|
12
|
+
|
13
|
+
## About swift_doc
|
14
|
+
|
15
|
+
Generate documentation, documentation coverage, or a class diagram using [SwiftDoc](https://github.com/SwiftDocOrg/swift-doc)
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
|
20
|
+
|
21
|
+
## Run tests for this plugin
|
22
|
+
|
23
|
+
To run both the tests, and code style validation, run
|
24
|
+
|
25
|
+
```
|
26
|
+
rake
|
27
|
+
```
|
28
|
+
|
29
|
+
To automatically fix many of the styling issues, use
|
30
|
+
```
|
31
|
+
rubocop -a
|
32
|
+
```
|
33
|
+
|
34
|
+
## Issues and Feedback
|
35
|
+
|
36
|
+
For any other issues and feedback about this plugin, please submit it to this repository.
|
37
|
+
|
38
|
+
## Troubleshooting
|
39
|
+
|
40
|
+
If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
|
41
|
+
|
42
|
+
## Using _fastlane_ Plugins
|
43
|
+
|
44
|
+
For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
|
45
|
+
|
46
|
+
## About _fastlane_
|
47
|
+
|
48
|
+
_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).
|
@@ -0,0 +1,16 @@
|
|
1
|
+
require 'fastlane/plugin/swift_doc/version'
|
2
|
+
|
3
|
+
module Fastlane
|
4
|
+
module SwiftDoc
|
5
|
+
# Return all .rb files inside the "actions" and "helper" directory
|
6
|
+
def self.all_classes
|
7
|
+
Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
|
8
|
+
end
|
9
|
+
end
|
10
|
+
end
|
11
|
+
|
12
|
+
# By default we want to import all available actions and helpers
|
13
|
+
# A plugin can contain any number of actions and plugins
|
14
|
+
Fastlane::SwiftDoc.all_classes.each do |current|
|
15
|
+
require current
|
16
|
+
end
|
@@ -0,0 +1,122 @@
|
|
1
|
+
require 'fastlane/action'
|
2
|
+
|
3
|
+
module Fastlane
|
4
|
+
module Actions
|
5
|
+
class SwiftDocAction < Action
|
6
|
+
def self.run(params)
|
7
|
+
if `which swift-doc`.to_s.length == 0 && params[:executable].nil? && !Helper.test?
|
8
|
+
UI.user_error!("You have to install swift-doc using `brew install swiftdocorg/formulae/swift-doc` or specify the executable path with the `:executable` option.")
|
9
|
+
end
|
10
|
+
|
11
|
+
command = params[:executable] || "swift-doc"
|
12
|
+
mode = params[:mode] || :generate
|
13
|
+
command << " #{mode}"
|
14
|
+
command << optional_flags(params, mode)
|
15
|
+
|
16
|
+
Actions.sh(command)
|
17
|
+
end
|
18
|
+
|
19
|
+
#####################################################
|
20
|
+
# @!group Documentation
|
21
|
+
#####################################################
|
22
|
+
|
23
|
+
def self.description
|
24
|
+
"Generate documentation, documentation coverage, or a class diagram using SwiftDoc"
|
25
|
+
end
|
26
|
+
|
27
|
+
def self.available_options
|
28
|
+
[
|
29
|
+
FastlaneCore::ConfigItem.new(key: :executable,
|
30
|
+
env_name: "FL_SWIFT_DOC_EXECUTABLE",
|
31
|
+
description: "Path to the `swift-doc` executable on your machine",
|
32
|
+
type: String,
|
33
|
+
optional: true),
|
34
|
+
FastlaneCore::ConfigItem.new(key: :mode,
|
35
|
+
env_name: "FL_SWIFT_DOC_MODE",
|
36
|
+
description: "SwiftDoc mode: :generate, :coverage, or :diagram",
|
37
|
+
type: Symbol,
|
38
|
+
default_value: :generate,
|
39
|
+
optional: true),
|
40
|
+
FastlaneCore::ConfigItem.new(key: :minimum_access_level,
|
41
|
+
env_name: "FL_SWIFT_DOC_MINIMUM_ACCESS_LEVEL",
|
42
|
+
description: "SwiftDoc minimum access level: public, internal, etc",
|
43
|
+
type: String,
|
44
|
+
optional: true),
|
45
|
+
FastlaneCore::ConfigItem.new(key: :input_paths,
|
46
|
+
env_name: "FL_SWIFT_DOC_INPUT_PATHS",
|
47
|
+
description: "SwiftDoc input paths for Swift files",
|
48
|
+
type: Array,
|
49
|
+
optional: true),
|
50
|
+
FastlaneCore::ConfigItem.new(key: :output_path,
|
51
|
+
env_name: "FL_SWIFT_DOC_OUTPUT_PATH",
|
52
|
+
description: "The output path for generated files",
|
53
|
+
type: String,
|
54
|
+
optional: true),
|
55
|
+
FastlaneCore::ConfigItem.new(key: :module_name,
|
56
|
+
env_name: "FL_SWIFT_DOC_MODULE_NAME",
|
57
|
+
description: "The module name to work on",
|
58
|
+
type: String,
|
59
|
+
optional: true),
|
60
|
+
FastlaneCore::ConfigItem.new(key: :output_format,
|
61
|
+
env_name: "FL_SWIFT_DOC_OUTPUT_FORMAT",
|
62
|
+
description: "The output format: :commonmark or :html",
|
63
|
+
type: Symbol,
|
64
|
+
optional: true),
|
65
|
+
FastlaneCore::ConfigItem.new(key: :base_url,
|
66
|
+
env_name: "FL_SWIFT_DOC_BASE_URL",
|
67
|
+
description: "The base url to work off of",
|
68
|
+
type: String,
|
69
|
+
optional: true),
|
70
|
+
]
|
71
|
+
end
|
72
|
+
|
73
|
+
def self.optional_flags(params, mode)
|
74
|
+
command = ""
|
75
|
+
command << " --minimum-access-level #{params[:minimum_access_level]}" if params[:minimum_access_level]
|
76
|
+
command << " --inputs #{params[:input_paths].map(&:shellescape).join(', ')}" if params[:input_paths]
|
77
|
+
|
78
|
+
case mode
|
79
|
+
when :generate
|
80
|
+
command << " --module-name #{params[:module_name]}" if params[:module_name]
|
81
|
+
command << " --output #{params[:output_path].shellescape}" if params[:output_path]
|
82
|
+
command << " --format #{params[:output_format]}" if params[:output_format]
|
83
|
+
command << " --base-url #{params[:base_url].shellescape}" if params[:base_url]
|
84
|
+
when :coverage
|
85
|
+
command << " --output #{params[:output_path].shellescape}" if params[:output_path]
|
86
|
+
when :diagram
|
87
|
+
# No unique options here
|
88
|
+
else
|
89
|
+
UI.user_error!("Unexpected mode: #{mode}")
|
90
|
+
end
|
91
|
+
|
92
|
+
return command
|
93
|
+
end
|
94
|
+
|
95
|
+
def self.output
|
96
|
+
end
|
97
|
+
|
98
|
+
def self.return_value
|
99
|
+
end
|
100
|
+
|
101
|
+
def self.authors
|
102
|
+
["Joshua Kaplan"]
|
103
|
+
end
|
104
|
+
|
105
|
+
def self.example_code
|
106
|
+
[
|
107
|
+
'swift_doc',
|
108
|
+
'swift_doc(mode: :coverage)',
|
109
|
+
'swift_doc(module_name: "FooModule")',
|
110
|
+
]
|
111
|
+
end
|
112
|
+
|
113
|
+
def self.category
|
114
|
+
:documentation
|
115
|
+
end
|
116
|
+
|
117
|
+
def self.is_supported?(platform)
|
118
|
+
[:ios, :mac].include?(platform)
|
119
|
+
end
|
120
|
+
end
|
121
|
+
end
|
122
|
+
end
|
metadata
ADDED
@@ -0,0 +1,174 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: fastlane-plugin-swift_doc
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Joshua Kaplan
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2021-04-08 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: pry
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rspec
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rspec_junit_formatter
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: rake
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: rubocop
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - '='
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: 0.49.1
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - '='
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: 0.49.1
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: rubocop-require_tools
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - ">="
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '0'
|
104
|
+
type: :development
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - ">="
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '0'
|
111
|
+
- !ruby/object:Gem::Dependency
|
112
|
+
name: simplecov
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - ">="
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '0'
|
118
|
+
type: :development
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - ">="
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '0'
|
125
|
+
- !ruby/object:Gem::Dependency
|
126
|
+
name: fastlane
|
127
|
+
requirement: !ruby/object:Gem::Requirement
|
128
|
+
requirements:
|
129
|
+
- - ">="
|
130
|
+
- !ruby/object:Gem::Version
|
131
|
+
version: 2.180.0
|
132
|
+
type: :development
|
133
|
+
prerelease: false
|
134
|
+
version_requirements: !ruby/object:Gem::Requirement
|
135
|
+
requirements:
|
136
|
+
- - ">="
|
137
|
+
- !ruby/object:Gem::Version
|
138
|
+
version: 2.180.0
|
139
|
+
description:
|
140
|
+
email: yhkaplan@gmail.com
|
141
|
+
executables: []
|
142
|
+
extensions: []
|
143
|
+
extra_rdoc_files: []
|
144
|
+
files:
|
145
|
+
- LICENSE
|
146
|
+
- README.md
|
147
|
+
- lib/fastlane/plugin/swift_doc.rb
|
148
|
+
- lib/fastlane/plugin/swift_doc/actions/swift_doc_action.rb
|
149
|
+
- lib/fastlane/plugin/swift_doc/version.rb
|
150
|
+
homepage: https://github.com/yhkaplan/fastlane-plugin-swift_doc
|
151
|
+
licenses:
|
152
|
+
- MIT
|
153
|
+
metadata: {}
|
154
|
+
post_install_message:
|
155
|
+
rdoc_options: []
|
156
|
+
require_paths:
|
157
|
+
- lib
|
158
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
159
|
+
requirements:
|
160
|
+
- - ">="
|
161
|
+
- !ruby/object:Gem::Version
|
162
|
+
version: '0'
|
163
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
164
|
+
requirements:
|
165
|
+
- - ">="
|
166
|
+
- !ruby/object:Gem::Version
|
167
|
+
version: '0'
|
168
|
+
requirements: []
|
169
|
+
rubygems_version: 3.1.4
|
170
|
+
signing_key:
|
171
|
+
specification_version: 4
|
172
|
+
summary: Generate documentation, documentation coverage, or a class diagram using
|
173
|
+
SwiftDoc
|
174
|
+
test_files: []
|