Skip to content

Commit

Permalink
Publish website 2a30aca
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed May 1, 2024
1 parent 2a30aca commit b67af57
Show file tree
Hide file tree
Showing 32 changed files with 5,134 additions and 0 deletions.
178 changes: 178 additions & 0 deletions docs/CODE_OF_CONDUCT_md.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,178 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">

<title>RDoc Documentation</title>

<script type="text/javascript">
var rdoc_rel_prefix = "./";
var index_rel_prefix = "./";
</script>

<script src="./js/search_index.js" defer></script>
<script src="./js/snapper.js" defer></script>
<link href="./css/snapper.css" rel="stylesheet">
</head>

<body>
<div id="main-container">
<nav id="nav">
<h3 class="title">RDoc Documentation</h3>

<input id="side-search" type="text" placeholder="Search docs (CMD/CTRL + K)"></input>

<ul id="navigation-list">
<li id="getting-started"><a href="./index.html">Getting started</a></li>
<p class="separator">PAGES</p>
<li class="index-entry">
<a href="./CODE_OF_CONDUCT_md.html">
CODE_OF_CONDUCT
</a>
</li>
<li class="index-entry">
<a href="./README_md.html">
README
</a>
</li>

<p class="separator">CODE</p>
<li class="expandable-index-entry">
<details>
<summary><a href="./RubyLsp.html">RubyLsp</a></summary>
<ul>
<li class="expandable-index-entry">
<details>
<summary><a href="./RubyLsp/Rails.html">Rails</a></summary>
<ul>
<li class="index-entry"><a href="./RubyLsp/Rails/ActiveSupportTestCaseHelper.html">ActiveSupportTestCaseHelper</a></li><li class="index-entry"><a href="./RubyLsp/Rails/Addon.html">Addon</a></li><li class="index-entry"><a href="./RubyLsp/Rails/CodeLens.html">CodeLens</a></li><li class="index-entry"><a href="./RubyLsp/Rails/Definition.html">Definition</a></li><li class="index-entry"><a href="./RubyLsp/Rails/DocumentSymbol.html">DocumentSymbol</a></li><li class="index-entry"><a href="./RubyLsp/Rails/Hover.html">Hover</a></li><li class="index-entry"><a href="./RubyLsp/Rails/NullClient.html">NullClient</a></li><li class="index-entry"><a href="./RubyLsp/Rails/Railtie.html">Railtie</a></li><li class="expandable-index-entry">
<details>
<summary><a href="./RubyLsp/Rails/RunnerClient.html">RunnerClient</a></summary>
<ul>
<li class="index-entry"><a href="./RubyLsp/Rails/RunnerClient/EmptyMessageError.html">EmptyMessageError</a></li><li class="index-entry"><a href="./RubyLsp/Rails/RunnerClient/IncompleteMessageError.html">IncompleteMessageError</a></li><li class="index-entry"><a href="./RubyLsp/Rails/RunnerClient/InitializationError.html">InitializationError</a></li>
</ul>
</details>
</li>
<li class="index-entry"><a href="./RubyLsp/Rails/Server.html">Server</a></li><li class="expandable-index-entry">
<details>
<summary><a href="./RubyLsp/Rails/Support.html">Support</a></summary>
<ul>
<li class="index-entry"><a href="./RubyLsp/Rails/Support/Callbacks.html">Callbacks</a></li><li class="index-entry"><a href="./RubyLsp/Rails/Support/RailsDocumentClient.html">RailsDocumentClient</a></li>
</ul>
</details>
</li>

</ul>
</details>
</li>

</ul>
</details>
</li>

</ul>
</nav>

<article>
<h1 id="label-Contributor+Covenant+Code+of+Conduct">Contributor Covenant Code of Conduct<span><a href="#label-Contributor+Covenant+Code+of+Conduct">&para;</a> <a href="#top">&uarr;</a></span></h1>

<h2 id="label-Our+Pledge">Our Pledge<span><a href="#label-Our+Pledge">&para;</a> <a href="#top">&uarr;</a></span></h2>

<p>In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.</p>

<h2 id="label-Our+Standards">Our Standards<span><a href="#label-Our+Standards">&para;</a> <a href="#top">&uarr;</a></span></h2>

<p>Examples of behavior that contributes to creating a positive environment include:</p>
<ul><li>
<p>Using welcoming and inclusive language</p>
</li><li>
<p>Being respectful of differing viewpoints and experiences</p>
</li><li>
<p>Gracefully accepting constructive criticism</p>
</li><li>
<p>Focusing on what is best for the community</p>
</li><li>
<p>Showing empathy towards other community members</p>
</li></ul>

<p>Examples of unacceptable behavior by participants include:</p>
<ul><li>
<p>The use of sexualized language or imagery and unwelcome sexual attention or advances</p>
</li><li>
<p>Trolling, insulting/derogatory comments, and personal or political attacks</p>
</li><li>
<p>Public or private harassment</p>
</li><li>
<p>Publishing others’ private information, such as a physical or electronic address, without explicit permission</p>
</li><li>
<p>Other conduct which could reasonably be considered inappropriate in a professional setting</p>
</li></ul>

<h2 id="label-Our+Responsibilities">Our Responsibilities<span><a href="#label-Our+Responsibilities">&para;</a> <a href="#top">&uarr;</a></span></h2>

<p>Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.</p>

<p>Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.</p>

<h2 id="label-Scope">Scope<span><a href="#label-Scope">&para;</a> <a href="#top">&uarr;</a></span></h2>

<p>This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.</p>

<h2 id="label-Enforcement">Enforcement<span><a href="#label-Enforcement">&para;</a> <a href="#top">&uarr;</a></span></h2>

<p>Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.</p>

<p>Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.</p>

<h2 id="label-Attribution">Attribution<span><a href="#label-Attribution">&para;</a> <a href="#top">&uarr;</a></span></h2>

<p>This Code of Conduct is adapted from the <a href="https://www.contributor-covenant.org">Contributor Covenant</a>, version 1.4, available at <a href="https://www.contributor-covenant.org/version/1/4/code-of-conduct.html">www.contributor-covenant.org/version/1/4/code-of-conduct.html</a></p>

<p>For answers to common questions about this code of conduct, see <a href="https://www.contributor-covenant.org/faq">www.contributor-covenant.org/faq</a></p>
</article>
<div class="right-section">
<nav class="right-nav">
<span id="right-side-bar-title" class="right-side-bar-title">On this page</span>
<ul>
<li> <a href=#>CODE_OF_CONDUCT.md</a></li>

<div class="nav-section">

<ul class="link-list" role="directory">
<li>
<details open>
<summary> <a href="#label-Contributor+Covenant+Code+of+Conduct">Contributor Covenant Code of Conduct</a>
</summary>
<ul class="link-list" role="directory">
<li> <a href="#label-Our+Pledge">Our Pledge</a>
<li> <a href="#label-Our+Standards">Our Standards</a>
<li> <a href="#label-Our+Responsibilities">Our Responsibilities</a>
<li> <a href="#label-Scope">Scope</a>
<li> <a href="#label-Enforcement">Enforcement</a>
<li> <a href="#label-Attribution">Attribution</a>

</ul>
</details>
</li>

</ul>
</div>
</nav>
</div>

</div>

<div id="search-modal">
<div id="search-modal-content">
<input id="search-modal-input" type="text" placeholder="Search"></input>
<ul id="search-results"></ul>
</div>
</div>


<footer>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.3.1
</footer>
</body>
</html>
21 changes: 21 additions & 0 deletions docs/LICENSE.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2023-present, Shopify Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
166 changes: 166 additions & 0 deletions docs/README_md.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">

<title>RDoc Documentation</title>

<script type="text/javascript">
var rdoc_rel_prefix = "./";
var index_rel_prefix = "./";
</script>

<script src="./js/search_index.js" defer></script>
<script src="./js/snapper.js" defer></script>
<link href="./css/snapper.css" rel="stylesheet">
</head>

<body>
<div id="main-container">
<nav id="nav">
<h3 class="title">RDoc Documentation</h3>

<input id="side-search" type="text" placeholder="Search docs (CMD/CTRL + K)"></input>

<ul id="navigation-list">
<li id="getting-started"><a href="./index.html">Getting started</a></li>
<p class="separator">PAGES</p>
<li class="index-entry">
<a href="./CODE_OF_CONDUCT_md.html">
CODE_OF_CONDUCT
</a>
</li>
<li class="index-entry">
<a href="./README_md.html">
README
</a>
</li>

<p class="separator">CODE</p>
<li class="expandable-index-entry">
<details>
<summary><a href="./RubyLsp.html">RubyLsp</a></summary>
<ul>
<li class="expandable-index-entry">
<details>
<summary><a href="./RubyLsp/Rails.html">Rails</a></summary>
<ul>
<li class="index-entry"><a href="./RubyLsp/Rails/ActiveSupportTestCaseHelper.html">ActiveSupportTestCaseHelper</a></li><li class="index-entry"><a href="./RubyLsp/Rails/Addon.html">Addon</a></li><li class="index-entry"><a href="./RubyLsp/Rails/CodeLens.html">CodeLens</a></li><li class="index-entry"><a href="./RubyLsp/Rails/Definition.html">Definition</a></li><li class="index-entry"><a href="./RubyLsp/Rails/DocumentSymbol.html">DocumentSymbol</a></li><li class="index-entry"><a href="./RubyLsp/Rails/Hover.html">Hover</a></li><li class="index-entry"><a href="./RubyLsp/Rails/NullClient.html">NullClient</a></li><li class="index-entry"><a href="./RubyLsp/Rails/Railtie.html">Railtie</a></li><li class="expandable-index-entry">
<details>
<summary><a href="./RubyLsp/Rails/RunnerClient.html">RunnerClient</a></summary>
<ul>
<li class="index-entry"><a href="./RubyLsp/Rails/RunnerClient/EmptyMessageError.html">EmptyMessageError</a></li><li class="index-entry"><a href="./RubyLsp/Rails/RunnerClient/IncompleteMessageError.html">IncompleteMessageError</a></li><li class="index-entry"><a href="./RubyLsp/Rails/RunnerClient/InitializationError.html">InitializationError</a></li>
</ul>
</details>
</li>
<li class="index-entry"><a href="./RubyLsp/Rails/Server.html">Server</a></li><li class="expandable-index-entry">
<details>
<summary><a href="./RubyLsp/Rails/Support.html">Support</a></summary>
<ul>
<li class="index-entry"><a href="./RubyLsp/Rails/Support/Callbacks.html">Callbacks</a></li><li class="index-entry"><a href="./RubyLsp/Rails/Support/RailsDocumentClient.html">RailsDocumentClient</a></li>
</ul>
</details>
</li>

</ul>
</details>
</li>

</ul>
</details>
</li>

</ul>
</nav>

<article>
<h1 id="label-Ruby+LSP+Rails">Ruby LSP Rails<span><a href="#label-Ruby+LSP+Rails">&para;</a> <a href="#top">&uarr;</a></span></h1>

<p>Ruby LSP Rails is a <a href="https://github.com/Shopify/ruby-lsp">Ruby LSP</a> addon for extra Rails editor features, such as:</p>
<ul><li>
<p>Hover over an ActiveRecord model to reveal its schema.</p>
</li><li>
<p>Run or debug a test by clicking on the code lens which appears above the test class, or an individual test.</p>
</li><li>
<p>Navigate to associations, validations, callbacks and test cases using your editor’s “Go to Symbol” feature, or outline view.</p>
</li><li>
<p>Jump to the definition of callbacks using your editor’s “Go to Definition” feature.</p>
</li><li>
<p>Jump to the declaration of a route.</p>
</li></ul>

<h2 id="label-Installation">Installation<span><a href="#label-Installation">&para;</a> <a href="#top">&uarr;</a></span></h2>

<p>If you haven’t already done so, you’ll need to first <a href="https://github.com/Shopify/ruby-lsp#usage">set up Ruby LSP</a>.</p>

<p>As of v0.3.0, Ruby LSP will automatically include the Ruby LSP Rails addon in its custom bundle when a Rails app is detected. There is no need to add the gem to your bundle.</p>

<h2 id="label-Documentation">Documentation<span><a href="#label-Documentation">&para;</a> <a href="#top">&uarr;</a></span></h2>

<p>See the <a href="https://shopify.github.io/ruby-lsp-rails">documentation</a> for more in-depth details about the <a href="https://shopify.github.io/ruby-lsp-rails/RubyLsp/Rails.html">supported features</a>.</p>

<h2 id="label-How+Runtime+Introspection+Works">How Runtime Introspection Works<span><a href="#label-How+Runtime+Introspection+Works">&para;</a> <a href="#top">&uarr;</a></span></h2>

<p>LSP tooling is typically based on static analysis, but <code>ruby-lsp-rails</code> actually communicates with your Rails app for some features.</p>

<p>When Ruby LSP Rails starts, it spawns a <code>rails runner</code> instance which runs {<code>server.rb</code><a href="https://github.com/Shopify/ruby-lsp-rails/blob/main/lib/ruby_lsp/ruby_lsp_rails/server.rb">}</a>. The addon communicates with this process over a pipe (i.e. <code>stdin</code> and <code>stdout</code>) to fetch runtime information about the application.</p>

<p>When extension is stopped (e.g. by quitting the editor), the server instance is shut down.</p>

<blockquote>
<p>[!NOTE] Prior to v0.3.0, <code>ruby-lsp-rails</code> used a different approach which involved mounting a Rack application within the Rails app. That approach was brittle and susceptible to the application’s configuration, such as routing and middleware.</p>
</blockquote>

<h2 id="label-Contributing">Contributing<span><a href="#label-Contributing">&para;</a> <a href="#top">&uarr;</a></span></h2>

<p>Bug reports and pull requests are welcome on GitHub at <a href="https://github.com/Shopify/ruby-lsp-rails">github.com/Shopify/ruby-lsp-rails</a>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the <a href="https://github.com/Shopify/ruby-lsp-rails/blob/main/CODE_OF_CONDUCT.md">Contributor Covenant</a> code of conduct.</p>

<h2 id="label-License">License<span><a href="#label-License">&para;</a> <a href="#top">&uarr;</a></span></h2>

<p>The gem is available as open source under the terms of the <a href="https://github.com/Shopify/ruby-lsp-rails/blob/main/LICENSE.txt">MIT License</a>.</p>
</article>
<div class="right-section">
<nav class="right-nav">
<span id="right-side-bar-title" class="right-side-bar-title">On this page</span>
<ul>
<li> <a href=#>README.md</a></li>

<div class="nav-section">

<ul class="link-list" role="directory">
<li>
<details open>
<summary> <a href="#label-Ruby+LSP+Rails">Ruby LSP Rails</a>
</summary>
<ul class="link-list" role="directory">
<li> <a href="#label-Installation">Installation</a>
<li> <a href="#label-Documentation">Documentation</a>
<li> <a href="#label-How+Runtime+Introspection+Works">How Runtime Introspection Works</a>
<li> <a href="#label-Contributing">Contributing</a>
<li> <a href="#label-License">License</a>

</ul>
</details>
</li>

</ul>
</div>
</nav>
</div>

</div>

<div id="search-modal">
<div id="search-modal-content">
<input id="search-modal-input" type="text" placeholder="Search"></input>
<ul id="search-results"></ul>
</div>
</div>


<footer>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.3.1
</footer>
</body>
</html>
Loading

0 comments on commit b67af57

Please sign in to comment.