Skip to content

Commit

Permalink
[jazzy] Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Pedro Piñera committed Jul 1, 2017
1 parent ad03a68 commit e1c920f
Show file tree
Hide file tree
Showing 64 changed files with 12,887 additions and 19 deletions.
16 changes: 16 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.{json,js,jsx,html,css}]
indent_style = space
indent_size = 2

[*.md]
trim_trailing_whitespace = false
5 changes: 3 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
/.build
/Packages


# Created by https://www.gitignore.io/api/macos,swift,xcode,appcode,swiftpm

### AppCode ###
Expand Down Expand Up @@ -179,4 +178,6 @@ xcuserdata

# End of https://www.gitignore.io/api/macos,swift,xcode,appcode,swiftpm

.vscode
.vscode

build/
51 changes: 51 additions & 0 deletions .jazzy.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
author: Caramba
author_url: https://twitter.com/carambalabsEng
module: xcodeproj
module_version: 0.0.1
github_url: https://github.com/carambalabs/xcodeproj
copyright: 'Copyright © 2017 Caramba. All rights reserved.'
readme: ABOUT.md
documentation: guides/*.md
custom_categories:
- name: Models
children:
- BuildSettings
- XCConfig
- XCWorkspace
- XcodeProj
- XCBuildConfiguration
- XCConfigurationList
- XCScheme
- XCSharedData
- PBXProductType
- PBXNativeTarget
- PBXProj
- PBXObject
- PBXSourceTree
- PBXAggregateTarget
- PBXBuildFile
- PBXContainerItemProxy
- PBXFileElement
- PBXFileReference
- PBXGroup
- PBXProject
- PBXFrameworksBuildPhase
- PBXHeadersBuildPhase
- PBXResourcesBuildPhase
- PBXCopyFilesBuildPhase
- PBXShellScriptBuildPhase
- PBXSourcesBuildPhase
- PBXTargetDependency
- PBXVariantGroup
- name: Protocols
children:
- ProjectElement
- name: Errors
children:
- XCConfigError
- XCSchemeError
- XCSharedDataError
- XCWorkspaceDataError
- XCWorkspaceError
- XCodeProjError
- PBXObjectError
6 changes: 6 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
source "https://rubygems.org"

gem "rake"
gem "jazzy"
gem "semantic"
gem "colorize"
96 changes: 96 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
GEM
remote: https://rubygems.org/
specs:
CFPropertyList (2.3.5)
activesupport (4.2.9)
i18n (~> 0.7)
minitest (~> 5.1)
thread_safe (~> 0.3, >= 0.3.4)
tzinfo (~> 1.1)
claide (1.0.2)
cocoapods (1.2.1)
activesupport (>= 4.0.2, < 5)
claide (>= 1.0.1, < 2.0)
cocoapods-core (= 1.2.1)
cocoapods-deintegrate (>= 1.0.1, < 2.0)
cocoapods-downloader (>= 1.1.3, < 2.0)
cocoapods-plugins (>= 1.0.0, < 2.0)
cocoapods-search (>= 1.0.0, < 2.0)
cocoapods-stats (>= 1.0.0, < 2.0)
cocoapods-trunk (>= 1.2.0, < 2.0)
cocoapods-try (>= 1.1.0, < 2.0)
colored2 (~> 3.1)
escape (~> 0.0.4)
fourflusher (~> 2.0.1)
gh_inspector (~> 1.0)
molinillo (~> 0.5.7)
nap (~> 1.0)
ruby-macho (~> 1.1)
xcodeproj (>= 1.4.4, < 2.0)
cocoapods-core (1.2.1)
activesupport (>= 4.0.2, < 5)
fuzzy_match (~> 2.0.4)
nap (~> 1.0)
cocoapods-deintegrate (1.0.1)
cocoapods-downloader (1.1.3)
cocoapods-plugins (1.0.0)
nap
cocoapods-search (1.0.0)
cocoapods-stats (1.0.0)
cocoapods-trunk (1.2.0)
nap (>= 0.8, < 2.0)
netrc (= 0.7.8)
cocoapods-try (1.1.0)
colored2 (3.1.2)
colorize (0.8.1)
escape (0.0.4)
fourflusher (2.0.1)
fuzzy_match (2.0.4)
gh_inspector (1.0.3)
i18n (0.8.4)
jazzy (0.8.2)
cocoapods (~> 1.0)
mustache (~> 0.99)
open4
redcarpet (~> 3.2)
rouge (~> 1.5)
sass (~> 3.4)
sqlite3 (~> 1.3)
xcinvoke (~> 0.3.0)
liferaft (0.0.6)
minitest (5.10.2)
molinillo (0.5.7)
mustache (0.99.8)
nanaimo (0.2.3)
nap (1.1.0)
netrc (0.7.8)
open4 (1.3.4)
rake (12.0.0)
redcarpet (3.4.0)
rouge (1.11.1)
ruby-macho (1.1.0)
sass (3.4.24)
semantic (1.6.0)
sqlite3 (1.3.13)
thread_safe (0.3.6)
tzinfo (1.2.3)
thread_safe (~> 0.1)
xcinvoke (0.3.0)
liferaft (~> 0.0.6)
xcodeproj (1.5.0)
CFPropertyList (~> 2.3.3)
claide (>= 1.0.2, < 2.0)
colored2 (~> 3.1)
nanaimo (~> 0.2.3)

PLATFORMS
ruby

DEPENDENCIES
colorize
jazzy
rake
semantic

BUNDLED WITH
1.15.1
28 changes: 12 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,15 @@
<p align="center">
<img src="Assets/logo.png" width="300" max-width="50%" alt=Startup />
</p>

<p align="center">
<a href="https://travis-ci.org/carambalabs/xcodeproj">
<img src="https://travis-ci.org/carambalabs/xcodeproj.svg?branch=master">
</a>
<a href="https://swift.org/package-manager">
<img src="https://img.shields.io/badge/spm-compatible-brightgreen.svg?style=flat" alt="Swift Package Manager" />
</a>
<a href="https://twitter.com/pepibumur">
<img src="https://img.shields.io/badge/contact-@pepibumur-blue.svg?style=flat" alt="Twitter: @pepibumur" />
</a>
</p>

xcodeproj
==============

<a href="https://travis-ci.org/carambalabs/xcodeproj">
<img src="https://travis-ci.org/carambalabs/xcodeproj.svg?branch=master">
</a>
<a href="https://swift.org/package-manager">
<img src="https://img.shields.io/badge/spm-compatible-brightgreen.svg?style=flat" alt="Swift Package Manager" />
</a>
<a href="https://twitter.com/pepibumur">
<img src="https://img.shields.io/badge/contact-@pepibumur-blue.svg?style=flat" alt="Twitter: @pepibumur" />
</a>

xcodeproj is a library written in Swift for parsing and working with Xcode projects. It's heavily inspired in [CocoaPods Xcodeproj](https://github.com/CocoaPods/Xcodeproj) and [xcode](https://www.npmjs.com/package/xcode).

Expand Down
50 changes: 50 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
#!/usr/bin/rake

require 'semantic'
require 'colorize'

### HELPERS ###

def generate_docs
sh "jazzy --clean --sdk macosx --xcodebuild-arguments -scheme,xcodeproj --skip-undocumented --no-download-badge"
end

def any_git_changes?
!`git status -s`.empty?
end

def build
sh "swift build"
end

def commit_and_push
last_tag = `git describe --abbrev=0 --tags`
current_version = Semantic::Version.new last_tag
new_version = current_version.increment! :patch
`git add .`
`git commit -m "Bump version to #{new_version}"`
`git tag #{new_version}`
`git push origin --tags`
new_version
end

def print(message)
puts message.colorize(:yellow)
end

### TASKS ###

desc "Bumps the version of xcodeprojlint. It creates a new tagged commit and archives the binary to be published with the release"
task :release => [:clean] do
abort '> Commit all your changes before starting the release' unless !any_git_changes?
build
print "> xcodeproj built"
generate_docs
print "> Documentation generated"
version = commit_and_push
print "> Commit created and tagged with version: #{version}"
end

task :docs do
generate_docs
end
1 change: 0 additions & 1 deletion Sources/xcodeproj/PBXAggregateTarget.swift
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ import Foundation
import Unbox

// This is the element for a build target that aggregates several others.

public struct PBXAggregateTarget: PBXTarget {

// MARK: - Attributes
Expand Down
Loading

0 comments on commit e1c920f

Please sign in to comment.