npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@nimblehq/react-template

v1.1.0

Published

Nimble React Application Generator

Downloads

9

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

dev-nimbl3dev-nimbl3olivierobertolivierobertdev-nimblehqdev-nimblehq

Keywords

oclif

Readme

Command Line Interface for React application at Nimble.

This CLI is built with the Open CLI framework oclif

Usage

$ npm install -g @nimblehq/react-template
$ nimble-react COMMAND
running command...
$ nimble-react (--version)
@nimblehq/react-template/1.1.0 linux-x64 node-v16.17.0
$ nimble-react --help [COMMAND]
USAGE
  $ nimble-react COMMAND
...

Commands

nimble-react generate APPNAME [TEMPLATE] [DEST]

Generate Nimble React application

USAGE
  $ nimble-react generate [APPNAME] [TEMPLATE] [DEST]

ARGUMENTS
  APPNAME   application name
  TEMPLATE  [default: @nimblehq] template location, use "file:{../path/to/your/local/template/repo}" for using a local
            cra template
  DEST      [default: ./] destination, defines in which folder the project folder will be created

DESCRIPTION
  Generate Nimble React application

EXAMPLES
  $ nimble-react generate app-name

See code: dist/commands/generate/index.ts

nimble-react help [COMMAND]

Display help for nimble-react.

USAGE
  $ nimble-react help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for nimble-react.

See code: @oclif/plugin-help

nimble-react plugins

List installed plugins.

USAGE
  $ nimble-react plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ nimble-react plugins

See code: @oclif/plugin-plugins

nimble-react plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ nimble-react plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.

  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ nimble-react plugins add

EXAMPLES
  $ nimble-react plugins:install myplugin 

  $ nimble-react plugins:install https://github.com/someuser/someplugin

  $ nimble-react plugins:install someuser/someplugin

nimble-react plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ nimble-react plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ nimble-react plugins:inspect myplugin

nimble-react plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ nimble-react plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.

  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ nimble-react plugins add

EXAMPLES
  $ nimble-react plugins:install myplugin 

  $ nimble-react plugins:install https://github.com/someuser/someplugin

  $ nimble-react plugins:install someuser/someplugin

nimble-react plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ nimble-react plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.

  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.

EXAMPLES
  $ nimble-react plugins:link myplugin

nimble-react plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ nimble-react plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ nimble-react plugins unlink
  $ nimble-react plugins remove

nimble-react plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ nimble-react plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ nimble-react plugins unlink
  $ nimble-react plugins remove

nimble-react plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ nimble-react plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ nimble-react plugins unlink
  $ nimble-react plugins remove

nimble-react plugins update

Update installed plugins.

USAGE
  $ nimble-react plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

How to contribute

Run

To run the CLI on your local machine:

  $ cd ./packages/cli-tool/
  $ npm i
  $ ./bin/dev generate app-name

💡 Running just ./bin/dev without argument will display all the possible commands as well as additional information.

If your changes also impacted the cra-template package, you can still test them locally using:

  ./bin/dev generate test-cli file:../cra-template

Find more the OCLIF Documentation!

Test

Tests are generated from the combination of:

  • TestData objects
  • Scenario objects

TestData objects gather all the rules that should be tested for a given add-on. When creating a new add-on, you need to create a new associated TestData object in the ./test/add-ons/** folder.

Scenario objects enable running the tests of multiple add-ons in a single generate command execution. As running the generate command is time-consuming, grouping several add-ons tests into a single scenario is a way to get tests results earlier.

License

This project is Copyright (c) 2014 and onwards. It is free software and may be redistributed under the terms specified in the LICENSE file.

About

Nimble

This project is maintained and funded by Nimble.

We love open source and do our part in sharing our work with the community! See our other projects or hire our team to help build your product.