cli.test.js.snap

// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`CLI --help 1`] = `
"
  A mighty, modern CSS linter.

  Usage: stylelint [input] [options]

  Input: Files(s), glob(s), or nothing to use stdin.

    If an input argument is wrapped in quotation marks, it will be passed to
    globby for cross-platform glob support. node_modules are always ignored.
    You can also pass no input and use stdin, instead.

  Options:

    --config

      Path to a specific configuration file (JSON, YAML, or CommonJS), or the
      name of a module in node_modules that points to one. If no --config
      argument is provided, stylelint will search for configuration files in
      the following places, in this order:
        - a stylelint property in package.json
        - a .stylelintrc file (with or without filename extension:
          .json, .yaml, .yml, and .js are available)
        - a stylelint.config.js file exporting a JS object
      The search will begin in the working directory and move up the directory
      tree until a configuration file is found.

    --config-basedir

      An absolute path to the directory that relative paths defining \\"extends\\",
      \\"plugins\\", and \\"customSyntax\\" are *relative to*. Only necessary if these
      values are relative paths.

    --print-config

      Print the configuration for the given path.

    --ignore-path, -i

      Path to a file containing patterns that describe files to ignore. The
      path can be absolute or relative to process.cwd(). You can repeat the
      option to provide multiple paths. By default, Stylelint looks for
      .stylelintignore in process.cwd().

    --ignore-pattern, --ip

      Pattern of files to ignore (in addition to those in .stylelintignore)

    --fix

      Automatically fix problems of certain rules.

    --custom-syntax

      Module name or path to a JS file exporting a PostCSS-compatible syntax.

    --stdin

      Accept stdin input even if it is empty.

    --stdin-filename

      A filename to assign stdin input.

    --ignore-disables, --id

      Ignore stylelint-disable comments.

    --disable-default-ignores, --di

      Allow linting of node_modules.

    --cache                       [default: false]

      Store the info about processed files in order to only operate on the
      changed ones the next time you run stylelint. By default, the cache
      is stored in \\"./.stylelintcache\\". To adjust this, use --cache-location.

    --cache-location              [default: '.stylelintcache']

      Path to a file or directory to be used for the cache location.
      Default is \\"./.stylelintcache\\". If a directory is specified, a cache
      file will be created inside the specified folder, with a name derived
      from a hash of the current working directory.

      If the directory for the cache does not exist, make sure you add a trailing \\"/\\"
      on *nix systems or \\"\\\\\\" on Windows. Otherwise the path will be assumed to be a file.

    --cache-strategy              [default: \\"metadata\\"]

      Strategy for the cache to use for detecting changed files. Can be either
      \\"metadata\\" or \\"content\\".

      The \\"content\\" strategy can be useful in cases where the modification time of
      your files changes even if their contents have not. For example, this can happen
      during git operations like \\"git clone\\" because git does not track file modification
      time.

    --formatter, -f               [default: \\"string\\"]

      The output formatter: \\"compact\\", \\"github\\", \\"json\\", \\"string\\", \\"tap\\", \\"unix\\" or \\"verbose\\".

    --custom-formatter

      Path to a JS file exporting a custom formatting function.
      The file can either be a filesystem path, a module name, or a file to load from a dependency.

    --quiet, -q

      Only register problems for rules with an \\"error\\"-level severity (ignore
      \\"warning\\"-level).

    --color
    --no-color

      Force enabling/disabling of color.

    --report-needless-disables, --rd

      Also report errors for stylelint-disable comments that are not blocking a lint warning.
      The process will exit with code 2 if needless disables are found.

    --report-invalid-scope-disables, --risd

      Report stylelint-disable comments that used for rules that don't exist within the configuration object.
      The process will exit with code 2 if invalid scope disables are found.

    --report-descriptionless-disables, --rdd

      Report stylelint-disable comments without a description.
      The process will exit with code 2 if descriptionless disables are found.

    --max-warnings, --mw

      Number of warnings above which the process will exit with code 2.
      Useful when setting \\"defaultSeverity\\" to \\"warning\\" and expecting the
      process to fail on warnings (e.g. CI build).

    --output-file, -o

      Path of file to write report.

    --version, -v

      Show the currently installed version of stylelint.

    --allow-empty-input, --aei

      When glob pattern matches no files, the process will exit without throwing an error.

    --globby-options, --go

      Options in JSON format passed to globby.
"
`;