2.0.0 • Published 2 years ago

@dpc-sdp/nuxt-ripple-cli v2.0.0

Weekly downloads
-
License
Apache-2.0
Repository
-
Last release
2 years ago

Nuxt Ripple CLI

CLI for simplifying common setup and scaffolding tasks.

Installation

Either install the CLI install it globally using npm install -g @dpc-sdp/nuxt-ripple-cli or run it directly using npx @dpc-sdp/nuxt-ripple-cli.

If you've installed the package globally you can now use the nuxt-ripple command in your terminal.

Note: If you prefer to run the CLI using npx you won't be able to use the nuxt-ripple command and will instead need to use npx @dpc-sdp/nuxt-ripple-cli in place of nuxt-ripple. For instance npx @dpc-sdp/nuxt-ripple-cli init site my-site --name "My Site".

Commands

Init

The init command will initialise a new site or layer.

nuxt-ripple init [TEMPLATE] [DIRECTORY] --name {NAME} --rplVersion {RPL_VERSION}

[TEMPLATE]:

  • site Scaffolds a new nuxt site.
  • layer Scaffolds a new nuxt layer.

[DIRECTORY]: The directory to output scaffolded files into.

--name {NAME}: The name of the site or layer.

--rplVersion {RPL_VERSION}: The version of the ripple core dependencies to use.

Add

The add command will create a ripple component or content type.

nuxt-ripple add <command> [DIRECTORY]

<command>:

  • component Scaffolds a new Ripple (vue) component, note that the component folder is created as well to follow Ripple naming conventions.
  • content-type Scaffolds a new Ripple Tide content type.

Add Component

nuxt-ripple add component [DIRECTORY] --name {NAME} --prefix {PREFIX}

[DIRECTORY]: The directory to output the component scaffolding.

--name {NAME}: The name of new Vue component.

--prefix {PREFIX}: The prefix to used for the Vue components.

Add Content Type

nuxt-ripple add content-type [DIRECTORY] --name {NAME} --createTests --cypressPath {CYPRESSPATH}

[DIRECTORY]: The directory to output the content type scaffolding.

--name {NAME}: The name of the project or layer.

--createTests or -T: A flag to opt into example tests.

--cypressPath {CYPRESSPATH}: The path to the Cypress support folder, this is used when opting into the example tests.

Mock

The mock command will start a mock server for testing Ripple sites without a Tide backend.

nuxt-ripple mock [FIXTURE_PATH] --routes {ROUTE_PATH} --site {SITE_PATH}

[FIXTURE_PATH]: The path to the fixture, i.e. the mocked data

--routes {ROUTE_PATH}: The path to the JSON routes file; example route file: [{ "path": "/", "fixture": "home.json" }].

--site {SITE_PATH}: The relative (to [FIXTURE_PATH]) path to mocked global site data

2.0.0-next.59

2 years ago

2.0.0-next.51

2 years ago

2.0.0-next.52

2 years ago

2.0.0-next.53

2 years ago

2.0.0-next.54

2 years ago

2.0.0-next.55

2 years ago

2.0.0-next.56

2 years ago

2.0.0-next.57

2 years ago

2.0.0-next.58

2 years ago

2.0.0-next.60

2 years ago

2.0.0-next.61

2 years ago

2.0.0-next.48

2 years ago

2.0.0-next.49

2 years ago

2.0.0-next.40

2 years ago

2.0.0-next.41

2 years ago

2.0.0-next.42

2 years ago

2.0.0-next.43

2 years ago

2.0.0-next.44

2 years ago

2.0.0-next.45

2 years ago

2.0.0-next.46

2 years ago

2.0.0-next.47

2 years ago

2.0.0-alpha.43

2 years ago

2.0.0-next.50

2 years ago

2.0.0-alpha.49

2 years ago

2.0.0-alpha.48

2 years ago

2.0.0-next.37

2 years ago

2.0.0-next.38

2 years ago

2.0.0-next.39

2 years ago

2.0.0-next.73

2 years ago

2.0.0-next.74

2 years ago

2.0.0-next.30

2 years ago

2.0.0-next.75

2 years ago

2.0.0-next.31

2 years ago

2.0.0-next.32

2 years ago

2.0.0-next.33

2 years ago

2.0.0-next.34

2 years ago

2.0.0-next.35

2 years ago

2.0.0-next.36

2 years ago

2.0.0-next.28

2 years ago

2.0.0-next.29

2 years ago

2.0.0-next.62

2 years ago

2.0.0-next.63

2 years ago

2.0.0-next.64

2 years ago

2.0.0-next.65

2 years ago

2.0.0-next.67

2 years ago

2.0.0-next.68

2 years ago

2.0.0-next.69

2 years ago

2.0.0-next.71

2 years ago

2.0.0-next.72

2 years ago

2.0.0-next.26

2 years ago

2.0.0-next.27

2 years ago

2.0.0-next.25

2 years ago

2.0.0

2 years ago

2.0.0-next.23

2 years ago

2.0.0-next.24

2 years ago

2.0.0-rc.1

2 years ago

2.1.0-alpha.193

2 years ago

2.1.0-alpha.182

2 years ago

2.1.0-alpha.192

2 years ago

2.1.0-alpha.184

2 years ago

2.1.0-alpha.180

2 years ago

2.1.0-alpha.190

2 years ago

2.1.0-alpha.201

2 years ago

2.1.0-alpha.189

2 years ago

2.1.0-alpha.178

2 years ago

2.1.0-alpha.196

2 years ago

2.1.0-alpha.199

2 years ago

2.1.0-alpha.157

2 years ago

2.1.0-alpha.156

2 years ago

2.1.0-alpha.155

2 years ago

2.1.0-alpha.127

2 years ago

2.1.0-alpha.124

2 years ago

2.1.0-alpha.109

2 years ago

2.1.0-alpha.95

2 years ago

2.1.0-alpha.84

2 years ago