eksperimental
ed5671b4f8
This is a large commit that does the following: * Removes backticks from messages and comments. All references to backticks have been replaced with double quotes everywhere the code is not interpreted as Markdown, (ie. anywhere outside documentation and markdown files, such as in code comments, or error messages). * Variables in Exception messages are printed using `inspect` The way no-matching error message are printed, have changed because now we use inspect for printing variables. The following file and their respective test have been changed: - lib/elixir/lib/exception.ex - lib/elixir/lib/inspect/algebra.ex - lib/elixir/test/elixir/inspect_test.exs - lib/ex_unit/test/ex_unit/formatter_test.exs - lib/elixir/test/elixir/exception_test.exs * Properly use Title Case for Mix, Git, Dializer * Use backticks when citing a command **************************************************** CONVENTION FOR RENAMING USING BACKTICKS AND QUOTES https://github.com/elixir-lang/elixir/pull/3697#issuecomment-138811747 1. Backticks should never be printed in error messages, neither be included anywhere where Markdown code is not interpreted as such. 2. Do not use single quotes anywhere. We should favor double quotes everywhere, to avoid confusion 3. If you want to format something in error messages, use inspect. For example, if you want to show the dependency name and that is an atom, instead of the dependency "foo", let's show the dependency :foo. Less noise and may click better 4. Similarly, if you want to show something with double quotes, call inspect, as it handles escaping as well as the quotes 5. Things like "--all" just add verbosity, we can definitely read --all without ambiguity. 6. When using switches with a single hyphen (such as "-o"), we can make it explicit in the text: e.g. "... give the switch -o when choosing ..." **************************************************** SHELL COMMANDS TO DETECT CODE BREAKING THE RULES * Detect values surrounded by single-quotes where we want double-quotes. # regular variables ag "'#{" # constants or ENV variables ag "'[A-Z][A-Z0-9_-]+" # switches ag -i "(?<!(\[))'--?[a-z0-9][a-z0-9_-]+'" # atoms ag -i "(?<!(\[))':[a-z0-9][a-z0-9_-]+'" # DETECT BACKTICKS OUTSIDE DOCS ag "^\s+(?<!(#))#[^#\r\n]*\`" --ignore "*.md" ag '^\s+["%].*`' --ignore "*.md" ag -s '(raise|Error)\b(?!(`|/)).*\`' * Spot mentions to running a command that is not using backticks: commands="elixir|elixirc|mix|iex|ex_doc|git|make|rebar|dialyzer|erl|rm|cd|mkdir|rmdir|ln|ls|pwd" actions="runs?|running|executes?|executing|types?|typing|enters?|entering|calls?|calling" ag '(?i)('${actions}')(?-i)\b[^`\r\n/]+[\ \t]+(?!(`))('${commands}')' ag '(?-i)\b(?!(`))('${commands}')[\ \t]+[^`\r\n/]+(?i)(commands?)' * Spot where a command is mentioned: #commands="erlang|elixir|eex|iex|ex_unit|ex_doc|logger|elixirc|git|make|rebar|dialyzer|erl|rm|cd|mkdir|rmdir|ln|ls|pwd" commands="mix|elixirc|git|make|rebar|dialyzer|erl|rm|cd|mkdir|rmdir|ln|ls|pwd" ag -s '(?<!(\`))(?<!(\.))(?<!(/))(?<!(:))(?<!(_))\b('${commands}')\b(?!(:))(?!(\?))(?!(_))(?!(-))(?!(\.))(?!(\`))(?!(/))(?!(>))' \ --ignore "*.erl" --ignore "*.yrl" --ignore "*.src"
2.8 KiB
For more about Elixir, installation and documentation, check Elixir's website.
Usage
If you want to contribute to Elixir or run it from source, clone this repository to your machine, compile and test it:
git clone https://github.com/elixir-lang/elixir.git
cd elixir
make clean test
Note: if you are running on Windows, this article includes important notes for compiling Elixir from source on Windows.
If Elixir fails to build (specifically when pulling in a new version via git), be sure to remove any previous build artifacts by running make clean, then make test.
If tests pass, you are ready to move on to the Getting Started guide or to try Interactive Elixir by running: bin/iex in your terminal.
However, if tests fail, it is likely you have an outdated Erlang version (Elixir requires Erlang 17.0 or later). You can check your Erlang version by calling erl in the command line. You will see some information as follows:
Erlang/OTP 17 [erts-6.0] [source-07b8f44] [64-bit] [smp:4:4] [async-threads:10] [hipe] [kernel-poll:false]
If you have the correct version and tests still fail, feel free to open an issue.
Building documentation
Building the documentation requires ExDoc to be installed and built in the same containing folder as Elixir.
# After cloning and compiling Elixir
git clone git://github.com/elixir-lang/ex_doc.git
cd ex_doc && ../elixir/bin/mix do deps.get, compile
cd ../elixir && make docs
Contributing
We appreciate any contribution to Elixir, so check out our CONTRIBUTING.md guide for more information. We usually keep a list of features and bugs in the issue tracker.
Important links
-
#elixir-lang on Freenode IRC
License
"Elixir" and the Elixir logo are copyright (c) 2012 Plataformatec.
Elixir source code is released under Apache 2 License with some parts under Erlang's license (EPL).