react-char-fill 1.0.13 → 1.0.16

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.
Files changed (2) hide show
  1. package/README.md +41 -0
  2. package/package.json +9 -7
package/README.md CHANGED
@@ -117,6 +117,47 @@ Contributions are welcome! Please follow these steps to contribute:
117
117
 
118
118
  ---
119
119
 
120
+ ## 🏗️ Publishing
121
+
122
+ To publish a new version of the `react-char-fill` package, follow these steps:
123
+
124
+ 1. **Build and Preview:**
125
+ First, build and preview the project to ensure everything works as expected.
126
+
127
+ ```bash
128
+ bun run bp
129
+ ```
130
+
131
+ This command will build the library and start a preview server. Verify that the build is successful and the preview behaves as intended.
132
+
133
+ 2. **Commit Changes:**
134
+ If everything works fine, commit any changes made to the repository.
135
+
136
+ ```bash
137
+ git add .
138
+ git commit -m "Your commit message"
139
+ ```
140
+
141
+ 3. **Bump Version:**
142
+ After committing, bump the version number. This will update the `package.json` version and create a new commit with the version bump.
143
+
144
+ ```bash
145
+ bun run bump
146
+ ```
147
+
148
+ 4. **Publish:**
149
+ Finally, publish the package to npm and GitHub Packages.
150
+
151
+ ```bash
152
+ bun run publish
153
+ ```
154
+
155
+ This command will build the library, publish the package to npm and GitHub Packages, and ensure everything is correctly versioned and released.
156
+
157
+ By following these steps, you can ensure that each release is built, tested, and published consistently.
158
+
159
+ ---
160
+
120
161
  ## 📄 License
121
162
 
122
163
  This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "react-char-fill",
3
- "version": "1.0.13",
3
+ "version": "1.0.16",
4
4
  "author": "Alex Abushanab",
5
5
  "repository": {
6
6
  "type": "git",
@@ -67,20 +67,21 @@
67
67
  "registry": "https://npm.pkg.github.com"
68
68
  },
69
69
  "scripts": {
70
- "bp": "vite build && vite preview",
71
- "build:demo": "rm -rf docs && vite build --outDir docs && mv src/demo/docs .",
72
- "build:lib": " vite build --config vite-lib.config.ts && tsc -p tsconfig.lib.json",
73
- "generate-types": "tsc -p tsconfig.lib.json",
74
- "build": "bun run build:lib && bun run build:demo",
70
+ "bp": "bun run build && vite preview",
71
+ "build:gh-pages": "vite build --config vite-gh-pages.config.ts",
72
+ "build:netlify": "vite build --config vite-netlify.config.ts",
73
+ "build:lib": "vite build --config vite-lib.config.ts && tsc -p tsconfig.lib.json",
74
+ "build": "bun run build:lib && bun run build:gh-pages && bun run build:netlify",
75
+ "bump": "npm version patch",
75
76
  "clean": "rm -rf dist && rm -rf node_modules && rm -rf bun.lockb && bun i",
76
77
  "cypress": "npx cypress open",
77
78
  "deploy": "bun run build",
78
79
  "dev": "vite",
79
80
  "format": "prettier --write .",
81
+ "generate-types": "tsc -p tsconfig.lib.json",
80
82
  "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
81
83
  "prettier-format": "prettier --config .prettierrc 'src/**/*.ts' --write",
82
84
  "preview": "vite preview",
83
- "publish": "bun run build && bun run publish:npm-bump && bun run publish:github",
84
85
  "publish-name:restore": "node -e \"let pkg=require('./package.json'); pkg.name='react-char-fill'; require('fs').writeFileSync('package.json', JSON.stringify(pkg, null, 2));\"",
85
86
  "publish-name:scope": "node -e \"let pkg=require('./package.json'); pkg.name='@lexabu/react-char-fill'; require('fs').writeFileSync('package.json', JSON.stringify(pkg, null, 2));\"",
86
87
  "publish:github-bump": "npm version patch && npm run publish:github-prepare",
@@ -88,6 +89,7 @@
88
89
  "publish:github": "npm run publish:github-prepare",
89
90
  "publish:npm-bump": "npm version patch && bun run build:lib && npm publish --registry=https://registry.npmjs.org/",
90
91
  "publish:npm": "bun run build:lib && npm publish --registry=https://registry.npmjs.org/",
92
+ "publish": "bun run build && bun run publish:npm && bun run publish:github",
91
93
  "test": "cypress"
92
94
  },
93
95
  "type": "module",