Swiftpack.co - Package - SDGGiesbrecht/Workspace

🇨🇦EN

macOS • Linux

Documentation

Workspace

Workspace automates management of Swift projects.

Πᾶν ὅ τι ἐὰν ποιῆτε, ἐκ ψυχῆς ἐργάζεσθε, ὡς τῷ Κυρίῳ καὶ οὐκ ἀνθρώποις.
Whatever you do, work from the heart, as working for the Lord and not for men.

                                                                                                    ―‎שאול/Shaʼul

Features

(For a list of related projects, see here.)

Installation

Workspace provides command line tools.

Paste the following into a terminal to install or update them:

curl -sL https://gist.github.com/SDGGiesbrecht/4d76ad2f2b9c7bf9072ca1da9815d7e2/raw/update.sh | bash -s Workspace "https://github.com/SDGGiesbrecht/Workspace" 0.12.0 "workspace help" workspace arbeitsbereich

Importing

Workspace provides a library for use with the Swift Package Manager.

Simply add Workspace as a dependency in Package.swift:

let package = Package(
    name: "MyPackage",
    dependencies: [
        .package(url: "https://github.com/SDGGiesbrecht/Workspace", .upToNextMinor(from: Version(0, 12, 0))),
    ],
    targets: [
        .target(name: "MyTarget", dependencies: [
            .productItem(name: "WorkspaceConfiguration", package: "Workspace"),
        ])
    ]
)

The library’s module can then be imported in source files:

import WorkspaceConfiguration

The Workspace Workflow

(The following sample package is a real repository. You can use it to follow along.)

When the Repository Is Cloned

The need to hunt down workflow tools can deter contributors. On the other hand, including them in the repository causes a lot of clutter. To reduce both, when a project using Workspace is pulled, pushed, or cloned...

git clone https://github.com/SDGGiesbrecht/SamplePackage

...only one small piece of Workspace comes with it: A short script called “Refresh” that comes in two variants, one for each operating system.

Hmm... I wish I had more tools at my disposal... Hey! What if I...

Refresh the Project

To refresh the project, double‐click the Refresh script for the corresponding operating system. (If you are on Linux and double‐clicking fails or opens a text file, see here.)

Refresh opens a terminal window, and in it Workspace reports its actions while it sets the project folder up for development. (This may take a while the first time, but subsequent runs are faster.)

This looks better. Let’s get coding!

[Add this... Remove that... Change something over here...]

...All done. I wonder if I broke anything while I was working? Hey! It looks like I can...

Validate Changes

When the project seems ready for a push, merge, or pull request, validate the current state of the project by double‐clicking the Validate script.

Validate opens a terminal window and in it Workspace runs the project through a series of checks.

When it finishes, it prints a summary of which tests passed and which tests failed.

Oops! I never realized that would happen...

Summary

  1. Refresh before working.
  2. Validate when it looks complete.

Wow! That was so much easier than doing it all manually!

Applying Workspace to a Project

To apply Workspace to a project, run the following command in the root of the project’s repository. (This requires a full install.)

$ workspace refresh

By default, Workspace refrains from tasks which would involve modifying project files. Such tasks must be activated with a configuration file.

About

The Workspace project is maintained by Jeremy David Giesbrecht.

If Workspace saves you money, consider giving some of it as a donation.

If Workspace saves you time, consider devoting some of it to contributing back to the project.

Ἄξιος γὰρ ὁ ἐργάτης τοῦ μισθοῦ αὐτοῦ ἐστι.
For the worker is worthy of his wages.

                                                                                                    ―‎ישוע/Yeshuʼa

Github

link
Stars: 25
Help us keep the lights on

Dependencies

Releases

0.12.0 - Sep 6, 2018

Breaking Changes

  • Workspace no longer uses Jazzy. Workspace now generates documentation itself. This enabled many improvements:
    • Documentation can now be generated from Linux!
      • Continuous integration set‐up has moved coverage validation into the “Miscellaneous” job on Linux. The separate “Documentation” job on macOS no longer exists.
        • The “Deployment” job has been switched to Linux.
    • The generator natively understands packages. There is no longer any need for a separate site for each module.
      • Point links straight to the documentation root, instead of the old subdirectory scheme.
  • Resources with html, css and js extensions are now embedded as String instances.

New Features

  • Many commands now have a •project option to specify a path to the target project, so Workspace no longer needs to be run from the project directory.

0.11.1 - Aug 17, 2018

New Features

  • Products can be hidden from documentation by prefixing their names with an underscore (_).

Bug Fixes

  • Fixed an issue which could cause the cache to grow unnecessarily over time when using the related projects feature.

0.11.0 - Jul 25, 2018

Breaking Changes

  • testCoverageExemptions has been renamed to exemptionTokens.

New Features

  • Entire files and directories can be exempted from testing and source operations:
    • testing.exemptPaths
    • repository.ignoredPaths

Bug Fixes

  • Fixed an issue where examples would be misidentified, sometimes leading to crashes.

0.10.2 - Jul 11, 2018

Bug Fixes

  • Fixed an issue which could cause documentation inheritance to become extremely slow.

0.10.1 - Jul 11, 2018

Bug Fixes

  • Fixed an issue that prevented some configuration files from loading.