Swiftpack.co - Package - SDGGiesbrecht/Workspace

🇨🇦EN

macOS • Linux

APIs: WorkspaceConfiguration

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.11.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, 11, 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. See Installation.)

$ 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: 16
Help us keep the lights on

Dependencies

Releases

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.

0.9.0 - Jul 2, 2018

Breaking Changes

  • Proofreading in Xcode is now a separate scheme. Projects can now be built without proofreading and proofread without building.

New Features

  • More tasks are available in isolation as individual subcommands:
    • $ workspace refresh xcode

Bug Fixes

  • Various bugs triggered by the absence of an Xcode project have been fixed. Where tasks are impossible without an Xcode project, the failure message now describes the reason.

0.10.0 - Jul 10, 2018

Breaking Changes

  • Git configuration management is now optional, and off by default.
    • Workspace now manages the entire file, not just the top section. Customization is available in Workspace’s configuration under git.
  • Several more syntax elements have changed to be more like Swift:
    • Examples:
      • Define: @example(identifier)...@endExample
      • Insert: #example(0, identifier).
    • Documentation Inheritance:
      • Define: @documentation(identifier)
      • Inherit: #documentation(identifier).
    • Test Exemptions: @exempt(from: tests)
    • Warnings:
      • #warning(Some description.)
      • #workaround(Dependency 0.0.0, Some description.)

New Features

  • More tasks are available in isolation as individual subcommands:
    • $ workspace refresh git
    • $ workspace refresh licence
    • $ workspace refresh file‐headers
    • $ workspace refresh examples
    • $ workspace refresh inherited‐documentation