Running the commands in the Development section of the README does not create bin directory

dahenson commented 5 days ago

I am not a full-time JS developer, so I may be missing something, but I was unable to install the development environment as described, and I'm wondering if the developer steps could be more clear.

Steps taken:

Clone the repository and cd to the directory
Ran pnpm install (no errors or warnings related to xs-dev)
Ran pnpm link --global (no errors)
Ran xs-dev to check if it's installed, but no dice

Running pnpm install again resolves fine, except this output:

Lockfile is up to date, resolution step is skipped
Already up to date
 WARN  Failed to create bin at /home/redacted/Projects/hipsterbrown/xs-dev/node_modules/.bin/xs-dev. ENOENT: no such file or directory, open '/home/redacted/Projects/hipsterbrown/xs-dev/node_modules/xs-dev/build/src/cli.js'
 WARN  Failed to create bin at /home/redacted/Projects/hipsterbrown/xs-dev/node_modules/.bin/xs-dev. ENOENT: no such file or directory, open '/home/redacted/Projects/hipsterbrown/xs-dev/node_modules/xs-dev/build/src/cli.js'
Done in 3.7s

Workaround

I can currently run pnpm xs-dev <command> in order to continue local development.

Environment

Operating system: Fedora 40 Node version: v23.3.0 (installed via asdf) pnpm version: 9.14.2

HipsterBrown commented 3 days ago

Using pnpm xs-dev is the recommended way of running the CLI during development because it will compile it on the fly, otherwise pnpm compile will output the expected cli.js in the build directory.

dahenson commented 3 days ago

The "Development" section in the README led me to believe that running the following steps would give me what I needed to run xs-dev from the current branch:

git clone https://github.com/HipsterBrown/xs-dev.git
cd xs-dev
pnpm install
pnpm link --global
pnpm link --global xs-dev

However, what you're saying is that testing xs-dev from your development environment requires running pnpm compile every time, or running pnpm xs-dev to try current changes. Could it be worded differently, or is this just common knowledge for JS devs? This tooling is all new to me, so I'm in the dark about pnpm, etc.

HipsterBrown / xs-dev