Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(config): provide CLI options via a configuration file #226

Open
11 tasks
gregswindle opened this issue Feb 18, 2018 · 0 comments
Open
11 tasks

feat(config): provide CLI options via a configuration file #226

gregswindle opened this issue Feb 18, 2018 · 0 comments

Comments

@gregswindle
Copy link
Owner

User story

As an API producer and consumer,
I want to declare and store eslint-plugin-crc report options in a configuration
In order to commit standards to version control.

Acceptance criteria

  • 1. All eslint-plugin-crc (alias crc) command-line Options can be serialized as:

  • 1.1. JSON

    {
      "crc/report-output": "/path/to/crc-report.md",
      "crc/report-title": {
        "custom": "Super CRC Model Report",
        "usePackageName": false
      }
    }
  • 1.2. YAML

    ---
    crc/report-output: "/path/to/crc-report.md"
    crc/report-title:
      custom: Super CRC Model Report
      usePackageName: false
    
  • 1.3. JavaScript

    module.exports = {
      "crc/report-output": "/path/to/crc-report.md",
      "crc/report-title": {
        "custom": null,
        "usePackageName": true
      }
    }
  • 2. crc/report-* options can be stored within all ESLint Configuration file formats:

  • 2.1. .eslintrc.js

  • 2.2. .eslintrc.yaml

  • 2.3. .eslintrc.yml

  • 2.4. .eslintrc.json

  • 2.5. package.json

  • 4. {criterion-four}

⚡ Rule developers must use the eslint:rule subgenerator!

When you create a new rule, be sure to use the eslint:rule subgenerator, since it will

  1. Create a stubbed rule,
  2. The rule's stubbed BDD specs,
  3. As well as the rule's documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant