rossmassey / leetcode

Swift Leetcode solutions

Leetcode

Solutions to leetcode problems implemented in Swift

Adding new solution and test case

Run the following interactive script to to generate a blank leetcode solution and test case

swift Scripts/start-new-problem.swift

Documentation

Documentation is generated from the markdown in the solution files, with the DocC documentation compiler

Main Page

Article: Problems organized by Neetcode's Roadmap

Generating

To generate the static documentation in /_site, from the repo folder run:

bash Scripts/generate-docs.sh

To preview the web version, run:

bash Scripts/preview-docs.sh

GitHub Pages is used to host the static content generated by the "Deploy Documentation" workflow

Testing and Linting

Linting can be ran with the SwiftLint tool:

swiftlint

XCTests can be ran through Xcode or VS Code (with Swift extension), or with:

swift test

Note: Current test cases are just the example inputs/outputs provided by Leetcode, and are not comprehensive

Using Docker

The Swift image for docker can be used if Swift is not installed locally

This command ran from the root of the repo will run the tests for instance:

docker run --rm -it -v "$(pwd):/leetcode" -w /leetcode swift swift test

• docker run: run a command within a docker container
• --rm: removes container once it is done
• --it: runs container in interactive mode (to see console output)
• -v "$(pwd):/leetcode: mounts current directory to /leetcode inside container
• -w /leetcode: sets container working directory to /leetcode
• swift swift test: execute swift test using the swift docker image

leetcode's Issues

switch doc comments to `///`

/// looks a little nicer than /** */

add test case parser for class solutions

solutions where a class is implemented, like LRUCache, have the tests manually done:

e.g.: LRUCacheTests

let lru = LRUCache(2)
lru.put(1,1)
lru.put(2,2)
XCTAssertEqual(lru.get(1), 1)
lru.put(3,3)
XCTAssertEqual(lru.get(2), -1)
lru.put(4,4)
XCTAssertEqual(lru.get(1), -1)
XCTAssertEqual(lru.get(3), 3)
XCTAssertEqual(lru.get(4), 4)

implement generic parser in common package that can be provided a [String:func] dictionary to work with any class solution

leetcode parser example:

Input
["LRUCache", "put", "put", "get", "put", "get", "put", "get", "get", "get"]
[[2], [1, 1], [2, 2], [1], [3, 3], [2], [4, 4], [1], [3], [4]]
Output
[null, null, null, 1, null, -1, null, -1, 3, 4]

update templates for start-new-problem.swift

they are out of date due to doc c refactor

add problem description/constraints

most solutions assume certain problem constraints, non empty input, etc.

add to docstring comments?