@akasuv/lfg

lfg

Frontend project auto-configuration

• lfg
• Usage
• Commands

Usage

$ npm install -g @akasuv/lfg
$ lfg COMMAND
running command...
$ lfg (--version)
@akasuv/lfg/1.0.1 linux-x64 node-v12.22.9
$ lfg --help [COMMAND]
USAGE
  $ lfg COMMAND
...

Commands

• lfg help [COMMAND]
• lfg plugins
• lfg plugins:inspect PLUGIN...
• lfg plugins:install PLUGIN...
• lfg plugins:link PLUGIN
• lfg plugins:uninstall PLUGIN...
• lfg plugins update
• lfg write

lfg help [COMMAND]

Display help for lfg.

USAGE
  $ lfg help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for lfg.

See code: @oclif/plugin-help

lfg plugins

List installed plugins.

USAGE
  $ lfg plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ lfg plugins

See code: @oclif/plugin-plugins

lfg plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ lfg plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ lfg plugins:inspect myplugin

lfg plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ lfg plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.

  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ lfg plugins add

EXAMPLES
  $ lfg plugins:install myplugin 

  $ lfg plugins:install https://github.com/someuser/someplugin

  $ lfg plugins:install someuser/someplugin

lfg plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ lfg plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.

  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.

EXAMPLES
  $ lfg plugins:link myplugin

lfg plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ lfg plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ lfg plugins unlink
  $ lfg plugins remove

lfg plugins update

Update installed plugins.

USAGE
  $ lfg plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

lfg write

Update project configuration

USAGE
  $ lfg write

DESCRIPTION
  Update project configuration

See code: dist/commands/write/index.ts

• lfg write
• lfg help [COMMAND]

lfg write

Update project configuration, those files will be overridden if you have any of them in the current project:

• .gitignore
• .prettierrc
• .eslintrc
• .husky
• .commitlintrc.json

Add scripts:release

Commit linting: run before committing your code

• lint-staged: code formatting with Prettier
• commitlint: linting commit message with Conventional Commits

USAGE
  $ lfg write

ARGUMENTS
  no arguments

FLAGS
  no flags

lfg help [COMMAND]

Display help for lfg.

USAGE
  $ lfg help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for lfg.