2 |
404
3 |
4 | <% if (locals.flash && flash.warning) { %>
5 |
6 | <%= flash.warning %>
7 |
8 | ×
9 |
10 |
11 | <% } %>
12 |
13 | <% if (locals.noExist){ %>
14 |
<%= locals.noExist %>
15 | <% } %>
16 |
17 | Unable to find
<%= req.url %>
18 | <% if (locals.flash && flash.err_message) { %>
19 |
<%= flash.err_message %>
20 | <% } %>
21 |
22 | <% if (locals.flash && flash.err) { %>
23 |
<%= JSON.stringify(flash.err) %>
24 | <% } %>
25 |
26 |
27 |
28 |
2 |
9 |
10 |
Add a Swift package
11 | <% if (flash && flash.error) { %>
12 |
13 | <%= flash.error %>
14 |
15 | ×
16 |
17 |
18 | <% } %>
19 |
28 |
29 |
Only public repositories can be successfully added to the Swift Package Registry . Swift package will not update automatically unless the GitHub App is installed on the repository.
30 |
31 |
",
7 | "license": "ISC",
8 | "repository": "https://github.com/twodayslate/swift-package-registry.git",
9 | "homepage": "https://github.com/twodayslate/swift-package-registry",
10 | "bugs": "https://github.com/twodayslate/swift-package-registry/issues",
11 | "keywords": [
12 | "probot",
13 | "github",
14 | "probot-app"
15 | ],
16 | "scripts": {
17 | "dev": "nodemon",
18 | "start": "probot run ./index.js",
19 | "lint": "standard --fix",
20 | "test": "jest && standard",
21 | "test:watch": "jest --watch --notify --notifyMode=change --coverage",
22 | "postinstall": "patch-package"
23 | },
24 | "dependencies": {
25 | "@actions/core": "1.11.1",
26 | "@octokit/rest": "^19.0.7",
27 | "absolutify": "^0.1.0",
28 | "apicache": "^1.6.3",
29 | "async": "3.2.6",
30 | "axios": "1.9.0",
31 | "body-parser": "^1.20.2",
32 | "connect-flash": "^0.1.1",
33 | "dateformat": "^4.6.3",
34 | "dockerode": "^3.3.4",
35 | "ejs": "3.1.10",
36 | "express": "^4.18.2",
37 | "express-partials": "^0.3.0",
38 | "express-session": "1.18.1",
39 | "html-to-text": "^9.0.4",
40 | "patch-package": "^6.5.1",
41 | "pg": "8.16.0",
42 | "pg-hstore": "^2.3.4",
43 | "probot": "^12.3.0",
44 | "require-context": "^1.1.0",
45 | "semver": "7.7.2",
46 | "sequelize": "6.37.7",
47 | "uuid": "^9.0.0"
48 | },
49 | "devDependencies": {
50 | "https-localhost": "^4.7.0",
51 | "jest": "29.7.0",
52 | "nock": "^12.0.0",
53 | "nodemon": "^2.0.4",
54 | "smee-client": "^1.2.2",
55 | "standard": "^14.3.4"
56 | },
57 | "engines": {
58 | "node": ">= 8.3.0"
59 | },
60 | "standard": {
61 | "env": [
62 | "jest"
63 | ],
64 | "ignore": [
65 | "/action/index.js"
66 | ]
67 | },
68 | "nodemonConfig": {
69 | "exec": "npm start",
70 | "watch": [
71 | ".env",
72 | "."
73 | ]
74 | },
75 | "jest": {
76 | "testEnvironment": "node"
77 | }
78 | }
79 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing
2 |
3 | [fork]: /fork
4 | [pr]: /compare
5 | [style]: https://standardjs.com/
6 | [code-of-conduct]: CODE_OF_CONDUCT.md
7 |
8 | Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
9 |
10 | Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
11 |
12 | ## Issues and PRs
13 |
14 | If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all and any contributions. If you have questions, too, we'd love to hear them.
15 |
16 | We'd also love PRs. If you're thinking of a large PR, we advise opening up an issue first to talk about it, though! Look at the links below if you're not sure how to open a PR.
17 |
18 | ## Submitting a pull request
19 |
20 | 1. [Fork][fork] and clone the repository.
21 | 1. Configure and install the dependencies: `npm ci`.
22 | 1. Make sure the tests pass on your machine: `npm test`, note: these tests also apply the linter, so there's no need to lint separately.
23 | 1. Create a new branch: `git checkout -b my-branch-name`.
24 | 1. Make your change, add tests, and make sure the tests still pass.
25 | 1. Push to your fork and [submit a pull request][pr].
26 | 1. Pat your self on the back and wait for your pull request to be reviewed and merged.
27 |
28 | Here are a few things you can do that will increase the likelihood of your pull request being accepted:
29 |
30 | - Follow the [style guide][style] which is using standard. Any linting errors should be shown when running `npm test`.
31 | - Write and update tests.
32 | - Keep your changes as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
33 | - Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
34 |
35 | Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocked you.
36 |
37 | ## Resources
38 |
39 | - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
40 | - [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
41 | - [GitHub Help](https://help.github.com)
42 |
--------------------------------------------------------------------------------
/lib/package.js:
--------------------------------------------------------------------------------
1 | const { parsePackageRequest } = require('./process')
2 |
3 | module.exports = function (router) {
4 | router.get('/:owner/:repo.json', async function (req, res) {
5 | var myPackage = await router.db.Package.findOne({
6 | where: {
7 | 'info.name': req.params.repo,
8 | 'info.owner.login': req.params.owner
9 | }
10 | })
11 | res.json(myPackage)
12 | })
13 |
14 | router.get('/:owner/:repo', async function (req, res) {
15 | const fullName = req.params.owner + '/' + req.params.repo
16 | req.octokitWithPersonalAccessToken.repos.get({ owner: req.params.owner, repo: req.params.repo }).then(async function (repository) {
17 | if (!repository || !repository.data) {
18 | res.status(404)
19 | req.flash('warning', 'This is not a GitHub repository!')
20 | res.render('404')
21 | return
22 | }
23 |
24 | if (repository.data.full_name !== fullName) {
25 | // this repository was renamed so go to the real one
26 | res.redirect('/' + repository.data.full_name)
27 | return
28 | }
29 |
30 | try {
31 | const [_package, created] = await router.db.Package.findOrCreate({
32 | where: {
33 | github_id: repository.data.id
34 | },
35 | defaults: {
36 | github_id: repository.data.id,
37 | info: repository.data
38 | }
39 | })
40 | if (created) {
41 | parsePackageRequest(req, _package)
42 | } else {
43 | _package.info = repository.data
44 | _package.save()
45 | }
46 |
47 | var title = repository.data.name
48 | if (_package.description) {
49 | title = _package.description.name
50 | }
51 |
52 | res.render('package', { repository: repository.data, package: _package, title: title })
53 | } catch (err) {
54 | res.flash(500)
55 | req.flash('err_message', err.message)
56 | req.flash('err', err)
57 | res.render('500')
58 | }
59 | }).catch(function (err) {
60 | if (err.status === 404) {
61 | res.status(404)
62 | req.flash('warning', 'This is not a GitHub repository!')
63 | res.render('404')
64 | return
65 | }
66 | res.status(500)
67 | req.flash('err_message', err.message)
68 | req.flash('err', err)
69 | res.render('500')
70 | })
71 | })
72 | }
73 |
--------------------------------------------------------------------------------
/lib/add.js:
--------------------------------------------------------------------------------
1 | const { parsePackageRequest } = require('./process')
2 |
3 | var async = require('async')
4 |
5 | var addQueue = async.queue(async function (task, callback) {
6 | console.log('processing package in queue', task.package.info.full_name)
7 | await parsePackageRequest(task.req, task.package)
8 | callback()
9 | }, parseInt(process.env.PROCESS_QUEUE_SIZE || '', 10))
10 |
11 | module.exports = function (router) {
12 | router.get('/add', async function (req, res) {
13 | res.render('add', { title: 'Add a Swift Package' })
14 | })
15 |
16 | router.post('/add', async function (req, res) {
17 | var parsedUrl
18 |
19 | var onInvalidURL = function () {
20 | req.flash('error', 'Invalid GitHub URL')
21 | res.status(400)
22 | res.redirect('/add')
23 | }
24 |
25 | try {
26 | parsedUrl = new URL(req.body.url)
27 | } catch (err) {
28 | onInvalidURL()
29 | return
30 | }
31 |
32 | if (parsedUrl.hostname === 'github.com' || parsedUrl.hostname === 'swiftpackageregistry.com' || parsedUrl.hostname === 'swiftpkg.dev') {
33 | const fullName = parsedUrl.pathname.trim().replace('.git', '').replace(/^\/|\/$/g, '') // https://stackoverflow.com/a/3840645/193772
34 | if (fullName.split('/').length !== 2) {
35 | onInvalidURL()
36 | return
37 | }
38 |
39 | const owner = fullName.split('/')[0]
40 | const repo = fullName.split('/')[1]
41 |
42 | const repository = await req.octokitWithPersonalAccessToken.repos.get({ owner, repo })
43 |
44 | if (repository.private) {
45 | onInvalidURL()
46 | return
47 | }
48 | const [_package, created] = await router.db.Package.findOrCreate({
49 | where: { github_id: repository.data.id },
50 | defaults: {
51 | github_id: repository.data.id,
52 | info: repository.data
53 | }
54 | })
55 |
56 | if (created) {
57 | console.log('Newly created package', _package.info.full_name)
58 | // only parse newly created packages
59 | addQueue.push({ req: req, package: _package })
60 | } else {
61 | _package.info = repository.data
62 | _package.save()
63 |
64 | console.log('adding already created package', _package.info.full_name)
65 |
66 | // todo: only process if there is an update
67 | addQueue.push({ req: req, package: _package })
68 | }
69 |
70 | res.redirect(_package.info.full_name)
71 | } else {
72 | onInvalidURL()
73 | }
74 | })
75 | }
76 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Swift Package Registry
2 |
3 | [](https://github.com/twodayslate/swift-package-registry/actions?query=workflow%3A%22Node.js+CI%22)
4 |
5 | The [Swift Package Registry](https://swiftpackageregistry.com/) is a collection of Swift Packages. Since the [GitHub Swift Package Registry](https://github.blog/2019-06-03-github-package-registry-will-support-swift-packages/) is not currently released and the [IBM Swift Package Catalog](https://developer.ibm.com/swift/2016/02/22/introducing-swift-package-catalog/) is has been killed, the [Swift Package Registry](https://swiftpackageregistry.com/) fills the current gap for easier searching and discoverability of Swift Packages.
6 |
7 | ## Technical
8 |
9 | This [GitHub App](https://developer.github.com/apps/about-apps/) is a [Node.js](https://nodejs.org/en/) application built with [Probot](https://github.com/probot/probot). It parses all Swift packages using [Docker](https://github.com/apocas/dockerode). You can help contribue to this project by visiting the [GitHub page](https://github.com/twodayslate/swift-package-registry/). Issues and pull requests are welcomed!
10 |
11 | Only public repositories are supported. When adding packages manually, a personal access token is used to fetch information about the package.
12 |
13 | Docker is used to help validate packages. Just parsing Package.swift is not always enough. It is also an additional check for Swift version compatability.
14 |
15 | You can access the [Swift Package Registry](https://swiftpackageregistry.com/) via [swiftpackageregistry.com](https://swiftpackageregistry.com/) (main site), [swift-packages.com](https://swift-packages.com), [swiftpkg.dev](https://swiftpkg.dev), [SVVlFT.com](https://svvlft.com), and [swiftdependencies.com](https://swiftdependencies.com).
16 |
17 | ## Development
18 |
19 | ### Setup
20 |
21 | #### Install dependencies
22 | ```sh
23 | npm install
24 | ```
25 |
26 | Setup .env . You can use .env.exmaple as a base.
27 |
28 | #### Run the bot
29 | ```
30 | npm start
31 | ```
32 |
33 | *GitHub Action*
34 |
35 | ```sh
36 | ncc build -o action action.js
37 | ```
38 |
39 | For locally testing Swift Package Collections you will need to be using TLS/SSL. This can be achieved with the `https-localhost` npm package and manually modifying probot to use that over it's regular express web server.
40 |
41 | ### Contributing
42 |
43 | If you have suggestions for how Swift Package Registry could be improved, or want to report a bug, open an issue! We'd love all and any contributions.
44 |
45 | For more, check out the [Contributing Guide](https://github.com/twodayslate/swift-package-registry/blob/master/CONTRIBUTING.md).
46 |
--------------------------------------------------------------------------------
/views/account.ejs:
--------------------------------------------------------------------------------
1 |
2 |
3 | <% if (locals.needsInstall) { %>
4 |
Install GitHub App
5 |
In order to have your packages automatically updated, you will need to install the GitHub application and enable it your desired repository.
6 |
7 |
Install GitHub App
8 | <% } else { %>
9 |
13 |
14 | <% if (repos.total_count > 0) { %>
15 |
Enabled Repositories
16 |
17 |
18 |
19 | Repository
20 | Description
21 |
22 |
23 |
24 | <% repos.repositories.forEach(function(repo) { %>
25 |
26 | <%= repo.name %> <%= repo.description %>
29 |
30 | <% }) %>
31 |
32 |
33 |
34 | <% if (repos.total_count > per_page) { %>
35 |
36 |
60 |
61 | <% } %>
62 | <% } else { %>
63 | No enabled repositories
64 | <% } %>
65 | <% } %>
66 |
2 |
3 | <% if(locals.flash) { %>
4 | <% if(flash.error) { %>
5 |
6 | <%= flash.error.message || flash.error %>
7 |
8 | ×
9 |
10 |
11 | <% } %>
12 | <% } %>
13 |
14 |
23 |
24 |
25 |
26 |
Popular Swift Packages
27 |
53 |
54 |
55 |
56 |
Recently Added
57 |
71 |
72 |
Recently Released
73 |
87 |
88 |
89 |
2 |
Processing Swift Packages
3 |
4 |
5 |
6 | ID
7 | Repository
8 | Description
9 |
14 |
15 |
16 | <% processing_packages.forEach(function(package){ %>
17 |
18 | <%= package.id %>
19 | <% if(package.info) { %><%= package.info.full_name %> <% } %>
20 |
21 | <% if(package.info) { %><%= package.info.description %><% } %>
22 |
23 |
32 |
33 | <% if (locals.user && user.isAdmin) { %>
34 |
37 | <% }); %>
38 |
39 |
40 |
41 |
All Swift Packages
42 |
43 |
44 |
45 | ID
46 | Repository
47 | Description
48 | Error
49 |
54 |
55 |
56 | <% all_packages.forEach(function(package){ %>
57 |
58 | <%= package.id %>
59 | <% if(package.info) { %><%= package.info.full_name %> <% } else { %><%= package.full_name %><% } %>
60 | <% if(package.info) { %><%= package.info.description %><% } %>
61 | <%= package.error %>
62 |
63 |
72 |
73 | <% if (locals.user && user.isAdmin) { %>
74 |
77 | <% }); %>
78 |
79 |
80 |
<%= title %> - <%= whoami.name %>
9 | <% } else { %>
10 | <%= whoami.name %>
11 | <% } %>
12 |
13 |
45 |
46 |
47 |
49 |
50 |
52 |
53 |
57 |
58 | <% if (!locals.user) { %>
59 | Log In Mod Log Out
67 |
69 |
70 | <%- body %>
71 |
72 |
73 |
74 |
75 |
76 |
77 |
78 |
<%= packageCount %> successfully parsed packages
79 |
Copyright © 2020 All rights reserved.
80 |
Swift and the Swift logo are trademarks of Apple Inc.
81 |
82 |
89 |
90 |
99 |
100 |
101 |
103 |
2 | <% if (!package || package.processing || !package.info) { %>
3 |
4 |
5 | Loading...
6 |
7 |
Package is still processing. This should only take a few minutes.
8 |
9 |
10 |
23 | <% } else { %>
24 | <% if (package.info && package.info.archived) { %>
25 |
26 |
Warning: Package Archived
27 |
This package is archived and has a low chance of being updated.
28 |
29 | <% } %>
30 | <% if (package.error) { %>
31 |
32 |
Error processing
33 |
<%= package.error %>
34 | This package can be updated automatically by having the owner add the
GitHub App to this repository and creating a new release.
35 |
36 | <% } %>
37 | <% if (package.info && package.info.fork) { %>
38 |
46 | <% } %>
47 |
48 |
49 |
50 |
51 |
52 | <% if (package.description) { %>
53 | <%= package.description.name %>
54 | <% } else { %>
55 | <%= package.info.name %>
56 | <% } %>
57 |
58 |
59 | <% var release = package.info.default_branch %>
60 | <% if (package.latest_release) { release = package.latest_release.tag_name.replace('v','')} %>
61 |
62 | <%= release %>
63 |
64 |
65 |
68 |
69 |
70 |
<%= package.info.description %>
71 |
72 | <% if(package.topics) { %>
73 |
74 | <% package.topics.forEach(function(tag) { %>
75 |
<%= tag %>
76 | <% }) %>
77 |
78 | <% } %>
79 |
80 |
81 |
83 |
84 |
108 |
109 |
110 |
111 |
112 | <% if(package.latest_release) { %>
113 |
114 |
115 |
116 |
117 |
<%= package.latest_release.published_at %>
118 |
119 | <%- package.latest_release.body %>
120 |
121 |
122 |
123 | <% } %>
124 |
125 |
126 |
127 |
128 |
129 | <%- package.readme || package.readme_html || package.readme_raw %>
130 |
131 |
132 |
133 |
134 |
Description
135 |
136 |
137 | Swift Tools <%= package.tools_version %>
138 |
139 |
140 |
View Raw Output
141 |
142 |
143 |
144 |
145 |
151 |
152 |
<%= JSON.stringify(package.description, null, 2) %>
153 |
154 |
155 |
156 |
157 |
158 |
View Package
159 |
160 |
View More Packages from this Author
161 |
162 |
163 |
164 |
165 |
171 |
172 |
<%= JSON.stringify(package.dump, null, 2) %>
173 |
174 |
175 |
176 |
177 |
178 |
Dependencies
179 |
180 |
181 | <% if (package.dependencies && package.dependencies.dependencies && package.dependencies.dependencies.length > 0) { %>
182 |
183 | <% package.dependencies.dependencies.forEach(function(dep) { %>
184 | <% let depurl = new URL(dep.url); %>
185 | <% if (depurl.hostname == "github.com") { %>
186 | <% let deppath = depurl.pathname.replace('.git', ''); %>
187 | <%= dep.name %> <%= dep.version %> <%= dep.name %><%= dep.version %>
190 | <% } %>
191 | <% }) %>
192 | <% } else { %>
193 | None
194 | <% } %>
195 |
196 |
197 |
198 |
View Raw Output
199 |
200 |
201 |
202 |
203 |
204 |
210 |
211 |
<%= JSON.stringify(package.dependencies, null, 2) %>
212 |
213 |
214 |
215 |
216 |
217 |
218 |
219 |
220 |
Last updated: <%= package.updatedAt %>
221 | <% } %>
222 |