Code Monkey home page Code Monkey logo

swiftpmlibrary's Introduction

Valid JSON

The SwiftPM Library

This repository powers the list of packages indexed and monitored by the SwiftPM Library. The intention of this repository is to build a complete list of packages that support the Swift Package Manager.

At some point, this list may be able to be replaced with an official list supplied by Apple and/or GitHub but until then, this is better than nothing.

Adding packages

Please feel free to submit your own, or other people's repositories to this list. There are a few requirements, but they are simple:

  • Packages must have a Package.swift file (obviously?) located in the root of the repository.
  • Packages must be written in Swift 4.0 or later.
  • Packages must declare at least one product in the Package.swift file. This can be either a library product, or an executable product. Packages can of course declare more than one product!
  • Packages should have at least one release. A release is defined as a git tag that conforms to the semantic version spec. This can be a beta or a pre-release semantic version, it does not necessarily need to be stable.
  • Packages should compile without errors. Actually, this isn't a strict requirement but it's probably a good idea since you're about to add the package to a package directory.
  • Packages must output valid JSON when swift package dump-package is run with the latest version of the Swift tools. Please check that you can execute this command in the root of the package directory before submitting.
  • The full HTTPS clone URL for the repository should be submitted, including the .git extension.
  • The repository must be publicly accessible.
  • Packages can be on any repository host, not just GitHub. Just add the full HTTPS clone URL.

Note: There's no gatekeeping or quality threshold to be included in this list. The library itself sorts package search results by a number of metrics to place mature, good quality packages higher in the results.

How do you add a package?

It's simple. Fork this repository, edit the JSON, and submit a pull request. If you plan to submit a set of packages, there is no need to submit each package in a separate pull request. Feel free to bundle multiple updates at once as long as all packages match the criteria above.

JSON validation

Travis is configured to validate JSON for every pull request. Please run this validation locally before submitting by running the included validation script, like so:

swift ./validate.swift diff

swiftpmlibrary's People

Contributors

adam-fowler avatar alexdrone avatar balancingrock avatar brettfazio avatar cmtrounce avatar crspybits avatar daveverwer avatar dean151 avatar drewmccormack avatar dylanmaryk avatar fabianfett avatar hallee avatar helje5 avatar jaylyerly avatar jessesquires avatar joannis avatar kiliankoe avatar leogdion avatar mattpolzin avatar maxxfrazer avatar mkj-is avatar nerdsupremacist avatar peterringset avatar phimage avatar rkreutz avatar sindresorhus avatar slaunchaman avatar tantalum73 avatar twodollarsesq avatar zntfdr avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.