nikewu / feflow

🚀 A command line tool aims to improve front-end engineer workflow and standard, powered by TypeScript.

Feflow

Feflow is a workflow tool aims to improve front-end engineer workflow and standard, powered by Typescript.

Learn Feflow

Before you use Feflow, you need to understand the basic concepts.

Just the Basics

There are three type of commands in Feflow:

• Native commands: Commands that Feflow native provide, such as init, install, uninstall, info, help.
• Devkit commands: Commands extended by Feflow devkit, a devkit usually has a series of commands and used for a real world project, Feflow devkit must have feflow-devkit prefix.
• Plugin commands: Commands extended by Feflow plugin, Feflow plugin must have feflow-plugin prefix.

Feflow config file

When you use Feflow to develop a project, Feflow will load config file and load devkit described in config file. Config load order is:

• .feflowrc.js,
• .feflowrc.yaml,
• .feflowrc.yml,
• .feflowrc.json,
• .feflowrc,
• package.json

Installation

To install the stable version:

npm install @feflow/cli -g

This assumes you are using npm as your package manager.

Create a project

This will use Feflow native command init

feflow init

Develop a project

This will use Feflow devkit commands, eg:

• Local development

feflow dev

• Build for production

feflow build

• Lint JS

feflow lint

• Deploy project

feflow deploy

• Generate changelog

feflow changelog

Change Log

This project adheres to Semantic Versioning. Every release, along with the migration instructions, is documented on the GitHub Releases page.

License

MIT