Skip to content

Commit

Permalink
Don't use block comment syntax in generated config
Browse files Browse the repository at this point in the history 
This gets flaged as an issue with swift-format.
  • Loading branch information
@drhaynes @dhardiman
drhaynes authored and dhardiman committed Jan 19, 2024
1 parent 702b671 commit d0a1dfe
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 23 deletions.
2 changes: 1 addition & 1 deletion Sources/Config/ConfigurationFile.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
import Foundation

private let outputTemplate = """
/* {filename} auto-generated from {scheme} */
// {filename} auto-generated from {scheme}
{imports}
Expand Down
2 changes: 1 addition & 1 deletion Sources/Config/EnumConfiguration.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
import Foundation

private let template = """
/* {filename} auto-generated from {scheme} */
// {filename} auto-generated from {scheme}
import Foundation
public enum {filename}: {type} {
Expand Down
6 changes: 3 additions & 3 deletions Tests/ConfigTests/ConfigGeneratorTests.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ private let filenames = [

private let expectedStrings = [
"enumconfig": """
/* enumconfig auto-generated from any */
// enumconfig auto-generated from any
import Foundation
public enum enumconfig: String {
Expand All @@ -166,7 +166,7 @@ private let expectedStrings = [
""",
"standard": """
/* standard.swift auto-generated from any */
// standard.swift auto-generated from any
import Foundation
Expand All @@ -181,7 +181,7 @@ private let expectedStrings = [
""",
"extension": """
/* UIColor+test.swift auto-generated from any */
// UIColor+test.swift auto-generated from any
import Foundation
Expand Down
4 changes: 2 additions & 2 deletions Tests/ConfigTests/ConfigurationFileReferenceSourceTests.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ class ConfigurationFileReferenceSourceTests: XCTestCase {
func testItOutputsAConfigurationWithAReferenceSource() throws {
let config = try ConfigurationFile(config: configurationWithReferenceInSource, name: "Test", scheme: "any", source: tempURL)
let expectedOutput = """
/* Test+ReferenceTest.swift auto-generated from any */
// Test+ReferenceTest.swift auto-generated from any
import Foundation
Expand All @@ -50,7 +50,7 @@ class ConfigurationFileReferenceSourceTests: XCTestCase {
func testItOutputsAConfigurationWithAReferenceSourceUsingOverrides() throws {
let config = try ConfigurationFile(config: configurationWithReferenceInSource, name: "Test", scheme: "override", source: tempURL)
let expectedOutput = """
/* Test+ReferenceTest.swift auto-generated from override */
// Test+ReferenceTest.swift auto-generated from override
import Foundation
Expand Down
30 changes: 15 additions & 15 deletions Tests/ConfigTests/ConfigurationFileTests.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ class ConfigurationFileTests: XCTestCase {
expect(config.iv.hash).to(equal(testIV.hash))
expect(config.filename).to(beNil())
let expectedOutput = """
/* Test.swift auto-generated from any */
// Test.swift auto-generated from any
import Foundation
Expand All @@ -45,7 +45,7 @@ class ConfigurationFileTests: XCTestCase {
expect(config.iv.hash).to(equal(testIV.hash))
expect(config.filename).to(equal("UIColor+Test"))
let expectedOutput = """
/* UIColor+Test.swift auto-generated from any */
// UIColor+Test.swift auto-generated from any
import Foundation
Expand All @@ -64,7 +64,7 @@ class ConfigurationFileTests: XCTestCase {
let dict = givenAConfigDictionary(withTemplate: importsTemplate)
let config = try ConfigurationFile(config: dict, name: "Test", scheme: "any", source: URL(fileURLWithPath: "/"))
let expectedOutput = """
/* Test.swift auto-generated from any */
// Test.swift auto-generated from any
import AnotherFramework
import Foundation
Expand All @@ -84,7 +84,7 @@ class ConfigurationFileTests: XCTestCase {
func testItCanOutputEncryptedValues() throws {
let config = try ConfigurationFile(config: configWithEncryption, name: "Test", scheme: "any", source: URL(fileURLWithPath: "/"))
let expectedOutput = """
/* Test.swift auto-generated from any */
// Test.swift auto-generated from any
import Foundation
Expand All @@ -108,7 +108,7 @@ class ConfigurationFileTests: XCTestCase {
func testItUsesOverridesAndOrdersProperties() throws {
let config = try ConfigurationFile(config: configWithOverride, name: "Test", scheme: "scheme", source: URL(fileURLWithPath: "/"))
let expectedOutput = """
/* Test.swift auto-generated from scheme */
// Test.swift auto-generated from scheme
import Foundation
Expand All @@ -130,7 +130,7 @@ class ConfigurationFileTests: XCTestCase {
func testItItCanWriteReferenceProperties() throws {
let config = try ConfigurationFile(config: configWithReferenceProperty, name: "Test", scheme: "scheme", source: URL(fileURLWithPath: "/"))
let expectedOutput = """
/* Test.swift auto-generated from scheme */
// Test.swift auto-generated from scheme
import Foundation
Expand All @@ -152,7 +152,7 @@ class ConfigurationFileTests: XCTestCase {
func testItCanWriteNonObjcProperties() throws {
let config = try ConfigurationFile(config: givenAConfigDictionary(withTemplate: nonObjCTemplate), name: "Test", scheme: "any", source: URL(fileURLWithPath: "/"))
let expectedOutput = """
/* Test.swift auto-generated from any */
// Test.swift auto-generated from any
import Foundation
Expand All @@ -172,7 +172,7 @@ class ConfigurationFileTests: XCTestCase {
func testItOutputsGroups() throws {
let config = try ConfigurationFile(config: groupedConfig, name: "Test", scheme: "scheme", source: URL(fileURLWithPath: "/"))
let expectedOutput = """
/* Test.swift auto-generated from scheme */
// Test.swift auto-generated from scheme
import Foundation
Expand All @@ -198,7 +198,7 @@ class ConfigurationFileTests: XCTestCase {
func testAssociatedPropertiesAreOutputForDefaults() throws {
let config = try ConfigurationFile(config: configWithAssociatedProperties, name: "Test", scheme: "scheme", source: URL(fileURLWithPath: "/"))
let expectedOutput = """
/* Test.swift auto-generated from scheme */
// Test.swift auto-generated from scheme
import Foundation
Expand All @@ -221,7 +221,7 @@ class ConfigurationFileTests: XCTestCase {
func testAssociatedPropertiesAreOutputForScheme() throws {
let config = try ConfigurationFile(config: configWithAssociatedProperties, name: "Test", scheme: "prod", source: URL(fileURLWithPath: "/"))
let expectedOutput = """
/* Test.swift auto-generated from prod */
// Test.swift auto-generated from prod
import Foundation
Expand All @@ -244,7 +244,7 @@ class ConfigurationFileTests: XCTestCase {
func testPropertiesAreOutputForVariousTypes() throws {
let config = try ConfigurationFile(config: configurationWithDifferentTypes, name: "Test", scheme: "any", source: URL(fileURLWithPath: "/"))
let expectedOutput = """
/* Test.swift auto-generated from any */
// Test.swift auto-generated from any
import Foundation
Expand Down Expand Up @@ -274,7 +274,7 @@ class ConfigurationFileTests: XCTestCase {
func testPropertiesAreOutputForCustomTypes() throws {
let config = try ConfigurationFile(config: configurationWithCustomType, name: "Test", scheme: "any", source: URL(fileURLWithPath: "/"))
let expectedOutput = """
/* Test.swift auto-generated from any */
// Test.swift auto-generated from any
import Foundation
Expand All @@ -296,7 +296,7 @@ class ConfigurationFileTests: XCTestCase {
func testItUsesADefaultTypeIfOneIsNotSpecified() throws {
let config = try ConfigurationFile(config: configurationWithDefaultType, name: "Test", scheme: "any", source: URL(fileURLWithPath: "/"))
let expectedOutput = """
/* Test.swift auto-generated from any */
// Test.swift auto-generated from any
import Foundation
Expand All @@ -316,7 +316,7 @@ class ConfigurationFileTests: XCTestCase {
func testItCanUsePatternsForMatchingOverrides() throws {
let config = try ConfigurationFile(config: configurationWithCommonPatterns, name: "Test", scheme: "PROD", source: URL(fileURLWithPath: "/"))
let expectedOutput = """
/* Test.swift auto-generated from PROD */
// Test.swift auto-generated from PROD
import Foundation
Expand All @@ -340,7 +340,7 @@ class ConfigurationFileTests: XCTestCase {
func testItCanOutputValuesAsInstanceVariables() throws {
let config = try ConfigurationFile(config: configurationForInstanceVariables, name: "Test", scheme: "any", source: URL(fileURLWithPath: "/"))
let expectedOutput = """
/* Test.swift auto-generated from any */
// Test.swift auto-generated from any
import Foundation
Expand Down
2 changes: 1 addition & 1 deletion Tests/ConfigTests/EnumConfigurationTests.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ class EnumConfigurationTests: XCTestCase {
func testItCanOutputAConfigFile() throws {
let config = try EnumConfiguration(config: enumConfiguration, name: "Test", scheme: "scheme", source: URL(fileURLWithPath: "/"))
let expectedOutput = """
/* Test auto-generated from scheme */
// Test auto-generated from scheme
import Foundation
public enum Test: String {
Expand Down

0 comments on commit d0a1dfe

Please sign in to comment.