cocoapods-scanner v1.1.1

Cocoapods Scanner

Description

Cocoapods Scanner is a powerful utility designed to streamline the process of managing dependencies in your iOS projects. It analyzes your project's Podfile and Podfile.lock to provide structured upgrade recommendations for your CocoaPods.

Installation

Install Cocoapods Scanner via npm:

npm install --save cocoapods-scanner

Usage

Initialize the CocoapodsScanner class with the paths to your Podfile and Podfile.lock:

Scan from github repo

• setup GITHUB_TOKEN env variable

export GITHUB_TOKEN={your_github_token}

• usage

import { CocoapodsScanner, ContentReader, ContentReaderType } from 'cocoapods-scanner';

let blackList = [] // exclude from scanning
let podfileReader = new ContentReader(ContentReaderType.github, {owner: {repo_owner}, repo: {repo_name}, path: 'Podfile'})
let podfileLockReader = new ContentReader(ContentReaderType.github, {owner: {repo_owner}, repo: {repo_name}, path: 'Podfile.lock'})

let scanner = new CocoapodsScanner(podfileReader, podfileLockReader, blackList)

// start scan
scanner.scan().then(result => {
    let outdatedLibraries = result.filter(library => library.outdated)
    if (outdatedLibraries.length > 0) {
        console.log(JSON.stringify(outdatedLibraries, null, 2))
    } else {
        console.log('No outdated libraries')
    }
})

Scan local Podfile

• usage

import { CocoapodsScanner, ContentReader, ContentReaderType } from 'cocoapods-scanner';

let blackList = [] // exclude from scanning
let podfileReader = new ContentReader(ContentReaderType.file, {path: 'Podfile'})
let podfileLockReader = new ContentReader(ContentReaderType.file, {path: 'Podfile.lock'})

let scanner = new CocoapodsScanner(podfileReader, podfileLockReader, blackList)

scanner.scan().then(result => {
    let outdatedLibraries = result.filter(library => library.outdated)
    if (outdatedLibraries.length > 0) {
        console.log(JSON.stringify(outdatedLibraries, null, 2))
    } else {
        console.log('No outdated libraries')
    }
})

Scan from remote server

• usage

import { CocoapodsScanner, ContentReader, ContentReaderType } from 'cocoapods-scanner';

let blackList = [] // exclude from scanning
let podfileReader = new ContentReader(ContentReaderType.url, {path: {remote_link}})
let podfileLockReader = new ContentReader(ContentReaderType.url, {path: {remote_link}})

let scanner = new CocoapodsScanner(podfileReader, podfileLockReader, blackList)

scanner.scan().then(result => {
    let outdatedLibraries = result.filter(library => library.outdated)
    if (outdatedLibraries.length > 0) {
        console.log(JSON.stringify(outdatedLibraries, null, 2))
    } else {
        console.log('No outdated libraries')
    }
})

Features

• Dependency Insight: Gain a comprehensive overview of your project's dependencies and their versions.
• Structured Recommendations: Receive clear and actionable suggestions for updating CocoaPods.
• Effortless Integration: Seamlessly integrate Cocoapods Scanner into your existing projects for hassle-free dependency management.

Contributing

We welcome contributions! Feel free to submit issues, feature requests, or pull requests.

Tests

To run the test cases, install the dev dependency jest:

npm test

License

This project is licensed under the ISC License.

This enhanced version provides a more detailed overview of the features, emphasizes the benefits of using Cocoapods Scanner, and includes a clearer section on contributing to the project. Feel free to customize it further based on your specific project details and goals.