@spark-ui/cli-utils 1.3.1 → 1.3.2

package/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.3.2](https://github.com/adevinta/spark/compare/@spark-ui/cli-utils@1.3.1...@spark-ui/cli-utils@1.3.2) (2023-02-22)
+
+**Note:** Version bump only for package @spark-ui/cli-utils
+
 ## [1.3.1](https://github.com/adevinta/spark/compare/@spark-ui/cli-utils@1.3.0...@spark-ui/cli-utils@1.3.1) (2023-02-21)
 
 **Note:** Version bump only for package @spark-ui/cli-utils

package/bin/spark-generate.mjs

@@ -38,6 +38,7 @@ const packageUtils = {
   alreadyExists: name => {
     return rootPackageJSON.workspaces.some(workspace => {
       const existingPackages = glob.sync(`${BASE_DIR}/${workspace}/`)
+
       return existingPackages.some(path => path.endsWith(`/${name}/`))
     })
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spark-ui/cli-utils",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "description": "Spark CLI utils",
   "publishConfig": {
     "access": "public"
@@ -25,5 +25,5 @@
     "url": "git@github.com:adevinta/spark.git",
     "directory": "packages/utils/cli"
   },
-  "gitHead": "6667269271cbbc620443701a6de33587938901e9"
+  "gitHead": "d31d127a513beafe224e16ba94347cf0b968c486"
 }

package/src/index.stories.mdx

@@ -0,0 +1,51 @@
+import { Meta } from '@storybook/blocks'
+import { StoryHeading } from '@docs/helpers/StoryHeading'
+
+<Meta title="utils/CLI" />
+
+# CLI utils
+
+This package provides some CLI commands to improve the development experience when building the Spark design system. Right now there are some different commands available:
+
+- A command for generating new components: `$ spark generate`.
+- A command for doing the initial setup for a new theme: `$ spark setup-theme`.
+
+## Contents
+
+- [Installation](#installation)
+- [Generating a new package](#generating-a-new-package)
+- [Setting up a theme](#setting-up-a-theme)
+
+<StoryHeading label="Installation" as="h2" />
+
+CLI utils can be used by installing the package `@spark-ui/cli-utils` in your project:
+
+```bash
+$ npm install --save-dev @spark-ui/cli-utils
+```
+
+or just by running the following command:
+
+```bash
+$ npx spark COMMAND_NAME
+```
+
+<StoryHeading label="Generating a new package" as="h2" />
+
+In order to generate a new package, the following command has to be executed:
+
+```bash
+$ spark generate
+```
+
+Then, a command prompt will guide you through the process by asking you for:
+
+- the package name (required),
+- the template used (required, only `Component` template available right now)
+- and the package description (optional).
+
+<StoryHeading label="Setting up a theme" as="h2" />
+
+```bash
+$ spark setup-theme
+```