schickling/chromeless

Windows Build Compatibility

Open

#70 opened on Jul 28, 2017

View on GitHub
 (5 comments) (0 reactions) (0 assignees)TypeScript (13,240 stars) (606 forks)batch import
APIProxyhelp wanted

Description

I found a couple issues while trying to build this on Windows.

  1. For "npm run build" --> "rm -rf dist; tsc -d"

    • "rm -rf dist;" doesn't make sense on windows since the rm command doesn't exist. The command to remove a directory in windows is "rmdir"
    • I'm open to suggestions on how to solve this one, my only thought is to have 2 different build scripts (one for windows and one for mac/linux)

  2. https://github.com/graphcool/chromeless/blob/master/src/chrome/local-runtime.ts#L204-L205

    • This line sets the tmp directory as "/tmp". On windows this refers to "C:/tmp". I think we should change this line to refer to just "tmp/" so that it refers to a tmp folder inside the current directory.
    • Also, fs.writeFileSync() assumes the tmp folder exists, I think we need code in here to check for the folder and add the folder if it doesn't exist.

Once we have solid solutions to these 2 things, I can implement a PR.

Contributor guide

Tech stack
typescriptnodejs
Domain
build system
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Node.js basicsnpm scriptsWindows environment
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Review the issue comments for any suggested solutions or additional context. The main changes involve modifying the build script in package.json to use a cross platform tool like rimraf instead of 'rm rf dist', and updating the tmp directory path in src/chrome/local runtime.ts from '/tmp' to use os.tmpdir() or a relative path. Additionally, ensure the tmp directory exists before writing using fs.existsSync() or mkdirSync. Test the changes on a Windows machine to confirm compatibility.