seppwc / fuchsia-cli

CLI tool for FennecJS

Fuchsia-CLI

CLI tool for FuchsiaJS

install

local install

    npm install -save-dev @fuchsia/cli

global install

    npm install -g @fuchsia/cli

Usage

local install

    npx fuchsia [command]

global install

    fuchsia [command]

basic commands

fuchsia [command]

-v --version: display CLI version
-h --help [command]: display Help info for command

new

creates a new fuchsiajs project in [name] folder

    fuchsia new [name]

new command will prompt you for your prefered language (Javascript or Typescript) and prefered package manager (NPM / YARN).

fuchsia-cli's Issues

fnc new [directory]: should create base project

For MVP - fnc new [directory] should perform the following tasks:

1. check if [directory] exists in the cwd if not creates dir
2. init .git folder inside [directory]
3. should git clone from template repo from https://github.com/Phl3bas/Fennec-Javascript-Template
4. should npm install project

Test:

fnc new [directory]
// directory should be created if not existant, git should be initialised in [directory]
// stdout should reflect these changes

Feature: fnc new should ask questions for set up

questions to ask:

1. Typescript of Javascript
2. npm or yarn

any other suggestions can be made with other issues

Feature: fnc new should let user select package manager

from: #3

fnc new should ask whether user wishes to use yarn or npm and change project files accordingly

1. give user either/or option of NPM or Yarn
2. when selection is given, package.json scripts need to changes to the correct version (eg. "npm run start" or "yarn start")

Test:

fnc new [directory]
// project should ask "Initialise with which package manger?"
// options: "npm", "yarn"
cd [directory]
npm/yarn install //should install dependancies
npm run / yarn start //should start development server
// check package.json, scripts should use correct package manager

Feature: fnc new should ask user weather they wish to use Javascript or Typescript

from #3

fnc should ask user which version of javascript they wish to use

1. fnc new [directory] prompts user for language choice
2. user selects language of choice and correct git repo is clonse

Test:

fnc new [directory]
cmdline should prompt user "which language would you like to use" to use
Options: "Typescript", "Javascript"
// cmdline should copy correct template
cd [directory]
if JS selected files should be .js and .jsx
if TS selected there should be a tsconfig and files should be .ts and .tsx