hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-05-03 12:45:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update articles for other languages

Browse Source
This commit is contained in:
Felicity Chapman
2022-11-29 15:09:15 +00:00
parent 0def31a2ce
commit 1142b77f8d
19 changed files with 119 additions and 186 deletions
Download Patch File Download Diff File Expand all files Collapse all files

73
docs/codeql/codeql-language-guides/basic-query-for-ruby-code.rst
View File

@@ -3,7 +3,9 @@
Basic query for Ruby code
=========================
Learn to write and run a simple CodeQL query.
Learn to write and run a simple CodeQL query using Visual Studio Code with the CodeQL extension.
.. include:: ../reusables/vs-code-basic-instructions/setup-to-run-queries.rst
About the query
---------------
@@ -15,24 +17,12 @@ The query we're going to run performs a basic search of the code for ``if`` expr
if error
# Handle the error
Running the query
-----------------
Running a quick query
---------------------
#. In the main search box on LGTM.com, search for the project you want to query. For tips, see `Searching <https://lgtm.com/help/lgtm/searching>`__.
.. include:: ../reusables/vs-code-basic-instructions/run-quick-query-1.rst
#. Click the project in the search results.
#. Click **Query this project**.
This opens the query console. (For information about using this, see `Using the query console <https://lgtm.com/help/lgtm/using-query-console>`__.)
.. pull-quote::
Note
Alternatively, you can go straight to the query console by clicking **Query console** (at the top of any page), selecting **Ruby** from the **Language** drop-down list, then choosing one or more projects to query from those displayed in the **Project** drop-down list.
#. Copy the following query into the text box in the query console:
#. In the quick query tab, delete the content and paste in the following query`.
.. code-block:: ql
@@ -40,37 +30,20 @@ Running the query
from IfExpr ifexpr
where
not exists(ifexpr.getThen())
not exists(ifexpr.getThen())
select ifexpr, "This 'if' expression is redundant."
LGTM checks whether your query compiles and, if all is well, the **Run** button changes to green to indicate that you can go ahead and run the query.
.. include:: ../reusables/vs-code-basic-instructions/run-quick-query-2.rst
#. Click **Run**.
.. image:: ../images/codeql-for-visual-studio-code/basic-ruby-query-results-1.png
:align: center
The name of the project you are querying, and the ID of the most recently analyzed commit to the project, are listed below the query box. To the right of this is an icon that indicates the progress of the query operation:
If any matching code is found, click a link in the ``ifexpr`` column to view the ``if`` statement in the code viewer.
.. image:: ../images/query-progress.png
:align: center
.. image:: ../images/codeql-for-visual-studio-code/basic-ruby-query-results-2.png
:align: center
.. pull-quote::
Note
Your query is always run against the most recently analyzed commit to the selected project.
The query will take a few moments to return results. When the query completes, the results are displayed below the project name. The query results are listed in two columns, corresponding to the two expressions in the ``select`` clause of the query. The first column corresponds to the expression ``ifexpr`` and is linked to the location in the source code of the project where ``ifexpr`` occurs. The second column is the alert message.
➤ `Example query results <https://lgtm.com/query/4416853782037269427/>`__
.. pull-quote::
Note
An ellipsis (…) at the bottom of the table indicates that the entire list is not displayed—click it to show more results.
#. If any matching code is found, click a link in the ``ifexpr`` column to view the ``if`` statement in the code viewer.
The matching ``if`` expression is highlighted with a yellow background in the code viewer. If any code in the file also matches a query from the standard query library for that language, you will see a red alert message at the appropriate point within the code.
.. include:: ../reusables/vs-code-basic-instructions/note-store-quick-query.rst
About the query structure
~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -131,14 +104,24 @@ To exclude ``if`` statements that have an ``else`` branch:
not exists(ifexpr.getThen()) and
not exists(ifexpr.getElse())
#. Click **Run**.
#. Re-run the query.
There are now fewer results because ``if`` expressions with an ``else`` branch are no longer included.
➤ `See this in the query console <https://lgtm.com/query/4694253275631320752/>`__
Further reading
---------------
.. include:: ../reusables/ruby-further-reading.rst
.. include:: ../reusables/codeql-ref-tools-further-reading.rst
.. Article-specific substitutions for the reusables used in docs/codeql/reusables/vs-code-basic-instructions
.. |language-text| replace:: Ruby
.. |language-code| replace:: ``ruby``
.. |example-url| replace:: https://github.com/discourse/discourse
.. |image-quick-query| image:: ../images/codeql-for-visual-studio-code/quick-query-tab-ruby.png
.. |result-col-1| replace:: The first column corresponds to the expression ``ifexpr`` and is linked to the location in the source code of the project where ``ifexpr`` occurs.