npmpackage.info

Gathering detailed insights and metrics for @fig/complete-commander

@fig/complete-commander

Command line tools for working with Fig autocomplete specs

3.2.0

MIT

TypeScript

11.64 kB

6,354,142 3.5

Installations

npm install @fig/complete-commander

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

20.12.2

NPM Version

10.5.0 Score

88.7

Supply Chain

96.7

Quality

Maintenance

100

Vulnerability

99.6

License

Pull Requests

Open

24

Total

322

Closed

108

Merged

190

Issues

Open

10

Total

26

Closed

16

Releases

Unable to fetch releases

Contributors

View all 16 contributors

Languages

TypeScript

JavaScript

Python

Shell

Makefile

Batchfile

TypeScript (91.75%)

JavaScript (2.81%)

Python (2.81%)

Go (2.56%)

Shell (0.05%)

Makefile (0.02%)

Developer

withfig

Download Statistics

Total Downloads

6,354,142

Last Day

4,766

Last Week

82,333

Last Month

594,489

Last Year

5,846,214

GitHub Statistics

46 Stars

534 Commits

30 Forks

5 Watching

35 Branches

16 Contributors

Maintainers

Package Meta Information

Latest Version

3.2.0

Package Id

@fig/complete-commander@3.2.0

Unpacked Size

11.64 kB

Size

4.35 kB

File Count

NPM Version

10.5.0

Node Version

20.12.2

Publised On

06 Jun 2024

Total Downloads

Cumulative downloads

Total Downloads

6,354,142

Last day

-25%

4,766

Compared to previous day

Last week

-49.4%

82,333

Compared to previous week

Last month

-10.2%

594,489

Compared to previous month

Last year

1,051.9%

5,846,214

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

Commander integration

A tool to speed up the workflow of converting Commander commands to Fig completion spec files.

Docs

1generateCompletionSpec(command[, options]): string

Generate a completion spec from the provided command and return it a string.

command: a commander.Command object
options: an object containing the following optional properties:
- figSpecCommandName: specify the name of the command used to generate the fig spec (see). It defaults to 'generate-fig-spec'

1addCompletionSpecCommand(command): void

Add a new Subcommand to the provided command that will print a spec generated when invoked through $CLI generate-fig-spec.

command: a commander.Command object

Usage

Using this library is as simple as calling a function. The snippet of code below generates a new spec each time the executable file is run.

1import { program } from 'commander'
2import { generateCompletionSpec } from '@fig/complete-commander'
3
4program
5  .name('babel')
6  .description('The compiler for writing next generation JavaScript')
7  .version('7.16.0')
8  .argument('<file>', 'file to compile')
9
10// Do not generate if production env
11if (process.env.NODE_ENV === 'development') {
12  const spec = generateCompletionSpec(program) // write the generated spec to a file or print it to the console
13}

Custom command

You can also provide a custom command that generates a spec file when called. For example, the program below generates the Fig spec when eslint generate-fig-spec is run from a Terminal.

1import { program } from 'commander'
2import { addCompletionSpecCommand } from '@fig/complete-commander'
3
4program
5  .name('eslint')
6  .description('Find and fix problems in your JavaScript code')
7  .version('8.0.0')
8  .argument('<file>', 'file to lint')
9
10if (process.env.NODE_ENV === 'development') {
11  addCompletionSpecCommand(program)
12}
13program.parse()

NOTE: the command can be called whatever you want, but if you specify a name different from 'generate-fig-spec' you should set the figSpecCommandName option.

Options for `generateCompletionSpec`

Specify the fig command name

When creating a custom command to generate a Fig spec whose name is different from 'generateCompletionSpec' you want to avoid including it in the generated file. This option helps you do that.

1program
2  .name('eslint')
3  .description('Find and fix problems in your JavaScript code')
4  .version('8.0.0')
5  .argument('<file>', 'file to lint')
6
7if (process.env.NODE_ENV === 'development') {
8  program
9    .command('createSpec') // this command will not be included in the generated spec
10    .description('Generate a fig spec')
11    .action(() => {
12      generateCompletionSpec(program, { figSpecCommandName: 'createSpec' })
13    })
14}
15program.parse()

p.s. this tool has been written for commander@8, but should work in the most of the previous versions too.

Contributors

This integration was built by Federico Ciardi. Please see his repo for previous git history: https://github.com/fedeci/commander-to-fig.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

9

Maintained

Determines if the project is "actively maintained".

2

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/withfig/autocomplete-tools/lint.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/withfig/autocomplete-tools/lint.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/lint.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/withfig/autocomplete-tools/lint.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/withfig/autocomplete-tools/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/withfig/autocomplete-tools/test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/withfig/autocomplete-tools/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-autocomplete-tools-spec.yaml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/withfig/autocomplete-tools/update-autocomplete-tools-spec.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-autocomplete-tools-spec.yaml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/withfig/autocomplete-tools/update-autocomplete-tools-spec.yaml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-autocomplete-tools-spec.yaml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/withfig/autocomplete-tools/update-autocomplete-tools-spec.yaml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-autocomplete-tools-spec.yaml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/withfig/autocomplete-tools/update-autocomplete-tools-spec.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-create-completion-spec-spec.yaml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/withfig/autocomplete-tools/update-create-completion-spec-spec.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-create-completion-spec-spec.yaml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/withfig/autocomplete-tools/update-create-completion-spec-spec.yaml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-create-completion-spec-spec.yaml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/withfig/autocomplete-tools/update-create-completion-spec-spec.yaml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-create-completion-spec-spec.yaml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/withfig/autocomplete-tools/update-create-completion-spec-spec.yaml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-docs.yaml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/withfig/autocomplete-tools/update-docs.yaml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-publish-spec-to-team-spec.yaml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/withfig/autocomplete-tools/update-publish-spec-to-team-spec.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-publish-spec-to-team-spec.yaml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/withfig/autocomplete-tools/update-publish-spec-to-team-spec.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-publish-spec-to-team-spec.yaml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/withfig/autocomplete-tools/update-publish-spec-to-team-spec.yaml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-publish-spec-to-team-spec.yaml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/withfig/autocomplete-tools/update-publish-spec-to-team-spec.yaml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-publish-spec-to-team-spec.yaml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/withfig/autocomplete-tools/update-publish-spec-to-team-spec.yaml/main?enable=pin
Info: 0 out of 10 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 10 third-party GitHubAction dependencies pinned

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

Score

3.5

/10

Last Scanned on 2024-12-23

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@fig/complete-commander

Installations

Developer Guide

Yes

CommonJS

20.12.2

10.5.0

Score

Pull Requests

24

322

108

190

Issues

10

26

16

Releases

Unable to fetch releases

Contributors

Languages

Developer

withfig

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

6,354,142

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

Commander integration

Docs

Usage

Custom command

Options for generateCompletionSpec

Specify the fig command name

Contributors

10

10

10

9

2

0

0

0

0

0

0

0

0

3.5

/10

Options for `generateCompletionSpec`