chore: verdaccio setup (#35)

* chore: setup verdaccio

tweaks

chore: verdaccio setup

chore: verdaccio setup

chore: tweaks

fix ci

fix

fix

fix

fix

fix local e2e

debug

fix

fix

* fix typecheck

* debug

* fix

* fix

* disable tests

* debug

* publish template package

* fix merging  of NPM-based templates

* cleanup

* remove `publishConfig`

* fix

* move verdaccio config

* remove sleep

* fix

* restore sleep

* tweaks

* more tweaks

* code review changes

* code review: limit create app steps

* replaceAll

* packageJson field removal

* improve verdaccio startup script

* chore tweaks

* improve verdaccio init script

* simplify verdaccio config

* pnpm lock

* swap execa for nano-spawn

* handle also sigterm

* backup file

* more tweaks

* run verdaccio in bg on ci

* fix help

* use npm publish instead of pnpm publish

* fix issue with removed +x flag on gradlew

* fix

* fix pnpm install

* improve ci stability

* docs

* fix typo

* refactor: cleanup template handling in packages (#47)

* move template dirs

* fix output package structure

* remove: *.md from nx/tsc assets (advised by jbroma)

* remove dist/package.json after build

* fix package.json resolution in cli

---------

Co-authored-by: Michał Pierzchała <[email protected]>

Author: mdjastrzebski

.github/workflows/ci.yml

@@ -32,7 +32,22 @@ jobs:
       - uses: nrwl/nx-set-shas@v4
 
       # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected
-      - run: pnpm exec nx affected -t typecheck lint
-      - run: pnpm exec nx affected -t test
-      - run: pnpm exec nx affected -t build
-      - run: pnpm exec nx affected -t e2e
+      - name: Typecheck and lint
+        run: pnpm exec nx affected -t typecheck lint
+
+      - name: Run tests
+        run: pnpm exec nx affected -t test
+
+      - name: Build
+        run: pnpm build
+
+      - name: Run end-to-end tests
+        run: |
+          # Run in background
+          pnpm verdaccio:init &
+
+          npx [email protected] http://localhost:4873
+          pnpm verdaccio:publish
+
+          NPM_CONFIG_REGISTRY=http://localhost:4873 pnpm exec nx affected -t e2e
+

.gitignore

@@ -4,6 +4,7 @@
 dist
 tmp
 /out-tsc
+*.orig
 
 # dependencies
 node_modules

.npmrc

@@ -1,2 +1,2 @@
-strict-peer-dependencies=false
+link-workspace-packages=true
 auto-install-peers=true

.verdaccio/config.yml

@@ -1,28 +1,19 @@
-# path to a directory with all packages
-storage: ../tmp/local-registry/storage
+storage: /tmp/verdaccio-storage
 
-# a list of other known repositories we can talk to
 uplinks:
   npmjs:
     url: https://registry.npmjs.org/
-    maxage: 60m
 
 packages:
-  '**':
-    # give all users (including non-authenticated users) full access
-    # because it is a local registry
+  '@callstack/*':
     access: $all
     publish: $all
-    unpublish: $all
-
-    # if package is not available locally, proxy requests to npm registry
+  '**':
+    access: $all
     proxy: npmjs
 
-# log settings
+# This options does not seem to react to changes when used with `runServer()` node API
+# Maybe upgrade to Verdaccio 6.x will help
+# See: https://github.com/verdaccio/verdaccio/issues/3728
 logs:
-  type: stdout
-  format: pretty
-  level: warn
-
-publish:
-  allow_offline: true # set offline to true to allow publish offline
+  - { type: stdout, format: pretty, level: info }

CONTRIBUTING.md

@@ -67,6 +67,36 @@ pnpm rnef start
 pnpm rnef run:android
 ```
 
+### Testing Create RNEF App project
+
+In order to test changes to `create-app` package, you need to run the following commands:
+
+```sh
+# Ensure fresh build
+nx reset
+pnpm build
+
+# Start local verdaccio registry (in one terminal), keep it open
+pnpm verdaccio:init
+
+# Publish packages to verdaccio (in another terminal)
+pnpm verdaccio:publish
+
+# Remove pnpm dlx cache, so that new version of package is used
+rm -rf ~/Library/Caches/pnpm/dlx/
+
+# Run tests
+pnpm e2e
+
+# Or Create RNEF app
+NPM_CONFIG_REGISTRY=http://localhost:4873 pnpm create @callstack/rnef-app --registry http://localhost:4873
+# Then use pnpm install with registry
+NPM_CONFIG_REGISTRY=http://localhost:4873 pnpm install
+
+# Clean up
+pnpm verdaccio-reset
+```
+
 ## Typechecking, linting and testing
 
 Currently we use TypeScript for typechecking, `eslint` with `prettier` for linting and formatting the code and `jest` for testing.

nx.json

@@ -19,7 +19,6 @@
         "outputPath": "{projectRoot}/dist",
         "main": "{projectRoot}/src/index.ts",
         "tsConfig": "{projectRoot}/tsconfig.lib.json",
-        "assets": ["packages/{projectRoot}/*.md"],
         "buildableProjectDepsInPackageJsonType": "dependencies",
         "generateExportsField": true,
         "compilerOptions": {

package.json

@@ -5,19 +5,24 @@
   "type": "module",
   "scripts": {
     "build": "nx run-many --target build",
+    "postbuild": "nx run-many --target clean-dist",
     "test": "nx run-many --target test",
     "e2e": "nx run-many --target e2e",
     "lint": "nx run-many --target lint",
     "typecheck": "nx run-many --target typecheck",
     "watch": "nx watch --all -- nx run \\$NX_PROJECT_NAME:build",
-    "link-packages": "node ./scripts/linkPackages.mjs"
+    "link-packages": "node ./scripts/linkPackages.mjs",
+    "verdaccio:init": "node ./scripts/verdaccio-init.mjs",
+    "verdaccio:publish": "node ./scripts/verdaccio-publish.mjs",
+    "verdaccio:reset": "./scripts/verdaccio-reset.sh"
   },
   "private": true,
   "dependencies": {
     "tslib": "^2.3.0",
     "vite-tsconfig-paths": "^5.0.1"
   },
   "devDependencies": {
+    "@clack/prompts": "^0.8.2",
     "@eslint/js": "^9.8.0",
     "@nx/eslint": "19.8.0",
     "@nx/eslint-plugin": "19.8.0",
@@ -39,7 +44,7 @@
     "ts-node": "10.9.1",
     "typescript": "~5.5.2",
     "typescript-eslint": "^8.0.0",
-    "verdaccio": "^5.0.4",
+    "verdaccio": "^5.33.0",
     "vite": "^5.0.0",
     "vitest": "^2.1.2"
   },

packages/cli/package.json

@@ -9,9 +9,13 @@
   "bin": {
     "rnef": "./dist/src/bin.js"
   },
+  "scripts": {
+    "clean-dist": "rm -f dist/package.json",
+    "publish:verdaccio": "npm publish --registry http://localhost:4873 --userconfig ../../.npmrc"
+  },
   "dependencies": {
-    "@callstack/rnef-config": "workspace:*",
-    "@callstack/rnef-tools": "workspace:*",
+    "@callstack/rnef-config": "^0.0.1",
+    "@callstack/rnef-tools": "^0.0.1",
     "@clack/prompts": "^0.8.1",
     "@react-native-community/cli-config": "^15.1.2",
     "commander": "^12.1.0",

packages/cli/project.json

@@ -11,8 +11,7 @@
       "options": {
         "outputPath": "packages/cli/dist",
         "main": "packages/cli/src/index.ts",
-        "tsConfig": "packages/cli/tsconfig.lib.json",
-        "assets": ["packages/cli/*.md"]
+        "tsConfig": "packages/cli/tsconfig.lib.json"
       }
     }
   }

packages/cli/src/lib/cli.ts

@@ -1,13 +1,15 @@
+import { dirname } from 'path';
+import { fileURLToPath } from 'url';
 import { Command } from 'commander';
 import { getConfig } from '@callstack/rnef-config';
 import { createRequire } from 'module';
-import { logger } from '@callstack/rnef-tools';
+import { logger, resolveFilenameUp } from '@callstack/rnef-tools';
 import { logConfig } from '../config.js';
 import { nativeFingerprintCommand } from './commands/fingerprint.js';
 
 const require = createRequire(import.meta.url);
-
-const { version } = require('./../../package.json');
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const { version } = require(resolveFilenameUp(__dirname, 'package.json'));
 
 type CliOptions = {
   cwd?: string;