[add] GitHub action for NPM publishing

[optimize] NPM configuration
[fix] 2 compatibility bugs in Windows

Author: TechQuery

.github/workflows/main.yml

@@ -0,0 +1,36 @@
+name: CI & CD
+on:
+  push:
+    tags:
+      - v*
+jobs:
+  Build-and-Publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 10
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          registry-url: https://registry.npmjs.org
+          cache: pnpm
+      - name: Install Dependencies
+        run: pnpm i --frozen-lockfile
+
+      - name: Build & Publish
+        run: npm publish --access public --provenance
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Update document
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          publish_dir: ./docs
+          personal_token: ${{ secrets.GITHUB_TOKEN }}
+          force_orphan: true

.npmignore

@@ -0,0 +1 @@
+test/

README.md

@@ -1,7 +1,9 @@
-# ShadcnX
+# ShadcnX CLI
 
 A command line helper for [Shadcn UI CLI][1], `git commit` modified component codes only.
 
+[![CI & CD](https://github.com/idea2app/ShadcnX/actions/workflows/main.yml/badge.svg)][2]
+
 ## Installation
 
 ```bash
@@ -39,3 +41,4 @@ shadcn-x edit component-name
 1. https://github.com/idea2app/Next-shadcn-ts
 
 [1]: https://ui.shadcn.com/docs/cli
+[2]: https://github.com/idea2app/ShadcnX/actions/workflows/main.yml

package.json

@@ -1,17 +1,17 @@
 {
   "name": "shadcn-x",
   "version": "0.3.0",
+  "license": "LGPL-3.0-or-later",
+  "author": "shiy2008@gmail.com",
   "description": "A command line helper for Shadcn UI CLI, `git commit` modified component codes only.",
+  "keywords": [
+    "shadcn",
+    "component",
+    "command",
+    "helper"
+  ],
   "type": "module",
   "bin": "./dist/command.js",
-  "scripts": {
-    "install": "npm i shadcn -g",
-    "test": "cd test  &&  tsx ../source/command",
-    "build": "rm -rf dist/  &&  tsc  &&  cp source/components.json dist/",
-    "prepublishOnly": "npm t add button badge  &&  npm run build"
-  },
-  "author": "shiy2008@gmail.com",
-  "license": "LGPL-3.0-or-later",
   "dependencies": {
     "array-unique-proposal": "^0.3.4",
     "open": "^10.1.2",
@@ -31,5 +31,11 @@
   "prettier": {
     "singleQuote": true,
     "arrowParens": "avoid"
+  },
+  "scripts": {
+    "install": "pnpm i shadcn -g  ||  npm i shadcn -g",
+    "test": "cd test  &&  tsx ../source/command",
+    "build": "rm -rf dist/  &&  tsc  &&  cp source/components.json dist/",
+    "prepublishOnly": "npm t add button badge  &&  npm run build"
   }
 }

source/command.ts

@@ -5,16 +5,16 @@ import 'array-unique-proposal';
 import { $, fs, path } from 'zx';
 import open from 'open';
 
+import { localPathOf } from './utility.js';
+
 $.verbose = true;
 
 const [command, ...args] = process.argv.slice(2);
 
 const configurationTarget = 'components.json';
 
 if (!fs.existsSync(configurationTarget)) {
-  const configurationSource = (
-    new URL('components.json', import.meta.url) + ''
-  ).replace('file://', '');
+  const configurationSource = localPathOf(import.meta.url, configurationTarget);
 
   await fs.copy(configurationSource, configurationTarget);
 }
@@ -72,7 +72,9 @@ async function editComponent(component: string) {
 
   await saveIndex(oldList);
 
-  const filePath = path.join(componentsFilePath, `${component}.tsx`);
+  const filePath = path
+    .join(componentsFilePath, `${component}.tsx`)
+    .replace(/\\/g, '/');
 
   await fs.appendFile('.gitignore', `!${filePath}`);
 

source/utility.ts

@@ -0,0 +1,4 @@
+export const localPathOf = (importMetaURL: string, relativePath: string) =>
+  (new URL(relativePath, importMetaURL) + '')
+    .replace('file://' + (process.platform === 'win32' ? '/' : ''), '')
+    .replace(/\\/g, '/');