Starfall CLI - Building Your Components Easier and Faster!

Starfall CLI speeds up tasks by multiprocessing on multiple CPU cores, which maximizes the capacity of CPU.

Popular Tech Standards in Starfall CLI

• webpack + babel
• eslint + stylelint
• mocha + istanbul
• koa
• playwright

Install

Install Node.js 16+

Install [starfall-cli]

#require administrator/sudo permission
npm install starfall-cli -g
#run starfall-cli directly
sf -v

Commands

# show all commands
sf --help

Troubleshooting

• Resolving EACCES permissions errors when installing packages globally
• "-bash: sf: command not found" remove and create new symbolic link for Starfall: ln -s /path-to-starfall-cli/lib/cli.js /usr/local/bin/sf

Project structure

• Monorepos (multiple packages)

  local-path/your-project/
  package.json
  packages/
    component-name-1/
      package.json
      public/
        index.html
      src/
        index.js
      test/
        specs/
          test.js
    component-name-2/
      package.json
      public/
        index.html
      src/
        index.js
      test/
        specs/
          test.js

• Single package

  local-path/your-project/
  package.json
  public/
    index.html
  src/
    index.js
  test/
    specs/
      test.js

Getting start with new project (monorepos)

sf init
sf add component-name
sf install
sf build
sf test

Configuration

Copy to project root path or use CLI default.

• /scripts/conf.cli.js
• /scripts/conf.webpack.js
• /scripts/conf.proxy.js

Changelog

CHANGELOG.md

Debug CLI with VSCode

• Enable "Debug > Node: Auto Attach" with "on" in Preferences Settings

• Debug Config: .vscode/launch.json

  {
    "version": "0.2.0",
    "configurations": [{
        "type": "node",
        "request": "launch",
        "name": "Debug",
        "program": "${workspaceFolder}/../starfall-cli/lib/cli.js",
        "cwd": "${workspaceFolder}",
        "autoAttachChildProcesses": true,
        "args": ["build", "app", "-m"]
    }]
  }

Run Starfall CLI from docker

First building your Starfall CLI docker image from Dockerfile:

docker build . -t cli-docker

Then running Starfall CLI docker image for your project:

docker run \
--rm \
--name container_sf \
--mount type=bind,source="$(pwd)",target=/project \
cli-docker \
bash -c "sf install && sf precommit || CODE=\$? && chmod 777 -R /project && exit \$CODE"