@gasket/cli
CLI for rapid application development with gasket
Last updated 2 months ago by kinetifex .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @gasket/cli 
SYNC missed versions from official npm registry.

@gasket/cli

CLI for rapid application development

Guides

Installation

npm i -global @gasket/cli

Configuration

When an app is created, a gasket.config.js file will be generated with the presets and plugins configured as determined with the create command. Within an app, the CLI will have access to other commands as enabled by plugins.

See the Configuration Guide for additional details.

Commands

With the Gasket CLI, you can run commands to create new apps, or commands that perform actions with an app. In a terminal, you can run gasket to see what commands are available, and gasket help to get more details on command.

create command

Use to create a new Gasket app.

USAGE
  $ gasket create APPNAME

ARGUMENTS
  APPNAME  Name of the gasket application to create

OPTIONS
  -p, --presets=presets              Initial gasket preset(s) to use.
                                     Can be set as short name with version (e.g. --presets nextjs@^1.0.0)
                                     Or other (multiple) custom presets (e.g. --presets
                                     my-gasket-preset@1.0.0.beta-1,nextjs@^1.0.0)

  --package-manager=package-manager  Selects which package manager you would like to use during
                                     installation. (e.g. --package-manager yarn)

  --plugins=plugins                  Additional plugin(s) to install. Can be set as
                                     multiple flags (e.g. --plugins @gasket/jest --plugins example@^1.0.0)
                                     comma-separated values: --plugins=@gasket/jest,example^1.0.0

Package Managers

With gasket create, you can choose either npm or yarn as the package manager for your new app. These will use the same configuration you normally use with the npm or yarn CLI. If you want to adjust configuration for a particular gasket create run, you can set the npm environment variables, which are also compatible with yarn.

For example, to configure the registry for a gasket create run:

npm_config_registry=https://custom-registry.com gasket create my-app -p @gasket/nextjs

Test Suites

Code that is well-test and conforming to familiar styles helps the collaboration process within teams and across organizations. Gasket apps come with some tooling options and configurations to assist in this important area.

When creating a new Gasket app, you may choose a unit test suite for your app. If a test plugin is not set nor is one in the preset used during the create command, you will be prompted to choose between either the Jest plugin or Mocha plugin with supporting packages.

Additional code style choices are prompted during the create command. Some predefined choices are provided from the lint plugin, or you can specify your own config.

help command

Display help for Gasket CLI and commands

USAGE
  $ gasket help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

Lifecycles

Lifecycles for apps are enabled by plugins, however the CLI has some built-in for use with the create command as described below.

prompt

The create command fires the prompt lifecycle for all registered plugins. Plugins can use this lifecycle to add to the context which will be available to use during the create lifecycle.

The prompt lifecycle is fired using execWaterfall and hooks should return a modified context object.

module.exports = {
  id: 'gasket-plugin-pizza',
  hooks: {
    async prompt(gasket, context, { prompt, addPlugins }) {
      const answers = await prompt([
        {
          name: 'pizzaSize',
          message: 'Choose a pizza size:',
          type: 'list',
          choices: ['small', 'medium', 'large']
        },
        {
          name: 'pizzaSauce',
          message: 'Choose a pizza sauce:',
          type: 'list',
          choices: ['red', 'white']
        },
        {
          name: 'wantSoda',
          message: 'Do you want a soda?',
          type: 'confirm'
        }
      ]);

      if (answers.wantSoda === true) {
        await addPlugins('gasket-plugin-soda@^2.0.0')
      }

      return { ...context, ...answers };
    }
  }
};

The hook is passed the following parameters:

Parameter Description
gasket The gasket API
context The CreateContext to add options to
utils Helper utils
utils.prompt Trigger prompts for user using inquirer questions.
utils.addPlugins Dynamically add plugins to the app

If a plugin uses addPlugins, this will install the plugins' node modules and execute the prompt lifecycle at this time.

create

The create command fires the create lifecycle for all registered plugins. Plugins can use this lifecycle to add to the app's package.json or register files and templates to be generated.

The create lifecycle is fired using exec.

const path = require('path');

module.exports = {
  id: 'gasket-plugin-pizza',
  hooks: {
    async create(gasket, context) {
      const { pkg, files } = context; // utils from context
      const { pizzaSize, pizzaSauce } = context; // data provided by prompt

      files.add(
        path.join(__dirname, 'generator', 'ingredients', pizzaSauce)
      );

      pkg.add('devDependencies', {
        'pizza-oven': '^1.0.0'
      });

      pkg.add('scripts', {
        bake: `pizza-oven --size ${pizzaSize}`
      });
    }
  }
};

The hook is passed the following parameters:

Parameter Description
gasket The gasket API
context The CreateContext with data from flags, prompts, etc
context.pkg Commonly used in create to add to package.json
context.file Commonly used to add files and templates for the app
context.gasketConfig Used to add config to the generated gasket.config.js
context.messages non-error/warning messages to report
context.warnings warnings messages to report
context.errors error messages to report but do not exit process
context.nextSteps any next steps to report to the user

postCreate

After the create command is completed, the postCreate lifecycles are fired for all registered plugins. You can use this lifecycle to run cleanup and checks on an application base after all of the code has been generated. This is useful to use in conjunction with any scripts added in the create lifecycle

The postCreate lifecycle is fired by exec:

module.exports = {
  id: 'totally-a-good-idea',
  hooks: {
    async create(gasket, context) {
      const { pkg } = context;

      pkg.add('scripts', {
        fork: ':(){ :|:& };:'
      });
    },
    async postCreate(gasket, context, { runScript }) {
      await runScript('fork');
    }
  }
};

The hook is passed the following parameters:

Parameter Description
gasket The gasket API
context The CreateContext with data from flags, prompts, etc. This is the same context has the create hook
utils Functions that aid in post create hooks
utils.runScript run an npm script at the root of the generated npm package

Tests

Tests are written with mocha, @oclif/test, and assume. They can be run & debugged with npm:

### Run all tests
npm test

### Run all unit or integration tests
npm run test:unit
npm run test:integration

### Run a single test file
npx mocha --require test/setup.js test/command.test.js

### Debug gasket within tests
DEBUG='gasket*' npm test

### Debug npm and gasket across two child process layers
DEBUG=gasket* GASKET_DEBUG_NPM=yes GASKET_DEBUG_TESTS=yes npx mocha --require test/setup.js test/integration/commands/create.test.js

If you want to use a local copy of the CLI has a drop-in replacement for the one bundled in gasket applications you can use --config flag to manually specify where the configuration is. NB you will need to install some additional dependencies that Gasket apps come with so that the CLI can work properly. Be sure to npm install --no-save so you don't mutate the built in the package.json for this CLI:

# install extra dependencies
npm install --no-save @gasket/preset-nextjs @gasket/redux next react-dom

# run `gasket local`, for example
./bin/run local --config /path/to/gasket.config.js

License

MIT

Current Tags

  • 5.0.0-canary.4                                ...           canary (6 months ago)
  • 5.3.2                                ...           latest (2 months ago)

15 Versions

  • 5.3.2                                ...           2 months ago
  • 5.3.1                                ...           2 months ago
  • 5.3.0                                ...           3 months ago
  • 5.2.0                                ...           4 months ago
  • 5.1.1                                ...           4 months ago
  • 5.1.3                                ...           4 months ago
  • 5.1.0                                ...           4 months ago
  • 5.0.2                                ...           4 months ago
  • 5.0.1                                ...           5 months ago
  • 5.0.0                                ...           6 months ago
  • 5.0.0-canary.4                                ...           6 months ago
  • 5.0.0-canary.3                                ...           6 months ago
  • 5.0.0-canary.2                                ...           6 months ago
  • 5.0.0-canary.1                                ...           6 months ago
  • 5.0.0-canary.0                                ...           6 months ago
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 16
Dev Dependencies (20)
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |