https://github.com/crowdstrike/yargs-help-output

Update docs to include the full output of yargs help

https://github.com/crowdstrike/yargs-help-output

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (5.1%) to scientific vocabulary

Keywords from Contributors

documents zsh-plugin communication export transformation stats
Last synced: 10 months ago · JSON representation

Repository

Update docs to include the full output of yargs help

Basic Info
  • Host: GitHub
  • Owner: CrowdStrike
  • License: mit
  • Language: JavaScript
  • Default Branch: main
  • Size: 302 KB
Statistics
  • Stars: 2
  • Watchers: 3
  • Forks: 4
  • Open Issues: 12
  • Releases: 0
Created over 5 years ago · Last pushed 11 months ago
Metadata Files
Readme Changelog License

README.md

yargs-help-output

npm version

Update docs to include the full output of yargs help

CLI API

``` yargs-help-output

Update docs to include the full output of yargs help

Positionals: input-file-path The file to be updated [string]

Options: --help Show help [boolean] --version Show version number [boolean] --bin-path The yargs entry file if you're running it directly [string] --npm-script-name The NPM script that runs your yargs CLI [string] --replacement-sigil The metadata divider used to find the replacement [string] [default: "<!-- CODEGENCLIHELP -->"] --help-text-modify String/regex replacements to modify the help text (ex --help-text-modify.search "^foo$" --help-text-modify.replacement "") [array] [default: []] ```

JS API

```js let outputString = await updateHelpTextByString({ // required inputString,

// optional replacementSigil = '<!-- CUSTOM_SIGIL -->',

// optional helpTextModifyReplacements: [ [/^Options:$\r?\n/m, ''], ], // and/or helpTextModifyCallback(helpText) { return helpText.replace(/^Options:$\r?\n/m, ''); },

binPath: './my-cli.js', // or npmScriptName: 'start',

// optional cwd, });

await updateHelpTextByFile({ // required inputFilePath,

// optional replacementSigil = '<!-- CUSTOM_SIGIL -->',

// optional helpTextModifyReplacements: [ [/^Options:$\r?\n/m, ''], ], // and/or helpTextModifyCallback(helpText) { return helpText.replace(/^Options:$\r?\n/m, ''); },

binPath: './my-cli.js', // or npmScriptName: 'start',

// optional cwd, }); ```

Owner

  • Name: CrowdStrike
  • Login: CrowdStrike
  • Kind: organization
  • Email: github@crowdstrike.com
  • Location: United States of America

GitHub Events

Total
  • Delete event: 4
  • Push event: 36
  • Pull request event: 11
  • Create event: 6
Last Year
  • Delete event: 4
  • Push event: 36
  • Pull request event: 11
  • Create event: 6

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 92
  • Total Committers: 4
  • Avg Commits per committer: 23.0
  • Development Distribution Score (DDS): 0.587
Past Year
  • Commits: 4
  • Committers: 3
  • Avg Commits per committer: 1.333
  • Development Distribution Score (DDS): 0.5
Top Committers
Name Email Commits
renovate[bot] 2****] 38
Kelly Selden k****n@g****m 32
Renovate Bot b****t@r****m 17
Kelly Selden 6****n 5
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 3
  • Total pull requests: 83
  • Average time to close issues: almost 2 years
  • Average time to close pull requests: about 2 months
  • Total issue authors: 2
  • Total pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.04
  • Merged pull requests: 65
  • Bot issues: 2
  • Bot pull requests: 66
Past Year
  • Issues: 0
  • Pull requests: 7
  • Average time to close issues: N/A
  • Average time to close pull requests: 2 months
  • Issue authors: 0
  • Pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 6
Top Authors
Issue Authors
  • renovate[bot] (2)
  • kellyselden (1)
Pull Request Authors
  • renovate[bot] (79)
  • kellyselden (17)
  • appsec-cs-mp-tester (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • npm 1,470 last-month
  • Total dependent packages: 4
  • Total dependent repositories: 11
  • Total versions: 13
  • Total maintainers: 2
npmjs.org: yargs-help-output

Update docs to include the full output of yargs help

  • Versions: 13
  • Dependent Packages: 4
  • Dependent Repositories: 11
  • Downloads: 1,470 Last month
Rankings
Dependent repos count: 3.5%
Downloads: 4.2%
Dependent packages count: 4.5%
Average: 7.0%
Forks count: 8.2%
Stargazers count: 14.5%
Last synced: 11 months ago

Dependencies

package.json npm
  • @crowdstrike/commitlint ^5.0.0 development
  • chai ^4.3.0 development
  • chai-as-promised ^7.1.1 development
  • chai-fs ^2.0.0 development
  • eslint ^8.0.0 development
  • eslint-config-crowdstrike ^4.0.0 development
  • eslint-config-crowdstrike-node ^3.0.0 development
  • eslint-plugin-json-files ^1.1.0 development
  • eslint-plugin-mocha ^9.0.0 development
  • eslint-plugin-node ^11.1.0 development
  • mocha ^9.0.0 development
  • mocha-helpers ^6.2.1 development
  • remark-cli ^10.0.0 development
  • remark-preset-lint-crowdstrike ^2.0.0 development
  • renovate-config-standard ^2.1.1 development
  • standard-node-template 2.0.0 development
  • standard-version ^9.2.0 development
  • tmp 0.2.1 development
  • yargs-help-output file: development
  • execa ^5.0.0
  • yargs ^17.0.0
yarn.lock npm
  • 604 dependencies
.github/workflows/ci.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • kellyselden/ember-cli-update-action v3 composite
.github/workflows/publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
test/fixtures/bin/package.json npm
test/fixtures/getHelpText/package.json npm