Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apple/swift-aoc-starter-example
Swift starter project for solving Advent of Code challenges.
https://github.com/apple/swift-aoc-starter-example
advent-of-code advent-of-code-2023 advent-of-code-2023-swift swift
Last synced: 2 days ago
JSON representation
Swift starter project for solving Advent of Code challenges.
- Host: GitHub
- URL: https://github.com/apple/swift-aoc-starter-example
- Owner: apple
- License: apache-2.0
- Created: 2023-12-01T00:42:09.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2023-12-07T03:44:09.000Z (10 months ago)
- Last Synced: 2024-09-24T20:32:51.813Z (2 days ago)
- Topics: advent-of-code, advent-of-code-2023, advent-of-code-2023-swift, swift
- Language: Swift
- Homepage: https://adventofcode.com
- Size: 18.6 KB
- Stars: 194
- Watchers: 108
- Forks: 22
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Advent of Code Swift Starter Project
[](https://swift.org)
Daily programming puzzles at [Advent of Code](), by
[Eric Wastl](). This is a small example starter project for
building Advent of Code solutions.
## Usage
Swift comes with Xcode, or you can [install it](https://www.swift.org/install/)
on a supported macOS, Linux, or Windows platform.
If you're using Xcode, you can open this project by choosing File / Open and
select the parent directory.
If you prefer the command line, you can run the test suite with `swift test`,
and run the output with `swift run`.
If you're using Visual Studio Code to edit, you might find these Swift
extensions useful:
- [Swift](https://marketplace.visualstudio.com/items?itemName=sswg.swift-lang)
(provides core language edit / debug / test features)
- [apple-swift-format](https://marketplace.visualstudio.com/items?itemName=vknabel.vscode-apple-swift-format)
(supports the [swift-format](https://github.com/apple/swift-format) package)
## Challenges
The challenges assume three files (replace 00 with the day of the challenge).
- `Sources/Data/Day00.txt`: the input data provided for the challenge
- `Sources/Day00.swift`: the code to solve the challenge
- `Tests/Day00.swift`: any unit tests that you want to include
To start a new day's challenge, make a copy of these files, updating 00 to the
day number.
```diff
// Add each new day implementation to this array:
let allChallenges: [any AdventDay] = [
- Day00()
+ Day00(),
+ Day01(),
]
```
Then implement part 1 and 2. The `AdventOfCode.swift` file controls which challenge
is run with `swift run`. Add your new type to its `allChallenges` array. By default
it runs the most recent challenge.
The `AdventOfCode.swift` file controls which day's challenge is run
with `swift run`. By default that runs the most recent challenge in the package.
To supply command line arguments use `swift run AdventOfCode`. For example,
`swift run -c release AdventOfCode --benchmark 3` builds the binary with full
optimizations, and benchmarks the challenge for day 3.
## Linting and Formatting
Challenge source code can be linted and formatted automatically using the
included dependency on `swift-format`.
Lint source code with the following command:
```shell
$ swift package lint-source-code
```
Format source code with the following command:
```shell
$ swift package format-source-code
Plugin ‘Format Source Code’ wants permission to write to the package directory.
Stated reason: “This command formats the Swift source files”.
Allow this plugin to write to the package directory? (yes/no)
```
To avoid the interactive prompt when formatting source code, use the
`--allow-writing-to-package-directory` flag.
```shell
$ swift package format-source-code --allow-writing-to-package-directory
```
swift-format will use the built-in default style to lint and format code. A
`.swift-format` configuration file can be used to customize the style used, see
[Configuration](https://github.com/apple/swift-format/blob/main/Documentation/Configuration.md)
for more details.