Pijul source control integration extension for Visual Studio Code

#13 Documentation tweaks

Opened by jamesvasile on February 9, 2024
jamesvasile on February 9, 2024

First, thanks for working on this. It looks promising!

Second, I followed the nicely detailed steps in the README and hit some snags that suggest some possible README improvements.

  1. The instructions assume some familiarity with node and npm that is perhaps not necessary to build. We might rectify this by including steps to install yarn and package dependencies. This would allow some people who aren’t familiar with npm to build.

  2. On my Debian box, I get an error that was avoided by running with a version of the command recommended on windows: NODE_OPTIONS=--openssl-legacy-provider vsce package. This at least got me a running VSIX extension, though I haven’t looked into any actual functionality yet.

The error is below, and maybe the docs should be adjusted to tell non-Windows users to try that command?

$ vsce package
 INFO  Detected presence of yarn.lock. Using 'yarn' instead of 'npm' (to override this pass '--no-yarn' on the command line).
Executing prepublish script 'yarn run vscode:prepublish'...
yarn run v1.22.21
warning ../../../package.json: No license field
$ yarn run package
warning ../../../package.json: No license field
$ webpack --mode production --devtool hidden-source-map --config ./build/node-extension.webpack.config.js
/home/james/src/3p/pijul-vscode/node_modules/loader-runner/lib/LoaderRunner.js:146
		if(isError) throw e;
		           ^

Error: error:0308010C:digital envelope routines::unsupported
    at new Hash (node:internal/crypto/hash:69:19)
    at Object.createHash (node:crypto:133:10)
    at BulkUpdateDecorator.hashFactory (/home/james/src/3p/pijul-vscode/node_modules/webpack/lib/util/createHash.js:138:18)
    at BulkUpdateDecorator.update (/home/james/src/3p/pijul-vscode/node_modules/webpack/lib/util/createHash.js:44:50)
    at SourceMapSource.updateHash (/home/james/src/3p/pijul-vscode/node_modules/webpack-sources/lib/SourceMapSource.js:233:8)
    at NormalModule._initBuildHash (/home/james/src/3p/pijul-vscode/node_modules/webpack/lib/NormalModule.js:737:17)
    at handleParseResult (/home/james/src/3p/pijul-vscode/node_modules/webpack/lib/NormalModule.js:801:10)
    at /home/james/src/3p/pijul-vscode/node_modules/webpack/lib/NormalModule.js:854:4
    at processResult (/home/james/src/3p/pijul-vscode/node_modules/webpack/lib/NormalModule.js:625:11)
    at /home/james/src/3p/pijul-vscode/node_modules/webpack/lib/NormalModule.js:676:5 {
  opensslErrorStack: [ 'error:03000086:digital envelope routines::initialization error' ],
  library: 'digital envelope routines',
  reason: 'unsupported',
  code: 'ERR_OSSL_EVP_UNSUPPORTED'
}

Node.js v18.19.0
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
 ERROR  yarn failed with exit code 1