stricter-plugin-tangerine

stricter-plugin-tangerine

A set of Stricter rules developed by Atlassian as part of Tangerine 🍊.

Installation

Install Stricter locally or globally:

$ yarn add --dev stricter

If you've installed Stricter globally, you'll have to install the Tangerine plugin globally too. Otherwise, install it locally:

$ yarn add --dev stricter-plugin-tangerine

Configuration

Specify tangerine in the plugins field of your stricter.config.js file:

  // stricter.config.js
module.exports = {
  plugins: ['tangerine'],
  ...
}

You can then explicitly enable and configure the tangerine rules:

  // stricter.config.js
module.exports = {
  plugins: ['tangerine'],
  rules: {
    'tangerine/project-structure': {
      level: 'error',
      config: { ... },
    }
  }
}

Rules

• Enforce a specific file structure for your project (project-structure)

Contributing

All rules are located in separate directories, in the corresponding rules/<ruleCategory> directory. The rule's name must be identical to its directory name.

Every rule must contain:

• index.js - The rule's implementation, following this template.
• README.md - The rule's documentation, following this template.
• test.js - The rule's tests, following this template.

After adding a new rule, run node generate-readme.js to add a link to the frontpage README.md file.

All rules are exposed automatically.

To change this file, edit template instead, then run node generate-readme.js