Windows compatibility

[bholloway]

Finalise

• windows compatibility: project does not install #1262 "windows compatibility: project does not install"
• windows compatible npm scripts #1263 "windows compatible npm scripts"

Updates have been merged to preconstruct per PR #77. This PR makes the same changes here.

Root cause

• Forward slashes needed to be escaped.
• The endent package doesn't support escape sequences. It isn't used in preconstruct.

Tested myself on MacOs and by @MadeByMike on windows 10.

[changeset-bot]

🦋 Changeset is good to go

Latest commit: a1cd2ca

We got this.

Not sure what this means? Click here to learn what changesets are.

[bholloway]

@MadeByMike you might want to recheck this on Windows at some point (after merge). Now that everything is finalised.

[1337cookie]

Related?

C:\Users\user\Documents\web\keystone-5>bolt
⚡️   bolt v0.23.6 (node v10.16.1)
�   [1/4] Validating project...
�   [2/4] Installing project dependencies...
$ C:\Users\user\AppData\Local\Yarn\Data\global\node_modules\bolt\node_modules\.bin\yarn config get user-agent yarn/1.17.3 npm/? node/v10.16.1 win32 x64
yarn install v1.17.3
[1/4] Resolving packages...
[2/4] Fetching packages...
info [email protected]: The platform "win32" is incompatible with this module.
info "[email protected]" is an optional dependency and failed compatibility check. Excluding it from installation.
info [email protected]: The platform "win32" is incompatible with this module.
info "[email protected]" is an optional dependency and failed compatibility check. Excluding it from installation.
[3/4] Linking dependencies...
warning "apollo-server-express > apollo-server-core > [email protected]" has incorrect peer dependency "[email protected] - 14.1.x".
warning "graphql-playground-react > [email protected]" has incorrect peer dependency "react@>=15.5 <16".
warning "graphql-playground-react > [email protected]" has incorrect peer dependency "react-dom@>=15.5 <16".
[4/4] Building fresh packages...
$ yarn build:build-field-types && preconstruct dev && node ./packages/build-field-types/bin.js dev  && yarn run --silent contributing-guide
yarn run v1.17.3
$ rimraf packages/build-field-types/lib && babel packages/build-field-types/src --out-dir packages/build-field-types/dist --ignore '**/__tests__/**/*','**/__mocks__/**/*'
Successfully compiled 42 files with Babel.
Done in 4.41s.
� info project is valid!
� error { [Error: EPERM: operation not permitted, symlink 'C:\Users\user\Documents\web\keystone-5\packages\arch\packages\alert\src\index.js' -> 'C:\Users\user\Documents\web\keystone-5\packages\arch\packages\alert\dist\alert.cjs.js.flow']
� error   errno: -4048,
� error   code: 'EPERM',
� error   syscall: 'symlink',
� error   path:
� error    'C:\\Users\\user\\Documents\\web\\keystone-5\\packages\\arch\\packages\\alert\\src\\index.js',
� error   dest:
� error    'C:\\Users\\user\\Documents\\web\\keystone-5\\packages\\arch\\packages\\alert\\dist\\alert.cjs.js.flow' }
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.
error Error: spawn C:/Users/user/AppData/Local/Yarn/Data/global/node_modules/bolt/node_modules/.bin/yarn ENOENT
error     at notFoundError (C:/Users/user/AppData/Local/Yarn/Data/global/node_modules/cross-spawn/lib/enoent.js:11:11)
error     at verifyENOENT (C:/Users/user/AppData/Local/Yarn/Data/global/node_modules/cross-spawn/lib/enoent.js:46:16)
error     at ChildProcess.cp.emit (C:/Users/user/AppData/Local/Yarn/Data/global/node_modules/cross-spawn/lib/enoent.js:33:19)

[bholloway]

In testing we saw that admin was required to get the symlink to work.

Definitely you should not be running as admin.

I believe there’s a setting somewhere such that the symlink doesn’t need admin privileges. I don’t have a link right now but try searching for this problem as it isn’t limited to keystone AFAIK.

[bholloway]

I vote to close #1262 and open a new issue for the symlink problem @1337cookie and I saw.

[jesstelford]

Yep, good idea ☝️