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

Dependencies

Releases

0.16.0 - Jan 7, 2019

Breaking Changes

  • Old proofreading rules in the deprecation category have been removed.

New Features

  • Generated documentation includes operators and precedence groups.
  • Documentation generation warns when no publishing date is specified for copyright.
  • Constraints are displayed near symbol names in titles and lists in documentation.
  • File headers support several new file types, including .py and .inc.

Bug Fixes

  • The documentation scroll bar is properly displayed at the extreme right of the page.
  • Callouts are handled by documentation generation.
  • Documentation content is properly escaped for HTML.

0.14.2 - Nov 5, 2018

Bug Fixes

  • Dependency updates.

0.15.0 - Dec 20, 2018

Breaking Changes

  • Swift 4.2.1
  • Xcode 10.1

Bug Fixes

  • Documentation:
    • Redirects no longer fail in browsers where UTF‐8 is not the default.
    • Block‐style documentation comments are parsed correctly.
    • Array, dictionary, tuple and closure types display correctly in declarations.
    • The generic parameters of functions display correctly in declarations.
    • Enumeration cases and variables which share a single declaration with other cases or variables are now properly detected.
    • Attributes no longer cause symbols to be dropped.
  • Proofreading:
    • Many false positives of colonSpacing have been eliminated.
    • The Linux cache is now more resistant against unexpected permissions restrictions.
  • Linux continuous integration jobs now run on Xenial.

0.14.1 - Nov 4, 2018

Bug Fixes

  • Continuous integration now uses Swift 4.2.1 and Xcode 10.1.

0.14.0 - Nov 2, 2018

Breaking Changes

  • Proofreading rules which aided in providing MARKs necessary for Jazzy have now been removed and replaced with rules which catch continued use of said MARKs.
  • Xcode scheme (.xcscheme) resources are now embedded as String instances.

Bug Fixes

  • Compatible with Swift 4.2.1 and Xcode 10.1. (Swift 4.2.0 and Xcode 10.0 are still supported and are used in continuous integration.)
  • The proofreading scheme has been restored.