logseq / logseq/publish-spa

Install for CLI instructions outdated and not working with yarn version 2+, upgrade method unclear with lockfile issues

Open
#23 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
Clojure
Stars
313
Forks
29
PR merge metrics
No merged PRs in 30d

Description

My Initial Install

I tried to upgrade my working initial publish-spa 0.2.0 setup and the former logseq static bild using logseq 0.9.8.

but I got a broken install and never back to work.

I used the instruction at https://github.com/logseq/publish-spa?tab=readme-ov-file#cli currently still published in branch main for Release 0.3.0 , https://github.com/logseq/publish-spa/commit/edf2903ebde1bc1e19f06e5889942d2f49079607

Prerequisite: yarn was upgraded globally to version 3.7 after the initial install for other purposes! ( I am not familiar with fully isolated installs using yarn!), the working install was issued under yarn v1.22.19.

Deleting the publish-spa git checkout and the containing static logseq build and starting from scratch ended up with the same resulting errors below.

I now used again:

  1. delete publish-spa git cloned folder
  2. recreate folder
  3. babashka and clojure installed! (bb -> Babashka v1.3.186 REPL, clj -> Clojure 1.11.1)
  4.  git clone https://github.com/logseq/publish-spa
     cd publish-spa && yarn install
    
  5. output
        ➤ YN0070: Migrating from Yarn 1; automatically enabling the compatibility node-modules linker 👍
        
        ➤ YN0000: ┌ Resolution step
        ➤ YN0000: └ Completed in 4s 382ms
        ➤ YN0000: ┌ Fetch step
        ➤ YN0013: │ wrap-ansi@npm:2.1.0 can't be found in the cache and will be fetched from the remote registry
        ➤ YN0013: │ wrappy@npm:1.0.2 can't be found in the cache and will be fetched from the remote registry
        ➤ YN0013: │ y18n@npm:4.0.3 can't be found in the cache and will be fetched from the remote registry
        ➤ YN0013: │ yargs-parser@npm:11.1.1 can't be found in the cache and will be fetched from the remote registry
        ➤ YN0013: │ yargs@npm:12.0.5 can't be found in the cache and will be fetched from the remote registry
        ➤ YN0000: └ Completed in 3s 366ms
        ➤ YN0000: ┌ Link step
        ➤ YN0000: └ Completed in 0s 227ms
        ➤ YN0000: Done in 7s 984ms
    
  6. command
    yarn global add $PWD
    
    Error:
    Usage Error: The 'yarn global' commands have been removed in 2.x - consider 
    using 'yarn dlx' or a third-party plugin instead
    
    $ yarn run [--inspect] [--inspect-brk] [-T,--top-level] [-B,--binaries-only] [--require 
    #0] <scriptName> ...
    

No idea of the purpose of yarn global add $PWD and how to replace the functionality

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the CLI installation section in the README and reproduce the documented steps using Yarn 2 or later, including yarn install and yarn global add $PWD. Compare the behavior with the reported Yarn 1 workflow and lockfile situation. Done means the instructions explain a supported upgrade or installation method for current Yarn versions.

Written by the indexing model from the issue text.

Assessment

Tech stack
clojure
Domain
cli, documentation, tooling
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.