@rajdeep0510/scaffold-cli 1.0.0 → 1.0.2
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/.github/workflows/npm-publish.yml +28 -0
- package/README.md +10 -29
- package/package.json +1 -1
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
name: Publish npm Package
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches:
|
|
6
|
+
- main # Trigger when pushing to main branch
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
publish:
|
|
10
|
+
runs-on: ubuntu-latest
|
|
11
|
+
|
|
12
|
+
steps:
|
|
13
|
+
- name: Checkout repo
|
|
14
|
+
uses: actions/checkout@v3
|
|
15
|
+
|
|
16
|
+
- name: Setup Node.js
|
|
17
|
+
uses: actions/setup-node@v3
|
|
18
|
+
with:
|
|
19
|
+
node-version: "20"
|
|
20
|
+
registry-url: "https://registry.npmjs.org/"
|
|
21
|
+
|
|
22
|
+
- name: Install dependencies
|
|
23
|
+
run: npm ci
|
|
24
|
+
|
|
25
|
+
- name: Publish to npm
|
|
26
|
+
run: npm publish
|
|
27
|
+
env:
|
|
28
|
+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
package/README.md
CHANGED
|
@@ -1,49 +1,30 @@
|
|
|
1
|
-
#
|
|
1
|
+
# scaffold
|
|
2
2
|
|
|
3
3
|
A CLI tool for creating versatile and modern UI components.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Import components
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
|
|
8
|
+
npx @rajdeep0510/scaffold-cli add <component-name>
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
- Paste the following command in the terminal and the name of the component to import it.
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
lib_ui add <component-name>
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
### Examples
|
|
18
|
-
|
|
19
|
-
```bash
|
|
20
|
-
lib_ui add Header
|
|
21
|
-
lib_ui add Button
|
|
22
|
-
lib_ui add Card
|
|
23
|
-
```
|
|
13
|
+
## List
|
|
24
14
|
|
|
25
|
-
## Troubleshooting
|
|
26
|
-
|
|
27
|
-
If you get a "command not found" error after installation, you may need to add npm's global bin directory to your PATH:
|
|
28
|
-
|
|
29
|
-
### For macOS/Linux:
|
|
30
15
|
```bash
|
|
31
|
-
|
|
32
|
-
export PATH="$(npm config get prefix)/bin:$PATH"
|
|
16
|
+
npx @rajdeep0510/scaffold-cli list
|
|
33
17
|
```
|
|
34
18
|
|
|
35
|
-
|
|
36
|
-
The npm global bin directory is usually already in your PATH. If not, you can find it by running:
|
|
37
|
-
```bash
|
|
38
|
-
npm config get prefix
|
|
39
|
-
```
|
|
19
|
+
- To list all the avaliable components in the scaffold directory.
|
|
40
20
|
|
|
41
21
|
## Development
|
|
42
22
|
|
|
43
23
|
To install locally for development:
|
|
24
|
+
|
|
44
25
|
```bash
|
|
45
26
|
git clone <repository-url>
|
|
46
|
-
cd
|
|
27
|
+
cd scaffold
|
|
47
28
|
npm install
|
|
48
29
|
npm link
|
|
49
|
-
```
|
|
30
|
+
```
|
package/package.json
CHANGED