Read source-dirs from elm.json

CHANGELOG.md

@@ -1,15 +1,19 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## 6.0.0
+
+- Change elm-verify-examples.json to contain elm root and not source root. In addition it will respect source-directories defined in elm.json [#109](https://github.com/stoeffel/elm-verify-examples/pull/109)
+
+## 5.3.0
 
 - Do not run tests by default, only generate [#65](https://github.com/stoeffel/elm-verify-examples/issues/65)
 - Add --run-tests (-r) option to run generated tests [#65](https://github.com/stoeffel/elm-verify-examples/issues/65)
 
-
 ## 2.0.0
 
 - We have a changelog now :tada:

Makefile

@@ -1,4 +1,4 @@
-.PHONY: npm-install build test watch release-major release-minor release-patch
+.PHONY: npm-install build test watch release-major release-minor release-patch run-examples verify-own-docs
 
 npm-install:
 	npm install
@@ -11,8 +11,9 @@ verify-own-docs: build
 
 test: verify-own-docs
 	./run-tests.sh
+
 run-examples: build
-	cd example && ../bin/cli.js
+	cd example && ../bin/cli.js --run-tests
 
 watch:
 	watchexec \

Readme.md

@@ -24,7 +24,7 @@ $ touch tests/elm-verify-examples.json
 
 ```json
 {
-  "root": "../src",
+  "elm-root": "..",
   "tests": ["Mock", "Mock.Foo.Bar.Moo", "./README.md"]
 }
 ```

bin/cli-helpers.js

@@ -7,9 +7,26 @@ function loadVerifyExamplesConfig(configPath) {
   */
 
   var verifyExamples = null;
+  var elmJson = null;
 
   try {
     verifyExamples = require(configPath);
+    if (verifyExamples["elm-root"] === undefined) {
+      throw new Error(
+        `elm-verify-examples.json at ${configPath} does not have an elm-root key`
+      );
+    }
+    if (verifyExamples["root"] !== undefined) {
+      throw new Error(
+        `elm-verify-examples.json at ${configPath} has a root key, but it should be elm-root and point to the location of elm.json`
+      );
+    }
+    var elmJsonPath = path.join(
+      path.dirname(configPath),
+      verifyExamples["elm-root"],
+      "elm.json"
+    );
+    elmJson = require(elmJsonPath);
   } catch (e) {
     console.log(`Copying initial elm-verify-examples.json to ${configPath}`);
     fsExtra.copySync(
@@ -23,7 +40,7 @@ function loadVerifyExamplesConfig(configPath) {
     ));
   }
 
-  return resolveTests(configPath, verifyExamples);
+  return resolveTests(configPath, Object.assign({}, verifyExamples, elmJson));
 }
 
 function resolveTests(configPath, config) {

bin/runner.js

@@ -50,9 +50,9 @@ function generate(model, allTestsGenerated) {
         });
       });
     } else {
-      var pathToModule = path.join(
-        model.testsPath,
-        model.root,
+      var pathToModule = findModule(
+        path.join(model.testsPath, model["elm-root"]),
+        model["source-directories"],
         elmModuleToPath(inputName)
       );
 
@@ -154,7 +154,13 @@ function forFiles(model, files) {
     .filter(function (v) {
       return v.endsWith(".elm");
     })
-    .map(elmPathToModule(model.root, model.testsPath));
+    .map(
+      elmPathToModule(
+        model["elm-root"],
+        model["source-directories"],
+        model.testsPath
+      )
+    );
 
   return model;
 }
@@ -215,19 +221,30 @@ function writeFile(testsDocPath) {
   };
 }
 
-function elmPathToModule(root, testsPath) {
+function elmPathToModule(elmRoot, sourceDirs, testsPath) {
   return function (pathName) {
-    var relativePath = path.relative(
-      path.resolve(path.join(testsPath, root)),
-      pathName
-    );
+    var relativePath = findModule(elmRoot, sourceDirs, pathName);
     if (relativePath.startsWith("./")) {
       relativePath = relativePath.substr(2);
     }
     return relativePath.substr(0, relativePath.length - 4).replace(/\//g, ".");
   };
 }
 
+function findModule(elmRoot, sourceDirs, pathName) {
+  for (var i = 0; i < sourceDirs.length; i++) {
+    const dir = sourceDirs[i];
+    const module = path.join(elmRoot, dir, pathName);
+    if (fs.existsSync(module)) {
+      return module;
+    }
+  }
+  console.error(
+    `Could not find module ${pathName} in ${sourceDirs} with root ${elmRoot}`
+  );
+  process.exit(1);
+}
+
 function elmModuleToPath(moduleName) {
   return moduleName.replace(/\./g, "/") + ".elm";
 }

bin/templates/elm-verify-examples.json

@@ -1,4 +1,4 @@
 {
-  "root": "../src",
+  "elm-root": "..",
   "tests": []
 }

example/elm.json

@@ -1,30 +1,28 @@
 {
-    "type": "application",
-    "source-directories": [
-        "src"
-    ],
-    "elm-version": "0.19.0",
-    "dependencies": {
-        "direct": {
-            "elm/browser": "1.0.0",
-            "elm/core": "1.0.0",
-            "elm/html": "1.0.0",
-            "elm/json": "1.0.0",
-            "elm/regex": "1.0.0",
-            "elm-community/list-extra": "8.0.0"
-        },
-        "indirect": {
-            "elm/time": "1.0.0",
-            "elm/url": "1.0.0",
-            "elm/virtual-dom": "1.0.0"
-        }
+  "type": "application",
+  "source-directories": ["src", "src-other/util"],
+  "elm-version": "0.19.0",
+  "dependencies": {
+    "direct": {
+      "elm/browser": "1.0.0",
+      "elm/core": "1.0.0",
+      "elm/html": "1.0.0",
+      "elm/json": "1.0.0",
+      "elm/regex": "1.0.0",
+      "elm-community/list-extra": "8.0.0"
     },
-    "test-dependencies": {
-        "direct": {
-            "elm-explorations/test": "1.0.0"
-        },
-        "indirect": {
-            "elm/random": "1.0.0"
-        }
+    "indirect": {
+      "elm/time": "1.0.0",
+      "elm/url": "1.0.0",
+      "elm/virtual-dom": "1.0.0"
     }
+  },
+  "test-dependencies": {
+    "direct": {
+      "elm-explorations/test": "1.0.0"
+    },
+    "indirect": {
+      "elm/random": "1.0.0"
+    }
+  }
 }

example/src-other/util/Other.elm

@@ -0,0 +1,13 @@
+module Other exposing (other)
+
+{-| -}
+
+
+{-| Stuff
+
+    other 4 --> 4
+
+-}
+other : Int -> Int
+other x =
+    x + 1

example/tests/elm-verify-examples.json

@@ -1,26 +1,23 @@
 {
-  "root": "../src",
+  "elm-root": "..",
   "tests": [
     "Mock",
     "Mock.Foo.Bar.Moo",
     "Robustness",
     "Failing",
     "Todo",
     "FalseTodo",
-    "README.md"
+    "README.md",
+    "Other"
   ],
   "ignoreWarnings": {
     "Mock.Foo.Bar.Moo": [
       {
         "name": "dontCare",
-        "ignore": [
-          "NoExampleForExposedDefinition"
-        ]
+        "ignore": ["NoExampleForExposedDefinition"]
       },
       {
-        "ignore": [
-          "ExposingDotDot"
-        ]
+        "ignore": ["ExposingDotDot"]
       }
     ]
   }

run-tests.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 PASSED_COUNT=34
-FAILED_COUNT=2
+FAILED_COUNT=3
 TODO_COUNT=1
 
 pushd example

tests/elm-verify-examples.json

@@ -1,6 +1,4 @@
 {
-  "root": "../src",
-  "tests": [
-    "String.Util"
-  ]
+  "elm-root": "..",
+  "tests": ["String.Util"]
 }