Split core functionality from CLI #14

kachkaev · 2018-04-28T11:26:33Z

👋

I recently needed to use run-elm via require() rather than by spawning a sub-process and came up with a refactoring that involved splitting core functionality from CLI. At the moment this change is included into a fork called @kachkaev/run-elm, but I hope to deprecate that package once we update run-elm.

One thing that bugs me is that I'm using `compileSync` instead of `compile` (they both replace `compileToString` and save one cycle of file write/read). The reason is in https://github.com/rtfeldman/node-elm-compiler/issues/68 (async version calls `process.exit()` on error, so it can't be used when we `require('run-elm')`).

WDYT @jfairbank? ~~~I'm happy to rebase and refactor after merging #13 and getting your general approval.~~~

jfairbank · 2018-05-08T12:34:21Z

This seems like a good change to make. I'll wait for you to rebase before I review. Thanks!

…te both via Node API and CLI

kachkaev · 2018-05-08T13:25:58Z

Despite that all tests pass, I'm still not sure this PR is worth merging as is. The issue that I see is that we're calling node-elm-compiler synchronously, because otherwise we'll get early exit due to rtfeldman/node-elm-compiler#68. Therefore, the main Node.js thread will get blocked and performance will suffer (this only applies when Node API is used). There is no regression in CLI use, just a non-optimality in the new execution mode.

What are your thoughts on this @jfairbank? How is the PR in general?

kachkaev · 2018-05-14T20:42:07Z

I also noticed today that Elm's Debug.log is being incorrectly reported in the API mode. Will add a fix to this soon, please don't merge.

…nyway

kachkaev · 2018-05-15T17:05:59Z

I also managed to fix a few things so that they work on Windows:
https://ci.appveyor.com/project/kachkaev/run-elm/build/27

Things to note:

stderr / stdout never contain \r (even when it's Windows) to make sure there are no unwanted parsing issues in the downstream projects. If someone asks for a nice-looking output for cmd, we can look into adding a CLI option for that.
I had to rename Aux.elm into Helper.elm in one of the tests, because you can't use AUX for file names on Windows 😱 This was giving a pretty strange exception.

@jfairbank feel free to integrate AppVeyor to the repo just as I did in my fork.

One last thing I'd like to look into is to make a call to elm compiler async despite rtfeldman/node-elm-compiler#68.

kachkaev · 2018-05-15T17:07:05Z

package.json

  },
  "scripts": {
-    "test:clean": "cd test/integration && git clean -d -f -X",
+    "clean:test": "git clean -d -f -X test/integration",


&& are not allowed in npm scripts on Windows; also renamed test:clean into clean:test for a better clarity

kachkaev · 2018-05-15T17:07:33Z

package.json

    "lint": "eslint src test --ignore-pattern elm-stuff",
+    "prebuild": "rimraf lib",
+    "build": "babel src --out-dir lib",
+    "postbuild": "cpx \"src/*.elm.template\" lib",


&& are not allowed in npm scripts on Windows, so I had to split command into three

kachkaev · 2018-05-15T17:09:36Z

src/index.js

@@ -70,10 +37,10 @@ import sh from 'shelljs';

    // ensure --output-name is specified adequately
    if (!outputName.match(/^[a-z_]\w*$/)) {
-      throw new Error(`Provided --output-name \`${outputName}\` is not a valid constant or function name in elm.`);
+      throw new Error(`Provided output name \`${outputName}\` is not a valid constant or function name in elm.`);


not using --output-name to avoid confusion in non-CLI usage. Same applies to other args

kachkaev · 2018-05-15T17:10:23Z

src/index.js

+    await Promise.all([
+      close(elmCompileStdoutFd).catch(() => {}),
+      close(elmCompileStderrFd).catch(() => {}),
+    ]);


Had to do this to support Windows, otherwise the files were left unclosed and could not be deleted

Fixes #68

kachkaev · 2018-05-15T19:37:55Z

The PR should be ready for your review @jfairbank 🎉 Calls to elm-compile are async now and both Travis and AppVeyor#28 (Windows) pass!

kachkaev · 2018-05-21T14:15:58Z

ping @jfairbank 🏓 🙂

jfairbank · 2018-05-23T14:19:22Z

Hey, @kachkaev. I've been at a conference this week and am traveling the rest of the week, so I won't be able to check this PR more thoroughly until next week. Sorry for the delay, but I didn't want to keep you in the dark at least.

kachkaev · 2018-06-07T20:17:39Z

@jfairbank when about could you have a look at this? No rush, just curious.

jfairbank · 2018-06-08T00:44:46Z

Sorry again; I've just been super busy with other priorities. I finally looked this over, and it seems reasonable. I'll get a release out later tonight. Thanks!

jfairbank · 2018-06-08T02:05:37Z

v2.3.0 is now out!

kachkaev mentioned this pull request May 8, 2018

Add full stops to some error messages for consistency #15

Merged

kachkaev force-pushed the split-cli-from-index branch from 3414b82 to deeb2c4 Compare May 8, 2018 13:07

Make it possible to use run-elm as a function using import/require

d7ff3b5

kachkaev force-pushed the split-cli-from-index branch from deeb2c4 to d7ff3b5 Compare May 8, 2018 13:08

kachkaev added 2 commits May 8, 2018 14:16

Generalise option names in error messages so that they look appropria…

7683817

…te both via Node API and CLI

Update CHANGELOG

2f5f06d

kachkaev changed the title ~~[WIP] Split core functionality from CLI~~ Split core functionality from CLI May 8, 2018

Slightly enhance README and CHANGELOG

7a8879c

kachkaev force-pushed the split-cli-from-index branch from 1f67b47 to 7a8879c Compare May 8, 2018 13:34

kachkaev added 2 commits May 14, 2018 01:31

Close io files before deleting to avoid permission problems on Windows

baca1f8

Fix fs-extra warning

8ba510e

kachkaev added 6 commits May 15, 2018 11:31

Add failing tests for Debug.log

fe8be8b

Fix collecting of Debug.log

1658304

Add tests' stderr and stdout to .gitignore

251949f

Do not use beforeAll() in tests as it does not block test execution a…

a92572b

…nyway

Use execa instead of child-process-promise as it has better os support

a0c7ce8

Support Windows and add appveyor.yml

4328e0b

kachkaev commented May 15, 2018

View reviewed changes

kachkaev referenced this pull request in rtfeldman/node-elm-compiler May 15, 2018

Throw instead of warning.

fbb37d4

Fixes #68

Use async version of compile() with a workaround

565c766

jfairbank merged commit 8fa0acc into jfairbank:master Jun 8, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Split core functionality from CLI #14

Split core functionality from CLI #14

kachkaev commented Apr 28, 2018 •

edited

Loading

jfairbank commented May 8, 2018

kachkaev commented May 8, 2018 •

edited

Loading

kachkaev commented May 14, 2018

kachkaev commented May 15, 2018 •

edited

Loading

kachkaev May 15, 2018 •

edited

Loading

kachkaev May 15, 2018

kachkaev May 15, 2018 •

edited

Loading

kachkaev May 15, 2018

kachkaev commented May 15, 2018 •

edited

Loading

kachkaev commented May 21, 2018 •

edited

Loading

jfairbank commented May 23, 2018

kachkaev commented Jun 7, 2018

jfairbank commented Jun 8, 2018

jfairbank commented Jun 8, 2018

Split core functionality from CLI #14

Split core functionality from CLI #14

Conversation

kachkaev commented Apr 28, 2018 • edited Loading

jfairbank commented May 8, 2018

kachkaev commented May 8, 2018 • edited Loading

kachkaev commented May 14, 2018

kachkaev commented May 15, 2018 • edited Loading

kachkaev May 15, 2018 • edited Loading

Choose a reason for hiding this comment

kachkaev May 15, 2018

Choose a reason for hiding this comment

kachkaev May 15, 2018 • edited Loading

Choose a reason for hiding this comment

kachkaev May 15, 2018

Choose a reason for hiding this comment

kachkaev commented May 15, 2018 • edited Loading

kachkaev commented May 21, 2018 • edited Loading

jfairbank commented May 23, 2018

kachkaev commented Jun 7, 2018

jfairbank commented Jun 8, 2018

jfairbank commented Jun 8, 2018

kachkaev commented Apr 28, 2018 •

edited

Loading

kachkaev commented May 8, 2018 •

edited

Loading

kachkaev commented May 15, 2018 •

edited

Loading

kachkaev May 15, 2018 •

edited

Loading

kachkaev May 15, 2018 •

edited

Loading

kachkaev commented May 15, 2018 •

edited

Loading

kachkaev commented May 21, 2018 •

edited

Loading