FSD CLI

CLI for generating slices with segments by Feature-Sliced Design

Table of Contents

• Install
• Usage
  • Command structure
  • Commands
  • Examples
• Description

Install

npm:

npm install -g fsd-cli

yarn:

yarn add fsd-cli

Usage

Command structure

fsd [COMMAND] [FLAG] [VALUE]

Subfolder generation available, example:

fsd generate --shared UI/base-component

Commands

Supports passing multiple options at the same time.

Command	Alias	Options
generate	g	-w --widget -p --page -f --feature -e --entity -m --module -c --component

Examples

Generate widget

fsd g -w widget-name

Generate page

fsd g -p page-name

Generate feature

fsd g -f feature-name

Generate entity

fsd g -e entity-name

Generate module

fsd g -m module-name

Generate component

fsd g -c component-name

Description

The names of the slices are case-insensitive, all cases will be transformed into the case corresponding to the segment.

On the command example

fsd g -w placeholder

Segment	Filename
Public index	index.ts
Composable	usePlaceholder.ts
Component	Placeholder.vue
Types	placeholder.types.ts

The postfix "page" will be automatically added to the pages if it is not present. If the segment exists in the slice, then the file will not be overwritten.

Supported Node version: >= v14