Betterez Style Guide

Javascript (ESLint)

Based on Airbnb style guide (base) eslint package.

Guide: https://github.com/airbnb/javascript

The rules were copied from version 13.1.0 of eslint-config-airbnb-base.

Usage for eslint JS

Install eslint, @eslint/js, eslint-plugin-mocha and eslint-config-btrz-baseusing npm as dev dependencies.

Please do not add custom rules to your project. Just contribute with a change, prior discussing any issues you find :)

Default config file should ne named. eslint.config.mjs

Contents for Apis

import globals from "globals";
import mochaPlugin from "eslint-plugin-mocha";
import pluginJs from "@eslint/js";
import btrz from "eslint-config-btrz-base";

export default [
  {files: ["**/*.js"], languageOptions: {sourceType: "commonjs"}},
  {languageOptions: {globals: globals.node}},
  pluginJs.configs.all,
  mochaPlugin.configs.flat.recommended,
  btrz.configs.all
];

Elixir (credo)

The elixir projects in Betterez use the credo tool for code analysis.

Add it to your project

Add :btrz_credo_style as a dependency to your project's mix.exs.

defp deps do
  [{:btrz_credo_style, "~> 0.1", only: [:dev, :test]}]
end

Run mix credo once installed.

Edit rules

1. To edit the credo rules edit packages/elixir/btrz-credo-style/.credo.exs.
2. Update the mix.exs version
3. add/commit/push!

vscode

You can install ElixirLinter and will automatically check your code.

IDEs

IntelliJ Webstorm config

The style config enforces IDE behaviour to be consistent with the linter.

Usage

Go to File -> Settings -> Editor -> Code Style. On the gear icon, select Import Scheme -> IntelliJ IDEA code style XML. Select the file webstorm-code-style.xml inside the ide directory.

Contribute

Contributions are welcome, but if you are willing to override a rule, please discuss it with others first :)