Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SPT-1998 Последние правки + генерация swift-docc #140

Merged
merged 3 commits into from
Jun 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 0 additions & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ git_source(:github) do |repo_name|
end if Gem::Version.new(Bundler::VERSION) < Gem::Version.new('2')

gem 'xcpretty', "0.3.0"
gem "jazzy", "0.14.2"

plugins_path = File.join(File.dirname(__FILE__), 'fastlane', 'Pluginfile')
eval_gemfile(plugins_path) if File.exist?(plugins_path)
7 changes: 6 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,12 @@ test:

## Created documentation by comments from code
doc:
bundle exec jazzy --clean --build-tool-arguments -project,./NodeKit/NodeKit.xcodeproj,-scheme,NodeKit,-sdk,iphonesimulator --output "docs"
cd ./NodeKit && swift package --allow-writing-to-directory ../docs \
generate-documentation --target NodeKit \
--disable-indexing \
--transform-for-static-hosting \
--hosting-base-path NodeKit \
--output-path ../docs

# COLORS
GREEN := $(shell tput -Txterm setaf 2)
Expand Down
33 changes: 0 additions & 33 deletions NodeKit.podspec

This file was deleted.

3 changes: 3 additions & 0 deletions Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ let package = Package(
targets: ["NodeKitMock"]
),
],
dependencies: [
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

кстати наверное забыл тебе рассказать
мы же как-то делали уже что-то подобное, и я не помню при этом, чтобы мы добавляли какие-то зависимости...

не претендую на правильность, но может тебе ползено будет увидеть - https://github.com/surfstudio/debug-screen-ios/blob/master/.github/workflows/deploy_docc.yml

],
targets: [
.target(
name: "NodeKitThirdParty",
Expand Down
26 changes: 9 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

[![GitHubActions Build Status](https://github.com/surfstudio/NodeKit/workflows/CI/badge.svg)](https://github.com/surfstudio/NodeKit/actions)
[![codecov](https://codecov.io/gh/surfstudio/NodeKit/branch/master/graph/badge.svg)](https://codecov.io/gh/surfstudio/NodeKit)
[![CocoaPods](https://img.shields.io/badge/pod-compatible-blue.svg)](https://github.com/surfstudio/NodeKit/blob/master/NodeKit.podspec)
[![SPM Compatible](https://img.shields.io/badge/SPM-compatible-blue.svg)](https://github.com/apple/swift-package-manager)
[![Documentation](https://surfstudio.github.io/NodeKit/badge.svg)](https://surfstudio.github.io/NodeKit/)

Flexible and customizable network library

Expand All @@ -13,6 +11,14 @@ Flexible and customizable network library
<img src="TechDocs/Header.svg">
</p>

## About

The NodeKit library enables rapid and easy creation of requests of varying complexity. The system operates on the principle of asynchronous data transformation, wherein nodes are interconnected to form a chain that transforms input data into a server response.

![All text](TechDocs/NodeKitHeader.svg)

Such an approach allows us to flexibly adapt to a wide range of requirements.

## Build request using Swift Concurrency

```Swift
Expand Down Expand Up @@ -56,14 +62,6 @@ func credentialsPublisher(for authModel: AuthModel) -> AnyPublisher<NodeResult<C

```

## About

The NodeKit library enables rapid and easy creation of requests of varying complexity. The system operates on the principle of asynchronous data transformation, wherein nodes are interconnected to form a chain that transforms input data into a server response.

![All text](TechDocs/NodeKitHeader.svg)

Such an approach allows us to flexibly adapt to a wide range of requirements.

## Installation

### Swift Package Manager
Expand All @@ -83,13 +81,6 @@ dependencies: [
]
```

### CocoaPods

Using Podfile:

- Write `pod NodeKit`
- Run `pod install` command

## Features

- Swift Concurrency
Expand All @@ -102,6 +93,7 @@ Using Podfile:
- Comprehensive Unit and Integration Test Coverage
- Mock target for Unit tests
- [Documentation](TechDocs/Documentation.md)
- [Code documentation](https://surfstudio.github.io/NodeKit/documentation/nodekit)

## Contributing

Expand Down
1 change: 0 additions & 1 deletion TechDocs/Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,3 @@
- [Chains](/TechDocs/Chains.md)
- [Logging](/TechDocs/Log/Log.md)
- [NodeKitMock](/TechDocs/Testing/NodeKitMock.md)
- [Code documentation](../docs/index.html)
Loading
Loading