chore: fix local package publishing (#84)

Author: dmitry-stepanenko

.verdaccio/config.yml

@@ -0,0 +1,41 @@
+# path to a directory with all packages
+storage: ../tmp/local-registry/storage
+
+auth: # TODO
+  htpasswd:
+    file: ./htpasswd
+
+# a list of other known repositories we can talk to
+uplinks:
+  npmjs:
+    url: https://registry.npmjs.org/
+    cache: true
+  yarn:
+    url: https://registry.yarnpkg.com
+    cache: true
+
+packages:
+  '@*/*':
+    # scoped packages
+    access: $all
+    publish: $all
+    unpublish: $all
+    proxy: npmjs
+
+  '**':
+    # allow all users (including non-authenticated users) to read and
+    # publish all packages
+    access: $all
+
+    # allow all users (including non-authenticated users) to publish/publish packages
+    publish: $all
+    unpublish: $all
+
+    # if package is not available locally, proxy requests to 'yarn' registry
+    proxy: npmjs
+
+# log settings
+logs:
+  type: stdout
+  format: pretty
+  level: http

.verdaccio/htpasswd

@@ -0,0 +1 @@
+test:5Y30XDhEQaJmQ:autocreated 2023-02-19T13:45:24.361Z

CONTRIBUTING.md

@@ -141,19 +141,19 @@ After your pull request is merged, you can safely delete your branch and pull th
 ## ▶ 9. Publishing to a local registry
 
 To test if your changes will actually work once the changes are published,
-it can be useful to publish locally to *Verdaccio*, a lightweight Node.js private proxy registry.
+it can be useful to publish to a local registry.
 
-**In Terminal 1, Install and launch Verdaccio**
-- Run `npm i -g verdaccio` in Terminal 1 (keep it running)
-- Run `verdaccio`
+- Run `pnpm run local-registry start` in Terminal 1 (keep it running)
+- Run `npm adduser --registry http://localhost:4873` in Terminal 2 (real credentials are not required, you just need to
+  be logged in. You can use test/test/[email protected].)
+- Run `pnpm run local-registry enable` in Terminal 2
+- Run `pnpm run nx run qwik-nx:publish:local` in Terminal 2. You can set the version you want to publish in the package's package.json file.
 
-**In Terminal 2, Add a user and execute Nx commands to populate the local Verdaccio repository**
-- Run `npm adduser --registry http://localhost:4873 --auth-type=legacy`
-  
-  *(real credentials are not required, you just need to be logged in. You can use your own login details.)*
+If you have problems publishing, make sure you use Node 18 and NPM 8. Alternatively to running the project's "publish" target you can build and publish manually by running `pnpm run nx build:qwik-nx && cd dist/projects/qwik-nx && npm publish --registry=http://localhost:4873`
 
-- Run `nx publish [package] --registry=http://localhost:4873`
-- Run `nx publish qwik-nx --registry=http://localhost:4873`
+**NOTE:** After you finish with local testing don't forget to stop the local registry (e.g. closing the Terminal 1) and disabling the local registry using `pnpm run local-registry disable`. Keeping local registry enabled will change your lock file resolutions to `localhost:4873` on the next `pnpm install`. You can also run `pnpm run local-registry clear` to clean all packages in that local registry.
+
+**NOTE:** To use this newly published local version, you need to make a new workspace or change your target package to this new version, eg: `"qwik-nx": "^1.0.0",` and re-run `pnpm install` in your testing project.
 
 ### ▶ 10. That's it! Thank you for your contribution! 🙏💓
 

package.json

@@ -6,6 +6,7 @@
     "build": "nx build",
     "commit": "git-cz",
     "format:fix": "pretty-quick --staged",
+    "local-registry": "./scripts/local-registry.sh",
     "prepare": "husky install",
     "start": "nx serve",
     "test": "nx test"
@@ -52,7 +53,7 @@
     "jest-environment-jsdom": "28.1.1",
     "jsonc-eslint-parser": "^2.1.0",
     "kill-port": "2.0.1",
-    "ngx-deploy-npm": "^4.3.11",
+    "ngx-deploy-npm": "^5.2.0",
     "nx": "15.6.1",
     "prettier": "^2.8.0",
     "pretty-quick": "^3.1.3",
@@ -61,6 +62,7 @@
     "ts-jest": "28.0.5",
     "ts-node": "10.9.1",
     "typescript": "~4.8.2",
+    "verdaccio": "5.21.1",
     "vite": "4.1.1"
   },
   "dependencies": {

packages/qwik-nx/project.json

@@ -84,6 +84,11 @@
       "executor": "ngx-deploy-npm:deploy",
       "options": {
         "access": "public"
+      },
+      "configurations": {
+        "local": {
+          "registry": "http://localhost:4873"
+        }
       }
     },
     "push-to-github": {