tuist / swiftytailwind Goto Github PK

View Code? Open in Web Editor NEW

44.0 44.0 5.0 64 KB

💇 A Swift Package to pull and run Tailwind from a Swift process

Home Page: https://swiftytailwind.tuist.io

License: MIT License

Swift 100.00%

swiftytailwind's Introduction

🕺 What's Tuist

Tuist is a command line tool that leverages project generation to abstract intricacies of Xcode projects, and uses it as a foundation to help teams maintain and optimize their large modular projects.

It's open source and written in Swift.

⬇️ Install

The recommended installation method is to install mise and then run mise install tuist to install Tuist.

You can check out the documentation to learn more about the rationale behind our installation approach and alternative approaches.

🌀 Bootstrap your first project

tuist init --platform ios
tuist edit # Customize your project manifest
tuist generate # Generates Xcode project & workspace
tuist build # Builds your project

Check out the project "Adopting Tuist" guide to learn more about Tuist and all its features.

📝 Documentation

Do you want to know more about what Tuist can offer you? Or perhaps want to contribute to the project and you need a starting point?

You can check out the project documentation.

🔬 Sample projects

You can find some sample projects in the fixtures folder or the awesome Tuist repo! 🎉

💰 Sponsors

The financial sustainability of the project is possible thanks to the ongoing contributions from our GitHub Sponsors and Open Collective Backers. From them, we'd like to give a special mention to the following sponsors:

🥇 Gold Sponsors

	Monday.com is a cloud-based work operating system (Work OS) that empowers teams to run projects and workflows with confidence. It's a versatile platform that combines features of project management, workflow automation, and team collaboration to streamline the way teams work together.
	Lapse is an app designed to reclaim how we take and share memories. A camera for living in the moment and a private photo journal for friends, not followers.

🥈 Silver sponsors

	Stream helps build scalable in-app chat or activity feeds in days. Product teams trust Stream to launch faster, iterate more often, and ship a better user experience.
	Runway streamlines collaboration and automation for mobile app releases, from kickoff to rollout.
	Emerge Tools is a suite of revolutionary products designed to supercharge mobile apps and the teams that build them.
	Codemagic is a CI/CD tool for building world-class mobile apps.

🥉 Bronze sponsors

💪 Companies using Tuist

🙇‍ ️Supported by great companies

Great companies support the project by giving us access to their service through an open-source program.

🧑‍💻 Want to contribute?

You can use our contribution docs to get started. If you don't have a specific issue in mind, we are more than happy to help you, just ask for help in a given issue or on our Slack. You can find good issues for first-time contributors here. We also offer issue bounties for some highly-valued issues.

✨ Core Team

_{Pedro Piñera}

_{Marek Fořt}

_Kas

_{Daniele Formichelli}

_{Mike Simons}

🚀 Core Alumni

The following people were once core contributors helping steer the project in the right direction and ensuring we have a reliable foundation we can build new features upon:

_{Natan Rolnik}

_{Andrea Cipriani}

_{Oliver Atkinson}

_{Romain Boulay}

_{Kamil Harasimowicz}

_{Luis Padron}

_{Alfredo Delli Bovi}

✨ Contributors

Thanks goes to these wonderful people:

_kalkwarf	_{Marek Fořt}	_Kas	_{Natan Rolnik}	_svastven	_{Bernhard Huemer}	_{Daniel Jankowski}
_{Facundo Menzella}	_{Eric Ito}	_{Kamil Harasimowicz}	_{Jakub Olejník}	_ldindu	_{George Tsifrikas}	_{Privezentsev Yura}
_Fero	_{Heberti Almeida}	_{Ben Scheirman}	_{Jared Sorge}	_{Joe Blau}	_{David Chavez}	_{Roman Podymov}
_{Marcin Religa}	_{Alfredo Delli Bovi}	_{Jake Prickett}	_{Daniele Formichelli}	_{Sergey Petrachkov}	_{Jinwoo, Kim}	_{David Harris}
_{Dmytro Mishchenko}	_{Sam Pettersson}	_{Josh Holtz}	_{Jierong Li}	_{Shai Mishali}	_{Franz Busch}	_{Tíarnán McGrath}
_{Vitaly Chupryk}	_{Roman Blum}	_{Giovanni Filaferro}	_{Andrés Pizá Bückmann}	_{Gabriel Coutinho}	_Riccardo	_{Mauro Bolis}
_{Peter Weishapl}	_Cruz	_{Sven Münnich}	_{Santiago A. Delgado}	_{Wojciech Kulik}	_{Iain Smith}	_{Max Kraev}
_{Mustafa Yusuf}	_{Daniel Barden}	_{Zofia Kulus}	_{David Peterson}	_{Ikko Ashimine}	_{Seto Elkahfi / 塞托·埃尔卡菲}	_{apps4everyone}
_Lorenzo	_{Darko Damjanovic}	_{Marvin Nazari}	_{Robin Malhotra}	_Astromonkee	_ezraberch	_{Christopher Constable}
_{Yi Wang}	_{Mustafa Dur}	_{Luca Bartoletti}	_{Sujata Chakraborty}	_{Pavel Trafimuk}	_{Alejandro Silva Fernández}	_{Jake Adams}
_{Sam Watts}	_{Erk Ekin}	_{Denis Morozov}	_orbitekk	_{Park Jae Hyun}	_{Sean Berry}	_{Isaac Halvorson}
_{Mohit Saxena}	_{Mikołaj Chmielewski}	_{Tope Akinwande}	_{TheInkedEngineer}	_{Alexander Weiß}	_kyungpyoda	_{Ville Witt}
_paul.s	_aniltaskiran	_{Javier Vieira}	_{Aris Sarris}	_kimxwan0319	_{Florian Fittschen}	_{Jesus (iOS)}
_{Nicholas Kim}	_{Alexandros Smponias}	_Go	_{Alberto Garcia}	_{Andrea Scuderi}	_{Diogo Autilio}	_{Shahzad Majeed}
_Dan	_{Nikita Ivanchikov}	_{Anastasia Kazantseva}	_{Michael McGuire}	_{Michael Collins}	_{YoHan Cho}	_euriasb
_MontakOleg	_oozoofrog	_{Martin Strambach}	_sh-a-n	_{Batuhan Saka}	_SooHwanCho	_{Gary Riches}
_mustiikhalil	_{Serhii Butenko}	_{Petrukha Ivan}	_{Mathias Schreck}	_{Yen-Chia Lin}	_Mary	_Hyunjin
_{Kevin Aguilar}	_{Andrew Roan}	_{ibrahim oktay}	_{Dmitriy Kulakov}	_Jaewon-Yun	_tatagrigory	_{Denil Chungath}
_{Victor Sarda}	_tzxdtc10	_Thieme	_{Clemens Beck}	_{Paul Taykalo}	_{Vitaly Kravtsov}	_dc
_baegteun	_{Vinícius Couto Tasso}	_안지훈	_Dimash	_danibachar	_{한석호(MilKyo)}	_{Hai Feng Kao}
_{Antti Laitala}	_PushedCrayon	_{Stefano Mondino}	_{Łukasz Lech}	_costapombo	_{Ihor Savynskyi}	_{Eduard Miniakhmetov}
_{Alexander Filimonov}	_{Gorbenko Roman}

swiftytailwind's People

Contributors

Stargazers

Watchers

Forkers

csjones jagreenwood wsedlacek antingle

swiftytailwind's Issues

Add a README to the project

How to define TailwindCSS plugins?

In my current TailwindCSS project using JS I define plugins in a tailwind.config.js file such as:

plugins: [
    require("@tailwindcss/aspect-ratio"),
    require("@tailwindcss/typography")
]

This file is also where I extended the theme.

With Vapor and SwiftyTailwind, how can I achieve the same thing?

Generate documentation using Swift DocC and publish it using GitHub pages

Following default setup instructions leads to error starting process

Hello, apologies if this has been asked before. I tried integrating SwiftyTailwind with an existing Vapor project, and despite SwiftyTailwind correctly finding the binary, I'm getting the following error when I try to actually run the Vapor project.

[ INFO ] Tailwind: /var/folders/cl/pm3kms754_zg_17w7d8_9d_r0000gq/T/SwiftyTailwind/v3.4.3/tailwindcss-macos-arm64 init
[ WARNING ] posix_spawn error: Permission denied (13), `["/var/folders/cl/pm3kms754_zg_17w7d8_9d_r0000gq/T/SwiftyTailwind/v3.4.3/tailwindcss-macos-arm64", "init"]`
Swift/ErrorType.swift:200: Fatal error: Error raised at top level: posix_spawn error: Permission denied (13), `["/var/folders/cl/pm3kms754_zg_17w7d8_9d_r0000gq/T/SwiftyTailwind/v3.4.3/tailwindcss-macos-arm64", "init"]`

I then attempted running chmod +x tailwindcss-macos-arm64 in the Package directory (even though this seemed like it should be handled by the package code) and got the following, slightly different error.

[ INFO ] Tailwind: /var/folders/cl/pm3kms754_zg_17w7d8_9d_r0000gq/T/SwiftyTailwind/v3.4.3/tailwindcss-macos-arm64 init
[ WARNING ] posix_spawn error: Malformed Mach-o file (88), `["/var/folders/cl/pm3kms754_zg_17w7d8_9d_r0000gq/T/SwiftyTailwind/v3.4.3/tailwindcss-macos-arm64", "init"]`
Swift/ErrorType.swift:200: Fatal error: Error raised at top level: posix_spawn error: Malformed Mach-o file (88), `["/var/folders/cl/pm3kms754_zg_17w7d8_9d_r0000gq/T/SwiftyTailwind/v3.4.3/tailwindcss-macos-arm64", "init"]`

Potentially relevant info below:

My file structure

Tailwind configuration:

import Leaf
import SwiftyTailwind
import TSCBasic
import Vapor

func tailwind(_ app: Application) async throws {
    let resourecesDirectory = try AbsolutePath(validating: app.directory.resourcesDirectory)
    let publicDirectory = try AbsolutePath(validating: app.directory.publicDirectory)

    let tailwind = SwiftyTailwind()
    try await tailwind.initialize()
    try await tailwind.run(
        input: .init(validating: "Styles/app.css", relativeTo: resourecesDirectory),
        output: .init(validating: "styles/app.generated.css", relativeTo: publicDirectory),
        options: .content("\(app.directory.viewsDirectory)**/*.leaf")
    )
}

// configures your application
public func configure(_ app: Application) async throws {
    app.views.use(.leaf)
    
    try await tailwind(app)
    app.middleware.use(FileMiddleware(publicDirectory: app.directory.publicDirectory))
    
    try routes(app)
}

This seems like there is something potentially wrong with the library code, but it's hard for me to tell for sure as I'm not only new to Tailwind, but also to Vapor. Please let me know if any more information is necessary or if there is a step I missed. Thank you!

Add example code to run Vapor and Tailwind watch in parallel

Because I am frequently testing different class values while using Tailwind, it is important to me that Tailwind is watching for changes and constantly regenerating the css. The .watch option is easy to pass and exactly what I need for this.

However, because I am running the Vapor server in parallel with the Tailwind watch process, it was not clear to me how to get them to run alongside each other. I spent a lot of time trying to figure out how to do this. Luckily I came across this syntax which finally helped me set it up:

let resourcesDirectory = try AbsolutePath(validating: app.directory.resourcesDirectory)
let publicDirectory = try AbsolutePath(validating: app.directory.publicDirectory)
let tailwind = SwiftyTailwind()

async let tailwindRun: () = tailwind.run(
    input: .init(validating: "Styles/app.css", relativeTo: resourecesDirectory),
    output: .init(validating: "styles/app.generated.css", relativeTo: publicDirectory),
    options: .watch, .content("\(app.directory.viewsDirectory)/**/*.leaf"))

async let runApp: () = try await app.execute()

_ = await [try tailwindRun, try await runApp]

I feel like this should be added to the README to help others save time and also set up the .watch function alongside Vapor. (Also I don't really understand why this works, so if someone could provide an explanation too that would be fantastic)

Add package to SwiftPackageIndex

Set up CI/CD

Download extra dependencies

I am looking at using this project however I am considering using Liquid Web Components which have their own tailwind preset.

https://liquid.emd.design/liquid/guides/tailwindcss-integration/

Ideally I wouldn't need to use npm to download their package. Although it wouldn't be as simple as just using unpkg since their preset has a few dependencies itself.

Maybe SwiftyTailwind could just invoke npm for me instead of downloading the bin from the GitHub releases? I'm down for any other ideas to make this ergonomic.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

chore(deps): update dependency swift-server/async-http-client to from: "1.21.1"

Detected dependencies

github-actions

.github/workflows/SwiftyTailwind.yml

actions/checkout v4

actions/cache v4

.github/workflows/deploy-docs.yml

actions/checkout v4

cloudflare/pages-action v1

macos 14

swift

Examples/PublishExample/Package.swift

johnsundell/publish from: "0.9.0"

Package.swift

apple/swift-tools-support-core from: "0.6.1"

apple/swift-docc-plugin from: "1.3.0"

apple/swift-log from: "1.5.4"

swift-server/async-http-client from: "1.21.0"

Check this box to trigger a request for Renovate to run again on this repository

AArch64 Support

Hi there!
I'm running a Vapor app in a VSCode dev container on macOS Sonoma.

When integrating this project, I get the error unableToDetermineBinaryName. After some debugging I determined the system is identifying the CPU arch as aarch64, which is not a defined CpuArchitecture.

I believe we should be able to use the arm64 tailwind binary?

Below is some po'd info:

po result

▿ Optional<ProcessResult>
  ▿ some : <ProcessResult: exit: terminated(code: 0), output:
 aarch64

>
    ▿ arguments : 2 elements
      - 0 : "uname"
      - 1 : "-m"
    ▿ environment : 37 elements
      ▿ 0 : 2 elements
        - key : "VSCODE_NLS_CONFIG"
        - value : "{\"locale\":\"en\",\"osLocale\":\"en\",\"availableLanguages\":{}}"
      ▿ 1 : 2 elements
        - key : "PROMPT_DIRTRIM"
        - value : "4"
      ▿ 2 : 2 elements
        - key : "_"
        - value : "/usr/bin/cat"
      ▿ 3 : 2 elements
        - key : "SWIFT_BRANCH"
        - value : "swift-5.9-release"
      ▿ 4 : 2 elements
        - key : "ELECTRON_RUN_AS_NODE"
        - value : "1"
      ▿ 5 : 2 elements
        - key : "POSTGRES_PORT"
        - value : "5432"
      ▿ 6 : 2 elements
        - key : "SWIFT_PLATFORM"
        - value : "ubuntu22.04"
      ▿ 7 : 2 elements
        - key : "SWIFT_SIGNING_KEY"
        - value : "A62AE125BBBFBB96A6E042EC925CC1CCED3D1561"
      ▿ 8 : 2 elements
        - key : "LESSCLOSE"
        - value : "/usr/bin/lesspipe %s %s"
      ▿ 9 : 2 elements
        - key : "VSCODE_CWD"
        - value : "/vscode/vscode-server/bin/linux-arm64/f1b07bd25dfad64b0167beb15359ae573aecd2cc"
      ▿ 10 : 2 elements
        - key : "LS_COLORS"
        - value : ""
      ▿ 11 : 2 elements
        - key : "REMOTE_CONTAINERS_SOCKETS"
        - value : "[\"/tmp/vscode-ssh-auth-c0b7d502-aca5-4ca5-868d-71a7e849a3de.sock\",\"/home/vscode/.gnupg/S.gpg-agent\"]"
      ▿ 12 : 2 elements
        - key : "REMOTE_CONTAINERS_IPC"
        - value : "/tmp/vscode-remote-containers-ipc-c0b7d502-aca5-4ca5-868d-71a7e849a3de.sock"
      ▿ 13 : 2 elements
        - key : "SHELL"
        - value : "/bin/bash"
      ▿ 14 : 2 elements
        - key : "POSTGRES_PASSWORD"
        - value : "vapor_password"
      ▿ 15 : 2 elements
        - key : "VSCODE_AGENT_FOLDER"
        - value : "/home/vscode/.vscode-server"
      ▿ 16 : 2 elements
        - key : "PWD"
        - value : "/vscode/vscode-server/bin/linux-arm64/f1b07bd25dfad64b0167beb15359ae573aecd2cc"
      ▿ 17 : 2 elements
        - key : "BROWSER"
        - value : "/vscode/vscode-server/bin/linux-arm64/f1b07bd25dfad64b0167beb15359ae573aecd2cc/bin/helpers/browser.sh"
      ▿ 18 : 2 elements
        - key : "VSCODE_IPC_HOOK_CLI"
        - value : "/tmp/vscode-ipc-d2387ea3-41ca-46ca-843a-6e9bf7c2ea41.sock"
      ▿ 19 : 2 elements
        - key : "POSTGRES_HOST"
        - value : "postgres"
      ▿ 20 : 2 elements
        - key : "USER"
        - value : "vscode"
      ▿ 21 : 2 elements
        - key : "REMOTE_CONTAINERS"
        - value : "true"
      ▿ 22 : 2 elements
        - key : "POSTGRES_DB"
        - value : "vapor_database"
      ▿ 23 : 2 elements
        - key : "HOSTNAME"
        - value : "b7927c1f4fa6"
      ▿ 24 : 2 elements
        - key : "SWIFT_WEBROOT"
        - value : "https://download.swift.org"
      ▿ 25 : 2 elements
        - key : "VSCODE_AMD_ENTRYPOINT"
        - value : "vs/workbench/api/node/extensionHostProcess"
      ▿ 26 : 2 elements
        - key : "SHLVL"
        - value : "1"
      ▿ 27 : 2 elements
        - key : "POSTGRES_USER"
        - value : "vapor_username"
      ▿ 28 : 2 elements
        - key : "HOME"
        - value : "/home/vscode"
      ▿ 29 : 2 elements
        - key : "RUST_TRACEBACK"
        - value : "1"
      ▿ 30 : 2 elements
        - key : "VSCODE_HANDLES_SIGPIPE"
        - value : "true"
      ▿ 31 : 2 elements
        - key : "SSH_AUTH_SOCK"
        - value : "/tmp/vscode-ssh-auth-c0b7d502-aca5-4ca5-868d-71a7e849a3de.sock"
      ▿ 32 : 2 elements
        - key : "VSCODE_HANDLES_UNCAUGHT_ERRORS"
        - value : "true"
      ▿ 33 : 2 elements
        - key : "VSCODE_L10N_BUNDLE_LOCATION"
        - value : ""
      ▿ 34 : 2 elements
        - key : "PATH"
        - value : "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/home/vscode/.local/bin"
      ▿ 35 : 2 elements
        - key : "SWIFT_VERSION"
        - value : "swift-5.9-RELEASE"
      ▿ 36 : 2 elements
        - key : "LESSOPEN"
        - value : "| /usr/bin/lesspipe %s"
    ▿ exitStatus : ExitStatus
      ▿ terminated : 1 element
        - code : 0
    ▿ output : Result<Array<UInt8>, Error>
      ▿ success : 8 elements
        - 0 : 97
        - 1 : 97
        - 2 : 114
        - 3 : 99
        - 4 : 104
        - 5 : 54
        - 6 : 52
        - 7 : 10
    ▿ stderrOutput : Result<Array<UInt8>, Error>
      - success : 0 elements
po output

▿ Optional<String>
  - some : "aarch64"

Implement an interface to download and run Tailwind

Unable to initialize

I think the issue is the docs, it has 0.1.0 still.