honkit/honkit

Can't execute `honkit serve` with yarn@2

Open

#131 geöffnet am 28. Sept. 2020

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (3.450 Stars) (259 Forks)user submission
Type: Bughelp wanted

Beschreibung

Summary

When I execute honkit serve with yarn 2.2.2, yarn run honkit serve causes an error.

  • HonKit version: 3.6.6

Step to reproduce

  1. Set Node.js version: v14.12.0.
  2. yarn set version berry.
  3. yarn init.
  4. yarn add --dev honkit
  5. yarn run honkit serve

Expected results

Preview and serve README.md.

Actual results

goh@goh ~/s/honkit_sample> yarn run honkit serve --log debug                                                                                                                                                                          (master)
Live reload server started on port: 35729
Press CTRL+C to quit ...

Starting server ...
debug: readme found at README.md 
warn: no summary file in this book 
debug: cleanup folder "/Users/goh/sandbox/honkit_sample/_book" 
ReferenceError: Failed to load HonKit's plugin module: "livereload" is not found.

cwd: /Users/goh/sandbox/honkit_sample
baseDir: 


    at PluginResolver.resolvePluginPackageName (/Users/goh/sandbox/honkit_sample/.yarn/cache/honkit-npm-3.6.6-ae72a47b44-9d5f6453a5.zip/node_modules/honkit/lib/plugins/PluginResolver.js:72:19)
    at /Users/goh/sandbox/honkit_sample/.yarn/cache/honkit-npm-3.6.6-ae72a47b44-9d5f6453a5.zip/node_modules/honkit/lib/plugins/loadForBook.js:27:34
    at /Users/goh/sandbox/honkit_sample/.yarn/cache/immutable-npm-3.8.2-8bba11f18f-08e65dd057.zip/node_modules/immutable/dist/immutable.js:3016:46
    at List.__iterate (/Users/goh/sandbox/honkit_sample/.yarn/cache/immutable-npm-3.8.2-8bba11f18f-08e65dd057.zip/node_modules/immutable/dist/immutable.js:2206:13)
    at IndexedIterable.mappedSequence.__iterateUncached (/Users/goh/sandbox/honkit_sample/.yarn/cache/immutable-npm-3.8.2-8bba11f18f-08e65dd057.zip/node_modules/immutable/dist/immutable.js:3015:23)
    at seqIterate (/Users/goh/sandbox/honkit_sample/.yarn/cache/immutable-npm-3.8.2-8bba11f18f-08e65dd057.zip/node_modules/immutable/dist/immutable.js:604:16)
    at IndexedIterable.IndexedSeq.__iterate (/Users/goh/sandbox/honkit_sample/.yarn/cache/immutable-npm-3.8.2-8bba11f18f-08e65dd057.zip/node_modules/immutable/dist/immutable.js:320:14)
    at IndexedIterable.toArray (/Users/goh/sandbox/honkit_sample/.yarn/cache/immutable-npm-3.8.2-8bba11f18f-08e65dd057.zip/node_modules/immutable/dist/immutable.js:4258:23)
    at List [as constructor] (/Users/goh/sandbox/honkit_sample/.yarn/cache/immutable-npm-3.8.2-8bba11f18f-08e65dd057.zip/node_modules/immutable/dist/immutable.js:2065:62)
    at reify (/Users/goh/sandbox/honkit_sample/.yarn/cache/immutable-npm-3.8.2-8bba11f18f-08e65dd057.zip/node_modules/immutable/dist/immutable.js:3570:37)

Contributor Guide

Tech Stack
javascriptnodejs
Domain
tooling
Issue Type
bug
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Node.jsYarn Berry (v2+)
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
45
Research-Richtung
The error occurs at PluginResolver.resolvePluginPackageName (honkit/lib/plugins/PluginResolver.js:72). The issue is likely due to Yarn Berry's Plug'n'Play (PnP) system which changes module resolution. Investigate how honkit resolves plugin packages and whether it accounts for PnP. Look at the linked sample repository for reproduction. Consider making PluginResolver work with PnP by using dynamic import or adjusting the require resolution.