Documented the AssetPrefix enumeration in the library target.
This commit is contained in:
parent
65415fad52
commit
d59b64afdb
@ -1,11 +1,20 @@
|
|||||||
|
/// An enumeration that represents all possible static assets folder where assets included into the `DocC`catalog and code generated by the `DocC` building process. will be stored.
|
||||||
enum AssetPrefix: String, CaseIterable {
|
enum AssetPrefix: String, CaseIterable {
|
||||||
|
/// A folder that contains all CSS code generated by the `DocC` building process.
|
||||||
case css
|
case css
|
||||||
|
/// A folder that contains all documentation data extracted from the source code by the `DocC` building process.
|
||||||
case data
|
case data
|
||||||
|
/// A folder that contains all other resources included into the `DocC` documentation catalog.
|
||||||
case downloads
|
case downloads
|
||||||
|
/// A folder that contains all image resources included into the `DocC` documentation catalog.
|
||||||
case images
|
case images
|
||||||
|
/// A folder that contains all image resources included into the `DocC` documentation catalog.
|
||||||
case img
|
case img
|
||||||
|
/// A folder that contains all `HTML` code generated by the `DocC` building process.
|
||||||
case index
|
case index
|
||||||
|
/// A folder that contains all `Javascript` code generated by the `DocC` building process.
|
||||||
case js
|
case js
|
||||||
|
/// A folder that contains all video resources included into the `DocC` documentation catalog.
|
||||||
case videos
|
case videos
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -16,7 +25,7 @@ extension AssetPrefix: Pathable {
|
|||||||
// MARK: Computed
|
// MARK: Computed
|
||||||
|
|
||||||
var path: String {
|
var path: String {
|
||||||
.init(format: .Format.pathRoot, rawValue)
|
.init(format: .Format.Path.root, rawValue)
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
@ -0,0 +1,42 @@
|
|||||||
|
import Testing
|
||||||
|
|
||||||
|
@testable import AppLibrary
|
||||||
|
|
||||||
|
@Suite("AssetPrefix")
|
||||||
|
struct AssetPrefixTests {
|
||||||
|
|
||||||
|
// MARK: Properties tests
|
||||||
|
|
||||||
|
@Test(arguments: zip(AssetPrefix.allCases, [String].paths))
|
||||||
|
func path(
|
||||||
|
for prefix: AssetPrefix,
|
||||||
|
expects pathExpected: String
|
||||||
|
) async throws {
|
||||||
|
// GIVEN
|
||||||
|
// WHEN
|
||||||
|
let path = prefix.path
|
||||||
|
|
||||||
|
// THEN
|
||||||
|
#expect(path == pathExpected)
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
// MARK: - Collection+Strings
|
||||||
|
|
||||||
|
private extension Collection where Element == String {
|
||||||
|
|
||||||
|
// MARK: Properties
|
||||||
|
|
||||||
|
static var paths: [Element] {[
|
||||||
|
"/css",
|
||||||
|
"/data",
|
||||||
|
"/downloads",
|
||||||
|
"/images",
|
||||||
|
"/img",
|
||||||
|
"/index",
|
||||||
|
"/js",
|
||||||
|
"/videos"
|
||||||
|
]}
|
||||||
|
|
||||||
|
}
|
Loading…
x
Reference in New Issue
Block a user