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"
22 lines
674 B
Erlang
22 lines
674 B
Erlang
%% Using Elixir as a rebar dependency
|
|
|
|
%% This configuration file only exists so Elixir can be used
|
|
%% as a rebar dependency, the same happens for the file
|
|
%% src/elixir.app.src.
|
|
|
|
%% In practice, Elixir is structured as OTP where many applications
|
|
%% are placed in the lib directory. Since this structure is not
|
|
%% supported by default by rebar, after adding Elixir as a dependency
|
|
%% you need to explicitly add it to lib_dirs:
|
|
%%
|
|
%% {lib_dirs, [
|
|
%% "deps/elixir/lib"
|
|
%% ]}.
|
|
%%
|
|
|
|
%% Run "make" as the proper compilation step
|
|
{post_hooks, [{compile, "make compile"}]}.
|
|
|
|
%% This prevents rebar_elixir_plugin from recompiling Elixir
|
|
{ex_opts, [{src_dirs, [".PHONY"]}]}.
|