spm-swift-package 0.12.0

use std::borrow::Cow;

/// Provides template generators for all project files.
pub struct ProjectTemplates;

impl ProjectTemplates {
	const SWIFT_TOOLS_VERSION: &'static str = "6.2";
	const SWIFTLINT_PLUGIN_URL: &'static str = "https://github.com/lukepistrol/SwiftLintPlugin";
	const SWIFTLINT_PLUGIN_VERSION: &'static str = "0.63.1";

	/// Returns the default Swift source file template
	/// Used to generate the main `{name}.swift` file inside Sources
	pub fn project_swift_content() -> Cow<'static, str> {
		Cow::Borrowed(
			r#"// The Swift Programming Language
// https://docs.swift.org/swift-book/
"#,
		)
	}

	/// Returns the default XCTest file template
	/// Includes boilerplate test structure for `{project_name}Tests.swift`
	pub fn test_content(project_name: &str) -> Cow<'static, str> {
		Cow::Owned(format!(
			r#"import XCTest
@testable import {name}

final class {name}Tests: XCTestCase {{
    func testExample() throws {{
        // XCTest Documentation
        // https://developer.apple.com/documentation/xctest

        // Defining Test Cases and Test Methods
        // https://developer.apple.com/documentation/xctest/defining_test_cases_and_test_methods
    }}
}}
"#,
			name = project_name
		))
	}

	/// Returns the Package.swift template
	/// Supports two variants: plugin-enabled or standard package
	///
	/// * `project_name` - name of the Swift package
	/// * `platform` - selected platform such as iOS or macOS
	/// * `version` - minimum deployment version
	/// * `is_plugin` - adds SwiftLint plugin configuration when true
	pub fn package_swift_content(
		project_name: &str,
		platform: &str,
		version: &str,
		is_plugin: bool,
	) -> Cow<'static, str> {
		let deps = if is_plugin {
			// keep indentation exactly as it should appear in Package.swift
			format!(
				r#"    dependencies: [
        .package(url: "{url}", exact: "{ver}")
    ],
"#,
				url = Self::SWIFTLINT_PLUGIN_URL,
				ver = Self::SWIFTLINT_PLUGIN_VERSION
			)
		} else {
			String::new()
		};

		let plugins = if is_plugin {
			r#"            plugins: [
                .plugin(name: "SwiftLint", package: "SwiftLintPlugin")
            ]
"#
			.to_string()
		} else {
			String::new()
		};

		Cow::Owned(format!(
			r#"// swift-tools-version: {tools}
// The swift-tools-version declares the minimum version of Swift required to build this package.

import PackageDescription

let package = Package(
    name: "{name}",
    platforms: [
        .{platform}(.v{version})
    ],
    products: [
        // Products define the executables and libraries a package produces, making them visible to other packages.
        .library(
            name: "{name}",
            targets: ["{name}"]
        ),
    ],
{deps}    targets: [
        // Targets are the basic building blocks of a package, defining a module or a test suite.
        // Targets can depend on other targets in this package and products from dependencies.
        .target(
            name: "{name}",
{plugins}        ),
        .testTarget(
            name: "{name}Tests",
            dependencies: ["{name}"]
        ),
    ]
)
"#,
			tools = Self::SWIFT_TOOLS_VERSION,
			name = project_name,
			platform = platform,
			version = version,
			deps = deps,
			plugins = plugins
		))
	}

	/// Returns the default CHANGELOG.md template
	/// Used when the Changelog option is selected
	pub fn changelog_content() -> Cow<'static, str> {
		Cow::Borrowed(
			r#"# CHANGELOG

## Version 1.0.0
**2024-01-18**

- First release
"#,
		)
	}

	/// Returns the README.md template
	/// Includes only the project title by default
	pub fn readme_content(project_name: &str) -> Cow<'static, str> {
		Cow::Owned(format!("# {name}\n", name = project_name))
	}

	/// Returns the .spi.yml template for Swift Package Index configuration
	/// Defines documentation targets and scheme attributes
	pub fn spi_content(project_name: &str) -> Cow<'static, str> {
		Cow::Owned(format!(
			r#"version: 1
builder:
  configs:
    - documentation_targets: [{name}]
      scheme: {name}
"#,
			name = project_name
		))
	}

	/// Returns a default SwiftLint configuration template
	/// Includes baseline rules, opt-in rules, and excluded directories
	pub fn swiftlint_content() -> Cow<'static, str> {
		Cow::Borrowed(
			r#"disabled_rules:
  - trailing_whitespace

vertical_whitespace:
    severity: error

opt_in_rules:
  - empty_count
  - comma

excluded:
  - Pods
  - Carthage
  - Fastlane
"#,
		)
	}
}