Skip to content

checkoutdated.md

Latest commit

 

History

History
94 lines (65 loc) · 4.39 KB

checkoutdated.md

File metadata and controls

94 lines (65 loc) · 4.39 KB


grunt-check-outdated/options/checkoutdated

options/checkoutdated.js: grunt-check-outdated


grunt-check-outdated/options/checkoutdated.getCheckOutdatedPath(grunt) ⇒ string

Returns the path to the check-outdated

Returns: string - path to check-outdated

Param Type
grunt grunt


grunt-check-outdated/options/checkoutdated.getChkOutdatedOptions() ⇒ object

Returns default settings for basic check-outdated options.

Returns: object - default settings for basic check-outdated options.


grunt-check-outdated/options/checkoutdated.getChkOutdatedIgnoreOptions() ⇒ object

Returns default settings for basic check-outdated ignore options.

Returns: object - default settings for basic check-outdated ignore options.


grunt-check-outdated/options/checkoutdated.getOptions() ⇒ Object

Defines and returns the set of options that is passed to task 'check_outdated'.

Returns: Object - check_outdated default options


grunt-check-outdated/options/checkoutdated.getTaskOptions(task) ⇒ Object

Returns grunt task specific options for 'check_outdated'.

Note:

  • Default options and configuration options have already been merged.
  • Array-valued options (notably checkoutdated.columns) are treated as explicit overrides: If the user specifies an array in the task configuration, it fully replaces the corresponding default array.
  • This behavior is intentional and allows users to precisely control which columns are emitted, without implicit completion or merging.

Returns: Object - 'check_outdated' options for grunt task

Param Type
task grunt.task


grunt-check-outdated/options/checkoutdated.toArgs(grunt, task, [options]) ⇒ Promise.<Object>

Converts grunt task specific options for 'check_outdated' to an array of arguments for the check-outdated CLI.

Note:

  • All values under options.checkoutdated (columns, depth, global, preferwanted, ignore, opts) are passed as-is to the third-party tool checkoutdated.
  • No validation of these values is performed here, because:
    1. Validating columns or other flags would require keeping in sync with checkoutdated versions, which is impractical.
    2. The third-party tool is responsible for handling invalid inputs.
  • Responsibility of toArgs is only to consistently transform the merged task options into CLI arguments for the spawn call.

Returns: Promise.<Object> - resolves with { args, opts }

Param Type Description
grunt grunt
task grunt.task
[options] Object optional pre-merged task options