Skip to content

Best practices

Jump to bottom
Moritz Jacobs edited this page Mar 3, 2020 · 1 revision

under construction 🚧

There are a few best practices that can not be linted programmatically. These will be documented here in the future. Until then, this is the most important advice right now: keep names readable and understandable: the semantics of your namespaces&subcategories is totally up to you, it is still good avdice to keep things readable yet abstract: for example, try to use a dependency's category instead of its' actual name: test:lint instead of test:eslint

  1. Motivation
  2. The scriptlint "standard" tl;dr
  3. The scriptlint "standard"
    1. Rules enforceable via the scriptlint CLI
      1. Minimum rules
        1. mandatory-start
        2. mandatory-dev
        3. mandatory-test
        4. no-default-test
      2. Strict rules
        1. uses-allowed-namespace
        2. alphabetic-order
        3. correct-casing
        4. no-aliases
        5. prepost-trigger-defined
        6. no-unix-double-ampersand
        7. no-unix-single-ampersand
      3. Optional rules
        1. natural-order
    2. Best practices
  4. The scriptlint CLI
    1. Installation
    2. Usage
    3. Configuration
    4. Extending
    5. Use as a JavaScript module
  5. Contributing to scriptlint


scriptlint status
npm version badge
dependency badge
Issue badge
CI badge

Clone this wiki locally