Skip to content

Commit f1fb3e1

Browse files
authored
Merge pull request #4 from geoffw0/swiftdoc3
Swift: Add Swift to supported-frameworks.rst, supported-versions-compilers.rst and extractors.rst
2 parents 81c2979 + f02c1ed commit f1fb3e1

File tree

3 files changed

+38
-3
lines changed

3 files changed

+38
-3
lines changed

docs/codeql/reusables/extractors.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,6 @@
1717
* - Python
1818
- ``python``
1919
* - Ruby
20-
- ``ruby``
20+
- ``ruby``
21+
* - Swift
22+
- ``swift``

docs/codeql/reusables/supported-frameworks.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -278,3 +278,34 @@ and the CodeQL library pack ``codeql/ruby-all`` (`changelog <https://github.com/
278278
Ruby on Rails, Web framework
279279
rubyzip, Compression library
280280
typhoeus, HTTP client
281+
282+
Swift built-in support
283+
================================
284+
285+
.. include:: ../reusables/swift-beta-note.rst
286+
287+
Provided by the current versions of the
288+
CodeQL query pack ``codeql/swift-queries`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/swift/ql/src/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/swift/ql/src>`__)
289+
and the CodeQL library pack ``codeql/swift-all`` (`changelog <https://github.com/github/codeql/tree/codeql-cli/latest/swift/ql/lib/CHANGELOG.md>`__, `source <https://github.com/github/codeql/tree/codeql-cli/latest/swift/ql/lib>`__).
290+
291+
.. csv-table::
292+
:header-rows: 1
293+
:class: fullWidthTable
294+
:widths: auto
295+
296+
Name, Category
297+
`AEXML <https://github.com/tadija/AEXML>`__, XML processing library
298+
`Alamofire <https://github.com/Alamofire/Alamofire>`__, Network communicator
299+
`Core Data <https://developer.apple.com/documentation/coredata/>`__, Database
300+
`CryptoKit <https://developer.apple.com/documentation/cryptokit/>`__, Cryptography library
301+
`CryptoSwift <https://github.com/krzyzanowskim/CryptoSwift>`__, Cryptography library
302+
`Foundation <https://developer.apple.com/documentation/foundation>`__, Utility library
303+
`GRDB <https://github.com/groue/GRDB.swift>`__, Database
304+
`JavaScriptCore <https://developer.apple.com/documentation/javascriptcore>`__, Scripting library
305+
`Libxml2 <https://gitlab.gnome.org/GNOME/libxml2>`__, XML processing library
306+
`Network <https://developer.apple.com/documentation/network>`__, Network communicator
307+
`Realm Swift <https://realm.io/realm-swift/>`__, Database
308+
`RNCryptor <https://github.com/RNCryptor/RNCryptor>`__, Cryptography library
309+
`SQLite3 <https://sqlite.org/index.html>`__, Database
310+
`SQLite.swift <https://github.com/stephencelis/SQLite.swift>`__, Database
311+
`WebKit <https://developer.apple.com/documentation/webkit>`__, User interface library

docs/codeql/reusables/supported-versions-compilers.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@
2424
JavaScript,ECMAScript 2022 or lower,Not applicable,"``.js``, ``.jsx``, ``.mjs``, ``.es``, ``.es6``, ``.htm``, ``.html``, ``.xhtm``, ``.xhtml``, ``.vue``, ``.hbs``, ``.ejs``, ``.njk``, ``.json``, ``.yaml``, ``.yml``, ``.raml``, ``.xml`` [7]_"
2525
Python [8]_,"2.7, 3.5, 3.6, 3.7, 3.8, 3.9, 3.10, 3.11",Not applicable,``.py``
2626
Ruby [9]_,"up to 3.2",Not applicable,"``.rb``, ``.erb``, ``.gemspec``, ``Gemfile``"
27-
TypeScript [10]_,"2.6-5.0",Standard TypeScript compiler,"``.ts``, ``.tsx``, ``.mts``, ``.cts``"
27+
Swift [10]_,"Swift 5.4-5.7","Swift compiler","``.swift``"
28+
TypeScript [11]_,"2.6-5.0",Standard TypeScript compiler,"``.ts``, ``.tsx``, ``.mts``, ``.cts``"
2829

2930
.. container:: footnote-group
3031

@@ -37,4 +38,5 @@
3738
.. [7] JSX and Flow code, YAML, JSON, HTML, and XML files may also be analyzed with JavaScript files.
3839
.. [8] The extractor requires Python 3 to run. To analyze Python 2.7 you should install both versions of Python.
3940
.. [9] Requires glibc 2.17.
40-
.. [10] TypeScript analysis is performed by running the JavaScript extractor with TypeScript enabled. This is the default.
41+
.. [10] Swift support is currently in beta. Support for the analysis of Swift 5.4-5.7 requires macOS. Swift 5.7.3 can also be analyzed using Linux.
42+
.. [11] TypeScript analysis is performed by running the JavaScript extractor with TypeScript enabled. This is the default.

0 commit comments

Comments
 (0)