Vscode-spell-checker: Support for Ruby

[zdrummond]

Thanks for the great extension. Its been invaluable while writing JS.

Any chance support for more languages will be added, like Ruby?

[Jason3S]

Yes, it would be great to support Ruby!

The basic thing needed is a list of keyword. See: cSpell Dictionaries. Python is a great example.

I try to include most of the programming languages into the spelling extension by default.

[zdrummond]

So to be clear; if we can come up with an equivalent ruby keyword list, like the python.txthttps://github.com/Jason3S/cspell-dicts/blob/master/python/python.txt list, then we can get it working on Ruby files?

[Jason-Rev]

Yes. Do a pull request with a list of keywords and common library names and
functions, we can create support for Ruby.

On Tue, 23 Jan 2018 at 07:19, Zachary Drummond [e-mail]
wrote:

So to be clear; if we can come up with an equivalent ruby keyword list,
like the python.txt<
https://github.com/Jason3S/cspell-dicts/blob/master/python/python.txt>
list, then we can get it working on Ruby files?

On Jan 19, 2018, 12:00 AM -0800, Jason Dent [e-mail],
wrote:

Yes, it would be great to support Ruby!

The basic thing needed is a list of keyword. See: cSpell Dictionaries<
https://github.com/Jason3S/cspell-dicts>. Python is a great example.

I try to include most of the programming languages into the spelling
extension by default.

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub<
https://github.com/Jason-Rev/vscode-spell-checker/issues/171#issuecomment-358893160>,
or mute the thread<
https://github.com/notifications/unsubscribe-auth/ABjVh_s2kp9bbBjeUcLx9lSXPVjQxetLks5tMEuVgaJpZM4RgMJ6>.

—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
https://github.com/Jason-Rev/vscode-spell-checker/issues/171#issuecomment-359688053,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AEoDjfUItVAozH3kGjZXuJZ1CH6533Xxks5tNXoKgaJpZM4RgMJ6
.

[lawnchamp]

@Jason-Rev Do you know if there is any progress on this? I might work on this if no one else is.

[Jason3S]

@rjshenk That would be wonderful!
Please see: streetsidesoftware/cspell-dicts: How to create a new dictionary

[zdrummond]

@Jason-Rev I never got a chance to work on it. I might be able to throw something together when I have some time off in a couple of weeks, but if you have a chance, go for it!

[lawnchamp]

This python.txt file is what needs to be made for ruby right? https://github.com/streetsidesoftware/cspell-dicts/blob/master/packages/python/python.txt

Ruby keywords could come from here? https://docs.ruby-lang.org/en/2.2.0/keywords_rdoc.html
Ruby popular gem names could come from here? https://rubygems.org/stats

[Jason3S]

@rjshenk yes, that is the idea.

[dalinhuang99]

@Jason3S Hey Jason 👋
I got a list of ruby and ruby on rails keywords here, and I will try to add it to cspell-dicts.

__ENCODING__
__LINE__
__FILE__
BEGIN
END
alias
and
begin
break
case
class
def
defined?
do
else
elsif
end
ensure
false
for
if
in
module
next
nil
not
or
redo
rescue
retry
return
self
super
then
true
undef
unless
until
when
while
yield
action
ActionController
ActionView
ActiveRecord
ADDITIONAL_LOAD_PATHS
application
ARGF
ArgumentError
ARGV
Array
asset
association
Attachment
attributes
@base_path
BasicSocket
Benchmark
Bignum
Binding
Block
Callback
Case
CGI
CGIMethods
Class
ClassInheritableAttributes
Comparable
ConditionVariable
Config
Configuration
connection
Continuation
CROSS_COMPILING
Data
Date
DateTime
Delegater
Delegator
Device
Digest
Dir
dispatcher
display
DomainName
DRb
DRbIdConv
DRbObject
DRbUndumped
Enumerable
ENV
EOFError
ERB
Errno
Exception
FALSE
FalseClass
Fcntl
Fiber
File
FileList
FileTask
FileTest
FileUtils
Fixnum
Float
FloatDomainError
format
frozen
GC
Gem
GetoptLong
Hash
hidden
image
IndexError
Inflector
Integer
Interrupt
invalid
invalid?
IO
IOError
IPSocket
Kernel
key
kind
LN_SUPPORTED
load
LoadError
LocalJumpError
location
Logger
Mail
Marshal
MatchData
MatchingData
Math
Method
model_name
Module
Monitor
Mutex
Mysql
MysqlError
MysqlField
MysqlRes
NameError
NIL
NilClass
NoMemoryError
NoMethodError
notify
NotImplementedError
NoWrite
Numeric
Object
object_id
ObjectSpace
Observable
Observer
open
OPT_TABLE
params
ParseDate
PGconn
PGError
PGlarge
PGresult
PLATFORM
Precision
Proc
Process
PStore
Queue
quote
Rake
RakeApp
RakeFileUtils
RAKEVERSION
Range
RangeError
Rational
readonly
Record
records
Regexp
RegexpError
RELEASE_DATE
request
Request
responses
RUBY
RUBY_PLATFORM
RUBY_RELEASE_DATE
RUBY_VERSION
RuntimeError
sad asdasd
ScanError
scope
ScriptError
SecurityError
send
session
Signal
SignalException
SimpleDelegater
SimpleDelegator
Singleton
SizedQueue
Socket
SocketError
Source
StandardError
STDERR
STDIN
STDOUT
String
StringScanner
Struct
Sweeper
Symbol
SyntaxError
system
SystemCallError
SystemExit
SystemStackError
target
Task
TCPServer
TCPSocket
template
Template
test
Text
Thread
ThreadError
ThreadGroup
Time
timeout
TOPLEVEL_BINDING
to_s
touch
Transaction
true
TRUE
TrueClass
type
TypeError
Type (namespaced)
UDPSocket
UnboundMethod
UNIXServer
UNIXSocket
URI
Url
Verbose
VERSION
YAML
ZeroDivisionError

[d2s]

Latest Ruby documentation is located at:
https://ruby-doc.com/core/doc/keywords_rdoc.html

Besides of those keywords, the _Class Index_ list (on the sidebar of the documentation) could be copy-pasted to the list of words in the dictionary. Though I'm rather sure there could exist more automated way to parsing the documentation structure (as it would be more maintainable in the long run).

Each of the core Ruby classes have their own _Methods_ that most likely would be needed to be added to the dictionary later. For example, https://ruby-doc.com/core/Array.html page has list of methods for the class in the left side sidebar. One approach could be to copy-paste those from each of the core documentation pages, or write a script to do that automatically.

If someone has extra time and wants to improve software experience for Ruby programmers out there, this could be a way to do it.