A data-driven UICollectionView framework for building fast and flexible lists.
Find a file
James Sherlock b71c346f66 Amend swiftlint to work with older installations
Summary:
![image](https://cloud.githubusercontent.com/assets/15193942/26492070/41f53338-420a-11e7-8ed6-f5d9872338c4.png)

Noticed an issue when trying to build the examples project that I couldn't because of the Swiftlint build phase (see the image above)

As it turns out in between the version I have installed (0.16.1) and the latest (0.19.0) they've made it so you can drop `lint` from the command (which is the default task).

I see two options really:
1. We add `lint` to the command which at least lets older versions of Swiftlint compile the project without making changes to run phases. It's worth noting that this means that certain (newer) rules won't be detected.
2. We add a way of detecting if they have an older version (likely by comparing the output of `$(swiftlint version)` to the version we know it works on. And display a more appropriate message and not fail the build.

Happy to discuss this

heshamsalman jessesquires rnystrom
Closes https://github.com/Instagram/IGListKit/pull/796

Differential Revision: D5137557

Pulled By: rnystrom

fbshipit-source-id: b6c85197d7a66e37976d66b646c9c9241827ce42
2017-05-26 08:17:15 -07:00
.github Update ISSUE_TEMPLATE.md 2017-04-26 13:17:23 -07:00
docs final docs update for 3.0 2017-05-12 10:46:46 -07:00
Examples Amend swiftlint to work with older installations 2017-05-26 08:17:15 -07:00
Guides Remove ", which will be super fast" from FAQ.md 2017-05-25 08:22:36 -07:00
IGListKit.xcodeproj Regen docs for 3.0 2017-05-12 07:25:00 -07:00
IGListKit.xcworkspace Initial commit 2016-10-11 10:12:17 -04:00
Pods Fixup project, update README and guides 2017-05-12 09:47:20 -07:00
Resources 3.0 migration guide 2017-05-11 13:50:49 -07:00
scripts Implemented SwiftLint, new PR 2017-05-16 07:31:43 -07:00
Source Fix typo: experiements > experiments. 2017-05-25 08:22:37 -07:00
Tests Rename sectionIndex API to just section 2017-05-11 14:49:59 -07:00
.gitignore Nitpicky comment fixes 2017-03-31 13:01:40 -07:00
.slather.yml Ignore Xcode dir in coverage reports 2016-11-20 07:58:58 -08:00
.travis.yml Implemented SwiftLint, new PR 2017-05-16 07:31:43 -07:00
build_docs.sh Add script to detect if Jazzy is installed or not 2017-05-25 07:46:13 -07:00
CHANGELOG.md Corrected "peform", close #775 2017-05-25 07:33:53 -07:00
Dangerfile Update Dangerfile to be less noisy, close #792 2017-05-25 13:46:06 -07:00
IGListKit.podspec Bump pod and project version to 3.0.0 2017-05-10 12:32:05 -07:00
LICENSE.md Initial commit 2016-10-11 10:12:17 -04:00
PATENTS.md Initial commit 2016-10-11 10:12:17 -04:00
Podfile Fixup project, update README and guides 2017-05-12 09:47:20 -07:00
Podfile.lock Fixup project, update README and guides 2017-05-12 09:47:20 -07:00
README.md Change help out to help in readme.md 2017-05-25 07:33:53 -07:00

Build Status Coverage Status Pods Version Platforms Carthage Compatible


A data-driven UICollectionView framework for building fast and flexible lists.

Main Features
🙅 Never call performBatchUpdates(_:, completion:) or reloadData() again
🏠 Better architecture with reusable cells and components
🔠 Create collections with multiple data types
🔑 Decoupled diffing algorithm
Fully unit tested
🔍 Customize your diffing behavior for your models
📱 Simply UICollectionView at its core
🚀 Extendable API
🐦 Written in Objective-C with full Swift interop support

IGListKit is built and maintained with ❤️ by Instagram engineering. We use the open source version master branch in the Instagram app.

Requirements

  • Xcode 8.0+
  • iOS 8.0+
  • tvOS 9.0+
  • macOS 10.10+ (diffing algorithm components only)
  • Interoperability with Swift 3.0+

Installation

CocoaPods

The preferred installation method is with CocoaPods. Add the following to your Podfile:

pod 'IGListKit', '~> 3.0'

Carthage

For Carthage, add the following to your Cartfile:

github "Instagram/IGListKit" ~> 3.0

For advanced usage, see our Installation Guide.

Getting Started

Documentation

You can find the docs here. Documentation is generated with jazzy and hosted on GitHub-Pages.

Vision

For the long term goals and "vision" of IGListKit, please read our Vision doc.

Contributing

Please see the CONTRIBUTING file for how to help. At Instagram we sync the open source version of IGListKit daily, so we're always testing the latest changes. But that requires all changes be thoroughly tested and follow our style guide.

We have a set of starter tasks that are great for beginners to jump in on and start contributing.

License

IGListKit is BSD-licensed. We also provide an additional patent grant.

The files in the /Examples/ directory are licensed under a separate license as specified in each file. Documentation is licensed CC-BY-4.0.