plexiform - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0

bin/plexiform.js

 #!/usr/bin/env node
 
 // jshint esversion: 6
-console.log(process.argv);
+
 // ---------------------------------------------------------------------
@@ -20,5 +20,5 @@ // Command line params and defaults
     author: "Raith",
-    version: "1.0.0",
+    version: "1.1.0",
     created: "2017-08-03",
-    updated: "2017-08-24"
+    updated: "2017-08-28"
 };
@@ -42,7 +42,7 @@ // ---------------------------------------------------------------------
 build_name
-This should refer to a file in the ./builds/ directory with extension ".js"
+This should refer to a file with extension ".js"
 It is a node module which exports a single method named "build" with signature (config, utils): void which will perform your build.
 
 config_name
-This should refer to a file in the ./configs/ directory with extension ".json"
+This should refer to a file with extension ".json"
 It will expose a configuration suitable for you build to consume.
@@ -55,3 +55,3 @@
 templates
-These should reside in ./builds/templates/ with extension ".js"
+These should reside in ./templates/ (relative to your build script) with extension ".js"
 These are node modules which export a single method named "template" with signature (context, config, utils): string which will return a templated output.
@@ -149,4 +149,7 @@ These should be consumed as necessary by your build script.
 
-var config = require(`../configs/${configName}.json`);
-var build = require(`../builds/${buildName}.js`).build;
+/* The config, build and templates are all 'require'd, and will be relative to your cwd, so push that onto our module paths list */
+module.paths.push(process.cwd());
+
+var config = require(`${configName}.json`);
+var build = require(`${buildName}.js`).build;
 // add the user config to our base config
@@ -153,0 +156,0 @@ augmentConf(config);

configs/trs.json

@@ -10,2 +10,13 @@ {
     },
+    "data": {
+        "use": "sqlite",
+        "sqlite": {
+            "provider": "Sqlite",
+            "connection": "Filename=./MyDatabase.db"
+        },
+        "sqlserver": {
+            "provider": "SqlServer",
+            "connection": "Server=tcp:raith.database.windows.net,1433;Initial Catalog=TimeTrapData;Persist Security Info=False;User ID=raith;Password=dbsaP4$$;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;"
+        }
+    },
     "entities": [
@@ -39,5 +50,5 @@ {
             "refs": [
-                { "name": "Person", "entity": "Person" },
-                { "name": "Team", "entity": "Team" },
-                { "name": "Role", "entity": "TeamRole" }
+                { "name": "Person", "entity": "Person", "collection": "AsTeamMember" },
+                { "name": "Team", "entity": "Team", "collection": "TeamMembers" },
+                { "name": "Role", "entity": "TeamRole", "collection": "TeamMembers" }
             ]
@@ -66,3 +77,3 @@ },
                 { "name": "description", "type": "string" }
-            ]
+            ] 
         },
@@ -78,3 +89,3 @@ {
             "refs": [
-                { "name": "Group", "entity": "ProjectGroup" }
+                { "name": "Group", "entity": "ProjectGroup", "collection": "Projects" }
             ]
@@ -91,4 +102,4 @@ },
             "refs": [
-                { "name": "Project", "entity": "Project" },
-                { "name": "Team", "entity": "Team" }
+                { "name": "Project", "entity": "Project", "collection": "ProjectTeams" },
+                { "name": "Team", "entity": "Team", "collection": "ProjectTeams" }
             ]
@@ -105,4 +116,4 @@ },
             "refs": [
-                { "name": "Person", "entity": "Person" },
-                { "name": "Project", "entity": "Project" }
+                { "name": "Person", "entity": "Person", "collection": "AsStakeholder" },
+                { "name": "Project", "entity": "Project", "collection": "Stakeholders" }
             ]
@@ -124,5 +135,5 @@ },
             "refs": [
-                { "name": "TeamMember", "entity": "TeamMember" },
-                { "name": "Project", "entity": "Project" },
-                { "name": "Type", "entity": "WorkType" }
+                { "name": "TeamMember", "entity": "TeamMember", "collection": "WorkEntries" },
+                { "name": "Project", "entity": "Project", "collection": "WorkEntries" },
+                { "name": "Type", "entity": "WorkType", "collection": "WorkEntries" }
             ]
@@ -144,4 +155,4 @@ },
             "namespace": 0,
-            "name": "WorkEntryPause",
-            "plural": "WorkEntryPauses",
+            "name": "Pause",
+            "plural": "Pauses",
             "properties": [
@@ -152,4 +163,4 @@ { "name": "startTime", "type": "date" },
             "refs": [
-                { "name": "OriginalEntry", "entity": "WorkEntry" },
-                { "name": "NewEntry", "entity": "WorkEntry" }
+                { "name": "MainWorkEntry", "entity": "WorkEntry", "collection": "MainPauses" },
+                { "name": "ShadowWorkEntry", "entity": "WorkEntry", "collection": "ShadowPauses" }
             ]
@@ -156,0 +167,0 @@ }

package.json

 {
   "name": "plexiform",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A very simple template-driven generator.",
@@ -5,0 +5,0 @@ "main": "bin/plexiform.js",

README.md

 # Plexiform
 
-> **v1.0.0**
+> **v1.1.0**
 
@@ -33,9 +33,12 @@ | In this document |
 
-- Clone the [repo](https://raith-dimensions.visualstudio.com/_git/Plexiform)
+- `npm install -g plexiform`
+- OR clone the [repo](https://raith-dimensions.visualstudio.com/_git/Plexiform)
 - Define a JSON config file to represent whatever it is you are building. No special format required - but your templates will be entirely driven from this.
 - Turn your perfect code files into templates.
-- Write a build script which applies your templates to your config - e.g. iterates over a collection and saves the output.
+- Write a build script which applies your templates to your config - e.g. iterates over config collections and saves the output.
 - Clear any existing output files `clear` (Win), `./clear` (Mac)
-- Execute the build `build _boilerplate` (Win), `./build _boilerplate` (Mac)
+- Execute the build `build builds\_boilerplate configs\_boilerplate` (Win), `./build builds/_boilerplate configs/_boilerplate` (Mac)
+- OR (if npm install -g) `plexiform builds/_boilerplate configs/_boilerplate` (Any)
 
+
 > **See the included boilerplate example to get you started**
@@ -48,3 +51,3 @@
 - Write a tutorial.
-- Visit the [website](http://www.plexiform.co.uk) *(not yet built)* for latest information.
+- Visit the [website](http://www.plexiform.co.uk) *(not yet built)* ~~for latest information.~~
 
@@ -59,1 +62,2 @@ ## Version history
 | 2017-08-28 | v1.0.0 | Raith | Published to npm |
+| 2017-08-28 | v1.1.0 | Raith | Fixed paths so can run as 'plexiform' bin in shell |

New alerts

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Fixed alerts

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

22800

increased by5.55%

Lines of code

446

increased by2.76%

Number of lines in readme file

61

increased by7.02%

No dependency changes