@capillarytech/cap-ui-dev-tools 0.0.2 → 1.0.0

package/README.md

@@ -21,6 +21,8 @@ This plugin provides a single, clean interface to handle both aliasing and watch
 
 **Based on initial testing, this can reduce development iteration time by over 90% (e.g., from 3 minutes to under 10 seconds).**
 
+![Architecture](architecture.png)
+
 ## Installation
 
 ```bash
@@ -74,7 +76,7 @@ module.exports = {
       // Optional: Options passed directly to chokidar.
       // See https://github.com/paulmillr/chokidar#api for details.
       watchOptions: {
-        // ...
+        // ..
       }
     })
   ]
@@ -96,6 +98,28 @@ module.exports = {
 -   **Check Name**: Ensure the `name` property matches the package name your host application is trying to import (e.g., `'cap-creatives-ui'`).
 -   **Enable `verbose` mode**: Set `verbose: true` to see detailed logs. It will confirm which aliases are being created and which paths are being watched.
 
-## License
+## For Maintainers: Publishing to NPM
+
+To publish a new version of this package to the NPM registry, follow these steps.
+
+1.  **Update Version Number**:
+    -   Update the `version` field in `package.json` according to [Semantic Versioning (SemVer)](https://semver.org/).
+
+2.  **Log in to NPM**:
+    -   If you are not already logged in, run the following command and enter your credentials.
+    ```bash
+    npm login
+    ```
+
+3.  **Perform a Dry Run**:
+    -   It is highly recommended to check what will be published without actually publishing it.
+    ```bash
+    npm publish --dry-run
+    ```
+    -   This will list all files being included in the package. Verify that only necessary files (`src/LibraryWatcherPlugin.js`, `package.json`, `README.md`) are present.
 
-ISC
+4.  **Publish**:
+    -   Once you have verified the package contents, run the publish command:
+    ```bash
+    npm publish
+    ```

package/package.json

@@ -1,7 +1,22 @@
 {
   "name": "@capillarytech/cap-ui-dev-tools",
-  "version": "0.0.2",
+  "version": "1.0.0",
   "main": "src/LibraryWatcherPlugin.js",
+  "files": [
+    "src/LibraryWatcherPlugin.js",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cap-ui-dev-tools/cap-ui-dev-tools.git"
+  },
+  "bugs": {
+    "url": "https://github.com/cap-ui-dev-tools/cap-ui-dev-tools/issues"
+  },
+  "homepage": "https://github.com/cap-ui-dev-tools/cap-ui-dev-tools#readme",
   "scripts": {
     "start": "webpack serve",
     "test": "jest"
@@ -24,4 +39,4 @@
   "peerDependencies": {
     "webpack": "^5.0.0"
   }
-}
+}

package/src/index.js

@@ -1,7 +0,0 @@
-import '@shared-ui-lib/index.js';
-
-console.log("Webpack entry point loaded.");
-
-if (module.hot) {
-  module.hot.accept();
-}