@spark-ui/cli-utils 2.9.1 → 2.9.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/package.json +2 -2
- package/src/generate/templates/component/[vite.config.ts].js +1 -1
- package/src/generate/templates/component/src/[Component.doc.mdx].js +4 -5
- package/src/generate/templates/hook/[vite.config.ts].js +1 -1
- package/src/generate/templates/hook/src/[name.stories.mdx].js +3 -4
- package/src/index.doc.mdx +2 -3
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,16 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [2.9.3](https://github.com/adevinta/spark/compare/@spark-ui/cli-utils@2.9.2...@spark-ui/cli-utils@2.9.3) (2023-03-31)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @spark-ui/cli-utils
|
|
9
|
+
|
|
10
|
+
## [2.9.2](https://github.com/adevinta/spark/compare/@spark-ui/cli-utils@2.9.1...@spark-ui/cli-utils@2.9.2) (2023-03-30)
|
|
11
|
+
|
|
12
|
+
### Bug Fixes
|
|
13
|
+
|
|
14
|
+
- update vite config for package-level external dependencies ([fa21c73](https://github.com/adevinta/spark/commit/fa21c73d8ea579a1c5059f48cabca7188696d32e)), closes [#503](https://github.com/adevinta/spark/issues/503)
|
|
15
|
+
|
|
6
16
|
## [2.9.1](https://github.com/adevinta/spark/compare/@spark-ui/cli-utils@2.9.0...@spark-ui/cli-utils@2.9.1) (2023-03-29)
|
|
7
17
|
|
|
8
18
|
**Note:** Version bump only for package @spark-ui/cli-utils
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@spark-ui/cli-utils",
|
|
3
|
-
"version": "2.9.
|
|
3
|
+
"version": "2.9.3",
|
|
4
4
|
"description": "Spark CLI utils",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public"
|
|
@@ -28,5 +28,5 @@
|
|
|
28
28
|
"devDependencies": {
|
|
29
29
|
"@types/fs-extra": "11.0.1"
|
|
30
30
|
},
|
|
31
|
-
"gitHead": "
|
|
31
|
+
"gitHead": "92768ee141d0617f99ff07870b74fe7a4b33ccfb"
|
|
32
32
|
}
|
|
@@ -4,7 +4,6 @@ export default ({ name, description }) => {
|
|
|
4
4
|
const componentName = pascalCase(name)
|
|
5
5
|
|
|
6
6
|
return `import { ArgsTable, Meta, Story, Canvas } from '@storybook/addon-docs'
|
|
7
|
-
import { StoryHeading } from '@docs/helpers/StoryHeading'
|
|
8
7
|
|
|
9
8
|
import { ${componentName} } from '.'
|
|
10
9
|
|
|
@@ -16,23 +15,23 @@ import * as stories from './${componentName}.stories'
|
|
|
16
15
|
|
|
17
16
|
${description}
|
|
18
17
|
|
|
19
|
-
|
|
18
|
+
## Install
|
|
20
19
|
|
|
21
20
|
\`\`\`
|
|
22
21
|
npm install @spark-ui/${name}
|
|
23
22
|
\`\`\`
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
## Import
|
|
26
25
|
|
|
27
26
|
\`\`\`
|
|
28
27
|
import { ${componentName} } from "@spark-ui/${name}"
|
|
29
28
|
\`\`\`
|
|
30
29
|
|
|
31
|
-
|
|
30
|
+
## Props
|
|
32
31
|
|
|
33
32
|
<ArgsTable of={${componentName}} />
|
|
34
33
|
|
|
35
|
-
|
|
34
|
+
## Variants
|
|
36
35
|
|
|
37
36
|
<Canvas>
|
|
38
37
|
<Story of={stories.Default} />
|
|
@@ -5,7 +5,6 @@ export default ({ name, description }) => {
|
|
|
5
5
|
|
|
6
6
|
return `import { ArgsTable, Meta, Story } from '@storybook/addon-docs'
|
|
7
7
|
import { ReactLiveBlock } from '@docs/helpers/ReactLiveBlock'
|
|
8
|
-
import { StoryHeading } from '@docs/helpers/StoryHeading'
|
|
9
8
|
|
|
10
9
|
import { ${hookName} } from '.'
|
|
11
10
|
|
|
@@ -17,19 +16,19 @@ import * as stories from './${hookName}.stories'
|
|
|
17
16
|
|
|
18
17
|
${description}
|
|
19
18
|
|
|
20
|
-
|
|
19
|
+
## Install
|
|
21
20
|
|
|
22
21
|
\`\`\`
|
|
23
22
|
npm install @spark-ui/${name}
|
|
24
23
|
\`\`\`
|
|
25
24
|
|
|
26
|
-
|
|
25
|
+
## Import
|
|
27
26
|
|
|
28
27
|
\`\`\`
|
|
29
28
|
import { ${hookName} } from "@spark-ui/${name}"
|
|
30
29
|
\`\`\`
|
|
31
30
|
|
|
32
|
-
|
|
31
|
+
## Usage
|
|
33
32
|
|
|
34
33
|
<ArgsTable of={${hookName}} />
|
|
35
34
|
|
package/src/index.doc.mdx
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import { Meta } from '@storybook/blocks'
|
|
2
|
-
import { StoryHeading } from '@docs/helpers/StoryHeading'
|
|
3
2
|
|
|
4
3
|
<Meta title="utils/CLI" />
|
|
5
4
|
|
|
@@ -15,7 +14,7 @@ This package provides some CLI commands to improve the development experience wh
|
|
|
15
14
|
- [Generating a new package](#generating-a-new-package)
|
|
16
15
|
- [Setting up your themes](#setting-up-your-themes)
|
|
17
16
|
|
|
18
|
-
|
|
17
|
+
## Installation
|
|
19
18
|
|
|
20
19
|
CLI utils can be used by installing the package `@spark-ui/cli-utils` in your project:
|
|
21
20
|
|
|
@@ -29,7 +28,7 @@ or just by running the following command:
|
|
|
29
28
|
$ npx spark COMMAND_NAME
|
|
30
29
|
```
|
|
31
30
|
|
|
32
|
-
|
|
31
|
+
## Generating a new package
|
|
33
32
|
|
|
34
33
|
In order to generate a new package, the following command has to be executed:
|
|
35
34
|
|